1 
2 //
3 // This source file is part of appleseed.
4 // Visit https://appleseedhq.net/ for additional information and resources.
5 //
6 // This software is released under the MIT license.
7 //
8 // Copyright (c) 2016-2018 Francois Beaune, The appleseedhq Organization
9 //
10 // Permission is hereby granted, free of charge, to any person obtaining a copy
11 // of this software and associated documentation files (the "Software"), to deal
12 // in the Software without restriction, including without limitation the rights
13 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 // copies of the Software, and to permit persons to whom the Software is
15 // furnished to do so, subject to the following conditions:
16 //
17 // The above copyright notice and this permission notice shall be included in
18 // all copies or substantial portions of the Software.
19 //
20 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
26 // THE SOFTWARE.
27 //
28 
29 #pragma once
30 
31 // appleseed.renderer headers.
32 #include "renderer/modeling/environmentshader/ienvironmentshaderfactory.h"
33 
34 // appleseed.foundation headers.
35 #include "foundation/utility/autoreleaseptr.h"
36 
37 // appleseed.main headers.
38 #include "main/dllsymbol.h"
39 
40 // Forward declarations.
41 namespace foundation    { class Dictionary; }
42 namespace foundation    { class DictionaryArray; }
43 namespace renderer      { class EnvironmentShader; }
44 namespace renderer      { class ParamArray; }
45 
46 namespace renderer
47 {
48 
49 //
50 // Factory for an environment shader that simply paints background pixels.
51 //
52 
53 class APPLESEED_DLLSYMBOL BackgroundEnvironmentShaderFactory
54   : public IEnvironmentShaderFactory
55 {
56   public:
57     // Delete this instance.
58     void release() override;
59 
60     // Return a string identifying this environment shader model.
61     const char* get_model() const override;
62 
63     // Return metadata for this environment shader model.
64     foundation::Dictionary get_model_metadata() const override;
65 
66     // Return metadata for the inputs of this environment shader model.
67     foundation::DictionaryArray get_input_metadata() const override;
68 
69     // Create a new environment shader instance.
70     foundation::auto_release_ptr<EnvironmentShader> create(
71         const char*         name,
72         const ParamArray&   params) const override;
73 };
74 
75 }   // namespace renderer
76