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/object/ref-object.h>
  27 #include <dali/integration-api/gl-abstraction.h>
  28 #include <dali/internal/common/shader-data.h>
  29
  30 namespace Dali
  31 {
  32
  33 class Matrix;
  34
  35 namespace Integration
  36 {
  37 class GlAbstraction;
  38 class ShaderData;
  39 }
  40
  41 namespace Internal
  42 {
  43
  44 class ProgramCache;
  45
  46 /*
  47  * A program contains a vertex & fragment shader.
  48  *
  49  * A program will contain vertex attributes and uniform variables.
  50  *
  51  * uColor is set to the value specified by Actor::SetColor and is
  52  * animatable through the property Actor::COLOR
  53  */
  54 class Program
  55 {
  56 public:
  57
  58   /**
  59    * Size of the uniform cache per program
  60    * GLES specification states that minimum uniform count for fragment shader
  61    * is 16 and for vertex shader 128. We're caching the 16 common ones for now
  62    */
  63   static const int MAX_UNIFORM_CACHE_SIZE = 16;
  64
  65   /**
  66    * Constant for uniform / attribute not found
  67    */
  68   static const int NOT_FOUND = -1;
  69
  70   /**
  71    * Vertex attributes
  72    */
  73   enum AttribType
  74   {
  75     ATTRIB_UNKNOWN = -1,
  76     ATTRIB_POSITION,
  77     ATTRIB_NORMAL,
  78     ATTRIB_TEXCOORD,
  79     ATTRIB_COLOR,
  80     ATTRIB_BONE_WEIGHTS,
  81     ATTRIB_BONE_INDICES,
  82     ATTRIB_TYPE_LAST
  83   };
  84
  85   /**
  86    * Common shader uniform names
  87    */
  88   enum UniformType
  89   {
  90     UNIFORM_NOT_QUERIED = -2,
  91     UNIFORM_UNKNOWN = -1,
  92     UNIFORM_MVP_MATRIX,
  93     UNIFORM_MODELVIEW_MATRIX,
  94     UNIFORM_PROJECTION_MATRIX,
  95     UNIFORM_MODEL_MATRIX,
  96     UNIFORM_VIEW_MATRIX,
  97     UNIFORM_NORMAL_MATRIX,
  98     UNIFORM_COLOR,
  99     UNIFORM_SAMPLER,
 100     UNIFORM_SAMPLER_RECT,
 101     UNIFORM_EFFECT_SAMPLER,
 102
 103     UNIFORM_SIZE,
 104     UNIFORM_TYPE_LAST
 105   };
 106
 107   /**
 108    * Creates a new program, or returns a copy of an existing program in the program cache
 109    * @param[in] cache where the programs are stored
 110    * @param[in] shaderData  A pointer to a data structure containing the program source
 111    *                        and optionally precompiled binary. If the binary is empty the program bytecode
 112    *                        is copied into it after compilation and linking)
 113    * @param[in] modifiesGeometry True if the shader modifies geometry
 114    * @return pointer to the program
 115    */
 116   static Program* New( ProgramCache& cache, Internal::ShaderDataPtr shaderData, bool modifiesGeometry );
 117
 118   /**
 119    * Takes this program into use
 120    */
 121   void Use();
 122
 123   /**
 124    * @return true if this program is used currently
 125    */
 126   bool IsUsed();
 127
 128   /**
 129    * @param [in] type of the attribute
 130    * @return the index of the attribute
 131    */
 132   GLint GetAttribLocation( AttribType type );
 133
 134   /**
 135    * Register an attribute name in our local cache
 136    * @param [in] name attribute name
 137    * @return the index of the attribute name in local cache
 138    */
 139   unsigned int RegisterCustomAttribute( const std::string& name );
 140
 141   /**
 142    * Gets the location of a pre-registered attribute.
 143    * @param [in] attributeIndex of the attribute in local cache
 144    * @return the index of the attribute in the GL program
 145    */
 146   GLint GetCustomAttributeLocation( unsigned int attributeIndex );
 147
 148   /**
 149    * Register a uniform name in our local cache
 150    * @param [in] name uniform name
 151    * @return the index of the uniform name in local cache
 152    */
 153   unsigned int RegisterUniform( const std::string& name );
 154
 155   /**
 156    * Gets the location of a pre-registered uniform.
 157    * Uniforms in list UniformType are always registered and in the order of the enumeration
 158    * @param [in] uniformIndex of the uniform in local cache
 159    * @return the index of the uniform in the GL program
 160    */
 161   GLint GetUniformLocation( unsigned int uniformIndex );
 162
 163   /**
 164    * Sets the uniform value
 165    * @param [in] location of uniform
 166    * @param [in] value0 as int
 167    */
 168   void SetUniform1i( GLint location, GLint value0 );
 169
 170   /**
 171    * Sets the uniform value
 172    * @param [in] location of uniform
 173    * @param [in] value0 as int
 174    * @param [in] value1 as int
 175    * @param [in] value2 as int
 176    * @param [in] value3 as int
 177    */
 178   void SetUniform4i( GLint location, GLint value0, GLint value1, GLint value2, GLint value3 );
 179
 180   /**
 181    * Sets the uniform value
 182    * @param [in] location of uniform
 183    * @param [in] value0 as float
 184    */
 185   void SetUniform1f( GLint location, GLfloat value0 );
 186
 187   /**
 188    * Sets the uniform value
 189    * @param [in] location of uniform
 190    * @param [in] value0 as float
 191    * @param [in] value1 as float
 192    */
 193   void SetUniform2f( GLint location, GLfloat value0, GLfloat value1 );
 194
 195   /**
 196    * Special handling for size as we're using uniform geometry so size is passed on to most programs
 197    * but it rarely changes so we can cache it
 198    * @param [in] location of uniform
 199    * @param [in] value0 as float
 200    * @param [in] value1 as float
 201    * @param [in] value2 as float
 202    */
 203   void SetSizeUniform3f( GLint location, GLfloat value0, GLfloat value1, GLfloat value2 );
 204
 205   /**
 206    * Sets the uniform value
 207    * @param [in] location of uniform
 208    * @param [in] value0 as float
 209    * @param [in] value1 as float
 210    * @param [in] value2 as float
 211    */
 212   void SetUniform3f( GLint location, GLfloat value0, GLfloat value1, GLfloat value2 );
 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    * @param [in] value3 as float
 221    */
 222   void SetUniform4f( GLint location, GLfloat value0, GLfloat value1, GLfloat value2, GLfloat value3 );
 223
 224   /**
 225    * Sets the uniform value as matrix. NOTE! we never want GPU to transpose
 226    * so make sure your matrix is in correct order for GL.
 227    * @param [in] location Location of uniform
 228    * @param [in] count Count of matrices
 229    * @param [in] value values as float pointers
 230    */
 231   void SetUniformMatrix4fv( GLint location, GLsizei count, const GLfloat* value );
 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 SetUniformMatrix3fv( GLint location, GLsizei count, const GLfloat* value );
 241
 242   /**
 243    * Needs to be called when GL context is (re)created
 244    */
 245   void GlContextCreated();
 246
 247   /**
 248    * Needs to be called when GL context is destroyed
 249    */
 250   void GlContextDestroyed();
 251
 252   /**
 253    * @return true if this program modifies geometry
 254    */
 255   bool ModifiesGeometry();
 256
 257   /**
 258    * Set the projection matrix that has currently been sent
 259    * @param matrix to set
 260    */
 261   void SetProjectionMatrix( const Matrix* matrix )
 262   {
 263     mProjectionMatrix = matrix;
 264   }
 265
 266   /**
 267    * Get the projection matrix that has currently been sent
 268    * @return the matrix that is set
 269    */
 270   const Matrix* GetProjectionMatrix()
 271   {
 272     return mProjectionMatrix;
 273   }
 274
 275   /**
 276    * Set the projection matrix that has currently been sent
 277    * @param matrix to set
 278    */
 279   void SetViewMatrix( const Matrix* matrix )
 280   {
 281     mViewMatrix = matrix;
 282   }
 283
 284   /**
 285    * Get the projection matrix that has currently been sent
 286    * @return the matrix that is set
 287    */
 288   const Matrix* GetViewMatrix()
 289   {
 290     return mViewMatrix;
 291   }
 292
 293 private: // Implementation
 294
 295   /**
 296    * Constructor, private so no direct instantiation
 297    * @param[in] cache where the programs are stored
 298    * @param[in] shaderData A smart pointer to a data structure containing the program source and binary
 299    * @param[in] modifiesGeometry True if the vertex shader changes geometry
 300    */
 301   Program( ProgramCache& cache, Internal::ShaderDataPtr shaderData, bool modifiesGeometry );
 302
 303 public:
 304
 305   /**
 306    * Destructor, non virtual as no virtual methods or inheritance
 307    */
 308   ~Program();
 309
 310 private:
 311
 312   // default constructor, not defined
 313   Program();
 314   // assignment operator, not defined
 315   Program& operator=( const Program& );
 316
 317   /**
 318    * Load the shader, from a precompiled binary if available, else from source code
 319    */
 320   void Load();
 321
 322   /**
 323    * Unload the shader
 324    */
 325   void Unload();
 326
 327   /**
 328    * Compile the shader
 329    * @param shaderType vertex or fragment shader
 330    * @param shaderId of the shader, returned
 331    * @param src of the shader
 332    * @return true if the compilation succeeded
 333    */
 334   bool CompileShader(GLenum shaderType, GLuint& shaderId, const char* src);
 335
 336   /**
 337    * Links the shaders together to create program
 338    */
 339   void Link();
 340
 341   /**
 342    * Frees the shader programs
 343    */
 344   void FreeShaders();
 345
 346   /**
 347    * Resets caches
 348    */
 349   void ResetAttribsUniformCache();
 350
 351 private:  // Data
 352
 353   ProgramCache& mCache;                       ///< The program cache
 354   Integration::GlAbstraction& mGlAbstraction; ///< The OpenGL Abstraction layer
 355   const Matrix* mProjectionMatrix;            ///< currently set projection matrix
 356   const Matrix* mViewMatrix;                  ///< currently set view matrix
 357   bool mLinked;                               ///< whether the program is linked
 358   GLuint mVertexShaderId;                     ///< GL identifier for vertex shader
 359   GLuint mFragmentShaderId;                   ///< GL identifier for fragment shader
 360   GLuint mProgramId;                          ///< GL identifier for program
 361   Internal::ShaderDataPtr mProgramData;    ///< Shader program source and binary (when compiled & linked or loaded)
 362
 363   // location caches
 364   std::vector< std::pair< std::string, GLint > > mAttributeLocations; ///< attribute location cache
 365   std::vector< std::pair< std::string, GLint > > mUniformLocations; ///< uniform location cache
 366
 367   // uniform value caching
 368   GLint mUniformCacheInt[ MAX_UNIFORM_CACHE_SIZE ];         ///< Value cache for uniforms of single int
 369   GLfloat mUniformCacheFloat[ MAX_UNIFORM_CACHE_SIZE ];     ///< Value cache for uniforms of single float
 370   GLfloat mUniformCacheFloat4[ MAX_UNIFORM_CACHE_SIZE ][4]; ///< Value cache for uniforms of four float
 371   Vector3 mSizeUniformCache;                                ///< Cache value for size uniform
 372   bool mModifiesGeometry;  ///< True if the program changes geometry
 373
 374 };
 375
 376 } // namespace Internal
 377
 378 } // namespace Dali
 379
 380 #endif // __DALI_INTERNAL_PROGRAM_H__