License conversion from Flora to Apache 2.0
[platform/core/uifw/dali-core.git] / dali / internal / render / shaders / program.h
1 #ifndef __DALI_INTERNAL_PROGRAM_H__
2 #define __DALI_INTERNAL_PROGRAM_H__
3
4 /*
5  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  *
19  */
20
21 // EXTERNAL INCLUDES
22 #include <string>
23
24 // INTERNAL INCLUDES
25 #include <dali/public-api/common/vector-wrapper.h>
26 #include <dali/public-api/common/set-wrapper.h>
27 #include <dali/public-api/object/ref-object.h>
28 #include <dali/internal/render/gl-resources/context.h>
29 #include <dali/integration-api/resource-cache.h>
30
31 namespace Dali
32 {
33
34 class Matrix;
35
36 namespace Integration
37 {
38 class GlAbstraction;
39 class ShaderData;
40 }
41
42 namespace Internal
43 {
44
45 class Context;
46
47 /*
48  * A program contains a vertex & fragment shader.
49  *
50  * A program will contain vertex attributes and uniform variables
51  * E.g. inside the code for our text fragment shaders we have the line:
52  * \code
53  * uniform lowp vec4  uColor
54  * \endcode
55  *
56  * This describes a variable used to color text as it is drawn.
57  *
58  * uColor is set to the value specified by Actor::SetColor and is
59  * animatable through the property Actor::COLOR
60  */
61 class Program
62 {
63 public:
64
65   /**
66    * Size of the uniform cache per program
67    * GLES specification states that minimum uniform count for fragment shader
68    * is 16 and for vertex shader 128. We're caching the 16 common ones for now
69    */
70   static const int MAX_UNIFORM_CACHE_SIZE = 16;
71
72   /**
73    * Constant for uniform / attribute not found
74    */
75   static const int NOT_FOUND = -1;
76
77   /**
78    * Vertex attributes
79    */
80   enum AttribType
81   {
82     ATTRIB_UNKNOWN = -1,
83     ATTRIB_POSITION,
84     ATTRIB_NORMAL,
85     ATTRIB_TEXCOORD,
86     ATTRIB_COLOR,
87     ATTRIB_BONE_WEIGHTS,
88     ATTRIB_BONE_INDICES,
89     ATTRIB_TYPE_LAST
90   };
91
92   /**
93    * Common shader uniform names
94    */
95   enum UniformType
96   {
97     UNIFORM_NOT_QUERIED = -2,
98     UNIFORM_UNKNOWN = -1,
99     UNIFORM_MVP_MATRIX,
100     UNIFORM_MODELVIEW_MATRIX,
101     UNIFORM_PROJECTION_MATRIX,
102     UNIFORM_MODEL_MATRIX,
103     UNIFORM_VIEW_MATRIX,
104     UNIFORM_NORMAL_MATRIX,
105     UNIFORM_COLOR,
106     UNIFORM_CUSTOM_TEXTURE_COORDS,
107     UNIFORM_SAMPLER,
108     UNIFORM_SAMPLER_RECT,
109     UNIFORM_EFFECT_SAMPLER,
110     UNIFORM_EFFECT_SAMPLER_RECT,
111     UNIFORM_TIME_DELTA,
112     UNIFORM_SAMPLER_OPACITY,
113     UNIFORM_SAMPLER_NORMAL_MAP,
114
115     UNIFORM_TEXT_COLOR,
116     UNIFORM_SMOOTHING,
117     UNIFORM_OUTLINE,
118     UNIFORM_OUTLINE_COLOR,
119     UNIFORM_GLOW,
120     UNIFORM_GLOW_COLOR,
121     UNIFORM_SHADOW,
122     UNIFORM_SHADOW_COLOR,
123     UNIFORM_SHADOW_SMOOTHING,
124     UNIFORM_GRADIENT_COLOR,
125     UNIFORM_GRADIENT_LINE,
126     UNIFORM_INVERSE_TEXT_SIZE,
127
128     UNIFORM_TYPE_LAST
129   };
130
131   /**
132    * Creates a new program, or returns a copy of an existing program in the program cache
133    * maintained by Context
134    * @param [in] resourceId ResourceManager resourceId for the shader source and binary.
135    *                        Used as a lookup key in the program cache
136    * @param[in] shaderData  A pointer to a data structure containing the program source
137    *                        and optionally precompiled binary. If the binary is empty the program bytecode
138    *                        is copied into it after compilation and linking)
139    * @param [in] context    GL context
140    * @return pointer to the program
141    */
142   static Program* New( const Integration::ResourceId& resourceId, Integration::ShaderData* shaderData, Context& context );
143
144   /**
145    * Takes this program into use
146    */
147   void Use();
148
149   /**
150    * @return true if this program is used currently
151    */
152   bool IsUsed();
153
154   /**
155    * @param [in] type of the attribute
156    * @return the index of the attribute
157    */
158   GLint GetAttribLocation( AttribType type );
159
160   /**
161    * Register a uniform name in our local cache
162    * @param [in] name uniform name
163    * @return the index of the uniform name in local cache
164    */
165   unsigned int RegisterExternalUniform( const std::string& name );
166
167   /**
168    * Register a uniform name in our local cache
169    * @param [in] name uniform name
170    * @return the index of the uniform name in local cache
171    */
172   unsigned int RegisterUniform( const char* name );
173
174   /**
175    * Gets the location of a pre-registered uniform.
176    * Uniforms in list UniformType are always registered and in the order of the enumeration
177    * @param [in] uniformIndex of the uniform in local cache
178    * @return the index of the uniform in the GL program
179    */
180   GLint GetUniformLocation( unsigned int uniformIndex );
181
182   /**
183    * Sets the uniform value
184    * @param [in] location of uniform
185    * @param [in] value0 as int
186    */
187   void SetUniform1i( GLint location, GLint value0 );
188
189   /**
190    * Sets the uniform value
191    * @param [in] location of uniform
192    * @param [in] value0 as int
193    * @param [in] value1 as int
194    * @param [in] value2 as int
195    * @param [in] value3 as int
196    */
197   void SetUniform4i( GLint location, GLint value0, GLint value1, GLint value2, GLint value3 );
198
199   /**
200    * Sets the uniform value
201    * @param [in] location of uniform
202    * @param [in] value0 as float
203    */
204   void SetUniform1f( GLint location, GLfloat value0 );
205
206   /**
207    * Sets the uniform value
208    * @param [in] location of uniform
209    * @param [in] value0 as float
210    * @param [in] value1 as float
211    */
212   void SetUniform2f( GLint location, GLfloat value0, GLfloat value1 );
213
214   /**
215    * Sets the uniform value
216    * @param [in] location of uniform
217    * @param [in] value0 as float
218    * @param [in] value1 as float
219    * @param [in] value2 as float
220    */
221   void SetUniform3f( GLint location, GLfloat value0, GLfloat value1, GLfloat value2 );
222
223   /**
224    * Sets the uniform value
225    * @param [in] location of uniform
226    * @param [in] value0 as float
227    * @param [in] value1 as float
228    * @param [in] value2 as float
229    * @param [in] value3 as float
230    */
231   void SetUniform4f( GLint location, GLfloat value0, GLfloat value1, GLfloat value2, GLfloat value3 );
232
233   /**
234    * Sets the uniform value as matrix. NOTE! we never want GPU to transpose
235    * so make sure your matrix is in correct order for GL.
236    * @param [in] location Location of uniform
237    * @param [in] count Count of matrices
238    * @param [in] value values as float pointers
239    */
240   void SetUniformMatrix4fv( GLint location, GLsizei count, const GLfloat* value );
241
242   /**
243    * Sets the uniform value as matrix. NOTE! we never want GPU to transpose
244    * so make sure your matrix is in correct order for GL.
245    * @param [in] location Location of uniform
246    * @param [in] count Count of matrices
247    * @param [in] value values as float pointers
248    */
249   void SetUniformMatrix3fv( GLint location, GLsizei count, const GLfloat* value );
250
251   /**
252    * Needs to be called when GL context is (re)created
253    */
254   void GlContextCreated();
255
256   /**
257    * Needs to be called when GL context is destroyed
258    */
259   void GlContextDestroyed();
260
261 private: // Implementation
262
263   /**
264    * Constructor, private so no direct instantiation
265    * @param[in] shaderData A pointer to a data structure containing the program source and binary
266    * @param[in] context    The GL context state cache.
267    */
268   Program( Integration::ShaderData* shaderData, Context& context );
269
270 public:
271
272   /**
273    * Destructor, non virtual as no virtual methods or inheritance
274    */
275   ~Program();
276
277 private:
278
279   // default constructor, not defined
280   Program();
281   // assignment operator, not defined
282   Program& operator=( const Program& );
283
284   /**
285    * Load the shader, from a precompiled binary if available, else from source code
286    */
287   void Load();
288
289   /**
290    * Unload the shader
291    */
292   void Unload();
293
294   /**
295    * Compile the shader
296    * @param shaderType vertex or fragment shader
297    * @param shaderId of the shader, returned
298    * @param src of the shader
299    * @return true if the compilation succeeded
300    */
301   bool CompileShader(GLenum shaderType, GLuint& shaderId, const char* src);
302
303   /**
304    * Links the shaders together to create program
305    */
306   void Link();
307
308   /**
309    * Frees the shader programs
310    */
311   void FreeShaders();
312
313   /**
314    * Resets caches
315    */
316   void ResetAttribsUniforms();
317
318 private:  // Data
319
320   Context& mContext;                          ///< The GL context state cache
321   Integration::GlAbstraction& mGlAbstraction; ///< The OpenGL Abstraction layer
322   bool mLinked;                               ///< whether the program is linked
323   GLuint mVertexShaderId;                     ///< GL identifier for vertex shader
324   GLuint mFragmentShaderId;                   ///< GL identifier for fragment shader
325   GLuint mProgramId;                          ///< GL identifier for program
326   Integration::ShaderData* mProgramData;      ///< Shader program source and binary (when compiled & linked or loaded)
327
328   // uniform location caches
329   GLint mAttribLocations[ ATTRIB_TYPE_LAST ]; ///< attribute location cache
330   GLint mBuiltinUniformLocations[ UNIFORM_TYPE_LAST ];  ///< uniform location cache for built in uniforms
331   std::vector< std::pair< const char *, GLint > > mCustomUniformLocations; ///< uniform location cache for custom uniforms
332   static std::set< std::string > mExternalUniformNames; /// < names for externally specified uniforms, set to avoid duplicates
333
334   // uniform value caching
335   GLint mUniformCacheInt[ MAX_UNIFORM_CACHE_SIZE ];         ///< Value cache for uniforms of single int
336   GLfloat mUniformCacheFloat[ MAX_UNIFORM_CACHE_SIZE ];     ///< Value cache for uniforms of single float
337   GLfloat mUniformCacheFloat4[ MAX_UNIFORM_CACHE_SIZE ][4]; ///< Value cache for uniforms of four float
338
339 };
340
341 } // namespace Internal
342
343 } // namespace Dali
344
345 #endif // __DALI_INTERNAL_PROGRAM_H__