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