Cycles microdisplacement: Move displacement options from mesh to material settings
[blender.git] / intern / cycles / render / shader.h
1 /*
2  * Copyright 2011-2013 Blender Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 #ifndef __SHADER_H__
18 #define __SHADER_H__
19
20 #ifdef WITH_OSL
21 /* So no context pollution happens from indirectly included windows.h */
22 #  include "util_windows.h"
23 #  include <OSL/oslexec.h>
24 #endif
25
26 #include "attribute.h"
27 #include "kernel_types.h"
28
29 #include "node.h"
30
31 #include "util_map.h"
32 #include "util_param.h"
33 #include "util_string.h"
34 #include "util_thread.h"
35 #include "util_types.h"
36
37 CCL_NAMESPACE_BEGIN
38
39 class Device;
40 class DeviceScene;
41 class DeviceRequestedFeatures;
42 class Mesh;
43 class Progress;
44 class Scene;
45 class ShaderGraph;
46 struct float3;
47
48 enum ShadingSystem {
49         SHADINGSYSTEM_OSL,
50         SHADINGSYSTEM_SVM
51 };
52
53 /* Keep those in sync with the python-defined enum. */
54 enum VolumeSampling {
55         VOLUME_SAMPLING_DISTANCE = 0,
56         VOLUME_SAMPLING_EQUIANGULAR = 1,
57         VOLUME_SAMPLING_MULTIPLE_IMPORTANCE = 2,
58
59         VOLUME_NUM_SAMPLING,
60 };
61
62 enum VolumeInterpolation {
63         VOLUME_INTERPOLATION_LINEAR = 0,
64         VOLUME_INTERPOLATION_CUBIC = 1,
65
66         VOLUME_NUM_INTERPOLATION,
67 };
68
69 enum DisplacementMethod {
70         DISPLACE_BUMP = 0,
71         DISPLACE_TRUE = 1,
72         DISPLACE_BOTH = 2,
73
74         DISPLACE_NUM_METHODS,
75 };
76
77 /* Shader describing the appearance of a Mesh, Light or Background.
78  *
79  * While there is only a single shader graph, it has three outputs: surface,
80  * volume and displacement, that the shader manager will compile and execute
81  * separately. */
82
83 class Shader : public Node {
84 public:
85         NODE_DECLARE;
86
87         int pass_id;
88
89         /* shader graph */
90         ShaderGraph *graph;
91
92         /* shader graph with auto bump mapping included, we compile two shaders,
93          * with and without bump,  because the displacement method is a mesh
94          * level setting, so we need to handle both */
95         ShaderGraph *graph_bump;
96
97         /* sampling */
98         bool use_mis;
99         bool use_transparent_shadow;
100         bool heterogeneous_volume;
101         VolumeSampling volume_sampling_method;
102         int volume_interpolation_method;
103
104         /* synchronization */
105         bool need_update;
106         bool need_update_attributes;
107
108         /* information about shader after compiling */
109         bool has_surface;
110         bool has_surface_emission;
111         bool has_surface_transparent;
112         bool has_volume;
113         bool has_displacement;
114         bool has_surface_bssrdf;
115         bool has_bssrdf_bump;
116         bool has_surface_spatial_varying;
117         bool has_volume_spatial_varying;
118         bool has_object_dependency;
119         bool has_integrator_dependency;
120
121         /* displacement */
122         DisplacementMethod displacement_method;
123
124         /* requested mesh attributes */
125         AttributeRequestSet attributes;
126
127         /* determined before compiling */
128         uint id;
129         bool used;
130
131 #ifdef WITH_OSL
132         /* osl shading state references */
133         OSL::ShaderGroupRef osl_surface_ref;
134         OSL::ShaderGroupRef osl_surface_bump_ref;
135         OSL::ShaderGroupRef osl_volume_ref;
136         OSL::ShaderGroupRef osl_displacement_ref;
137 #endif
138
139         Shader();
140         ~Shader();
141
142         void set_graph(ShaderGraph *graph);
143         void tag_update(Scene *scene);
144         void tag_used(Scene *scene);
145 };
146
147 /* Shader Manager virtual base class
148  * 
149  * From this the SVM and OSL shader managers are derived, that do the actual
150  * shader compiling and device updating. */
151
152 class ShaderManager {
153 public:
154         bool need_update;
155
156         static ShaderManager *create(Scene *scene, int shadingsystem);
157         virtual ~ShaderManager();
158
159         virtual void reset(Scene *scene) = 0;
160
161         virtual bool use_osl() { return false; }
162
163         /* device update */
164         virtual void device_update(Device *device, DeviceScene *dscene, Scene *scene, Progress& progress) = 0;
165         virtual void device_free(Device *device, DeviceScene *dscene, Scene *scene) = 0;
166
167         void device_update_shaders_used(Scene *scene);
168         void device_update_common(Device *device, DeviceScene *dscene, Scene *scene, Progress& progress);
169         void device_free_common(Device *device, DeviceScene *dscene, Scene *scene);
170
171         /* get globally unique id for a type of attribute */
172         uint get_attribute_id(ustring name);
173         uint get_attribute_id(AttributeStandard std);
174
175         /* get shader id for mesh faces */
176         int get_shader_id(Shader *shader, Mesh *mesh = NULL, bool smooth = false);
177
178         /* add default shaders to scene, to use as default for things that don't
179          * have any shader assigned explicitly */
180         static void add_default(Scene *scene);
181
182         /* Selective nodes compilation. */
183         void get_requested_features(Scene *scene,
184                                     DeviceRequestedFeatures *requested_features);
185
186         static void free_memory();
187
188 protected:
189         ShaderManager();
190
191         typedef unordered_map<ustring, uint, ustringHash> AttributeIDMap;
192         AttributeIDMap unique_attribute_id;
193
194         thread_mutex lookup_table_mutex;
195         static vector<float> beckmann_table;
196
197         size_t beckmann_table_offset;
198
199         void get_requested_graph_features(ShaderGraph *graph,
200                                           DeviceRequestedFeatures *requested_features);
201 };
202
203 CCL_NAMESPACE_END
204
205 #endif /* __SHADER_H__ */
206