Cycles: relicense GNU GPL source code to Apache version 2.0.
[blender.git] / intern / cycles / kernel / osl / osl_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 __OSL_SHADER_H__
18 #define __OSL_SHADER_H__
19
20 #ifdef WITH_OSL
21
22 /* OSL Shader Engine
23  *
24  * Holds all variables to execute and use OSL shaders from the kernel. These
25  * are initialized externally by OSLShaderManager before rendering starts.
26  *
27  * Before/after a thread starts rendering, thread_init/thread_free must be
28  * called, which will store any per thread OSL state in thread local storage.
29  * This means no thread state must be passed along in the kernel itself.
30  */
31
32 #include "kernel_types.h"
33
34 CCL_NAMESPACE_BEGIN
35
36 class Scene;
37
38 struct ShaderClosure;
39 struct ShaderData;
40 struct differential3;
41 struct KernelGlobals;
42
43 struct OSLGlobals;
44 struct OSLShadingSystem;
45
46 class OSLShader {
47 public:
48         /* init */
49         static void register_closures(OSLShadingSystem *ss);
50
51         /* per thread data */
52         static void thread_init(KernelGlobals *kg, KernelGlobals *kernel_globals, OSLGlobals *osl_globals);
53         static void thread_free(KernelGlobals *kg);
54
55         /* eval */
56         static void eval_surface(KernelGlobals *kg, ShaderData *sd, float randb, int path_flag, ShaderContext ctx);
57         static float3 eval_background(KernelGlobals *kg, ShaderData *sd, int path_flag, ShaderContext ctx);
58         static void eval_volume(KernelGlobals *kg, ShaderData *sd, float randb, int path_flag, ShaderContext ctx);
59         static void eval_displacement(KernelGlobals *kg, ShaderData *sd, ShaderContext ctx);
60
61         /* sample & eval */
62         static int bsdf_sample(const ShaderData *sd, const ShaderClosure *sc,
63                                float randu, float randv,
64                                float3& eval, float3& omega_in, differential3& domega_in, float& pdf);
65         static float3 bsdf_eval(const ShaderData *sd, const ShaderClosure *sc,
66                                 const float3& omega_in, float& pdf);
67         static void bsdf_blur(ShaderClosure *sc, float roughness);
68
69         static float3 emissive_eval(const ShaderData *sd, const ShaderClosure *sc);
70
71         static float3 volume_eval_phase(const ShaderClosure *sc,
72                                         const float3 omega_in, const float3 omega_out);
73
74         /* attributes */
75         static int find_attribute(KernelGlobals *kg, const ShaderData *sd, uint id, AttributeElement *elem);
76 };
77
78 CCL_NAMESPACE_END
79
80 #endif
81
82 #endif /* __OSL_SHADER_H__ */
83