Creating a BGE staging branch.
[blender.git] / intern / cycles / kernel / osl / osl_shader.h
1 /*
2  * Copyright 2011, Blender Foundation.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  */
18
19 #ifndef __OSL_SHADER_H__
20 #define __OSL_SHADER_H__
21
22 #ifdef WITH_OSL
23
24 /* OSL Shader Engine
25  *
26  * Holds all variables to execute and use OSL shaders from the kernel. These
27  * are initialized externally by OSLShaderManager before rendering starts.
28  *
29  * Before/after a thread starts rendering, thread_init/thread_free must be
30  * called, which will store any per thread OSL state in thread local storage.
31  * This means no thread state must be passed along in the kernel itself.
32  */
33
34 #include "kernel_types.h"
35
36 CCL_NAMESPACE_BEGIN
37
38 class Scene;
39
40 struct ShaderClosure;
41 struct ShaderData;
42 struct differential3;
43 struct KernelGlobals;
44
45 struct OSLGlobals;
46 struct OSLShadingSystem;
47
48 class OSLShader {
49 public:
50         /* init */
51         static void register_closures(OSLShadingSystem *ss);
52
53         /* per thread data */
54         static void thread_init(KernelGlobals *kg, KernelGlobals *kernel_globals, OSLGlobals *osl_globals);
55         static void thread_free(KernelGlobals *kg);
56
57         /* eval */
58         static void eval_surface(KernelGlobals *kg, ShaderData *sd, float randb, int path_flag, ShaderContext ctx);
59         static float3 eval_background(KernelGlobals *kg, ShaderData *sd, int path_flag, ShaderContext ctx);
60         static void eval_volume(KernelGlobals *kg, ShaderData *sd, float randb, int path_flag, ShaderContext ctx);
61         static void eval_displacement(KernelGlobals *kg, ShaderData *sd, ShaderContext ctx);
62
63         /* sample & eval */
64         static int bsdf_sample(const ShaderData *sd, const ShaderClosure *sc,
65                                float randu, float randv,
66                                float3& eval, float3& omega_in, differential3& domega_in, float& pdf);
67         static float3 bsdf_eval(const ShaderData *sd, const ShaderClosure *sc,
68                                 const float3& omega_in, float& pdf);
69         static void bsdf_blur(ShaderClosure *sc, float roughness);
70
71         static float3 emissive_eval(const ShaderData *sd, const ShaderClosure *sc);
72
73         static float3 volume_eval_phase(const ShaderClosure *sc,
74                                         const float3 omega_in, const float3 omega_out);
75
76         /* attributes */
77         static int find_attribute(KernelGlobals *kg, const ShaderData *sd, uint id, AttributeElement *elem);
78 };
79
80 CCL_NAMESPACE_END
81
82 #endif
83
84 #endif /* __OSL_SHADER_H__ */
85