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    * Introspect the newly loaded shader to get the active sampler locations
 161    */
 162   void GetActiveSamplerUniforms();
 163
 164   /**
 165    * Gets the uniform location for a sampler
 166    * @param [in] index The index of the active sampler
 167    * @param [out] location The location of the requested sampler
 168    * @return true if the active sampler was found
 169    */
 170   bool GetSamplerUniformLocation( unsigned int index, GLint& location );
 171
 172   /**
 173    * Sets the uniform value
 174    * @param [in] location of uniform
 175    * @param [in] value0 as int
 176    */
 177   void SetUniform1i( GLint location, GLint value0 );
 178
 179   /**
 180    * Sets the uniform value
 181    * @param [in] location of uniform
 182    * @param [in] value0 as int
 183    * @param [in] value1 as int
 184    * @param [in] value2 as int
 185    * @param [in] value3 as int
 186    */
 187   void SetUniform4i( GLint location, GLint value0, GLint value1, GLint value2, GLint value3 );
 188
 189   /**
 190    * Sets the uniform value
 191    * @param [in] location of uniform
 192    * @param [in] value0 as float
 193    */
 194   void SetUniform1f( GLint location, GLfloat value0 );
 195
 196   /**
 197    * Sets the uniform value
 198    * @param [in] location of uniform
 199    * @param [in] value0 as float
 200    * @param [in] value1 as float
 201    */
 202   void SetUniform2f( GLint location, GLfloat value0, GLfloat value1 );
 203
 204   /**
 205    * Special handling for size as we're using uniform geometry so size is passed on to most programs
 206    * but it rarely changes so we can cache it
 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 SetSizeUniform3f( 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    */
 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   /**
 262    * @return true if this program modifies geometry
 263    */
 264   bool ModifiesGeometry();
 265
 266   /**
 267    * Set the projection matrix that has currently been sent
 268    * @param matrix to set
 269    */
 270   void SetProjectionMatrix( const Matrix* matrix )
 271   {
 272     mProjectionMatrix = matrix;
 273   }
 274
 275   /**
 276    * Get the projection matrix that has currently been sent
 277    * @return the matrix that is set
 278    */
 279   const Matrix* GetProjectionMatrix()
 280   {
 281     return mProjectionMatrix;
 282   }
 283
 284   /**
 285    * Set the projection matrix that has currently been sent
 286    * @param matrix to set
 287    */
 288   void SetViewMatrix( const Matrix* matrix )
 289   {
 290     mViewMatrix = matrix;
 291   }
 292
 293   /**
 294    * Get the projection matrix that has currently been sent
 295    * @return the matrix that is set
 296    */
 297   const Matrix* GetViewMatrix()
 298   {
 299     return mViewMatrix;
 300   }
 301
 302 private: // Implementation
 303
 304   /**
 305    * Constructor, private so no direct instantiation
 306    * @param[in] cache where the programs are stored
 307    * @param[in] shaderData A smart pointer to a data structure containing the program source and binary
 308    * @param[in] modifiesGeometry True if the vertex shader changes geometry
 309    */
 310   Program( ProgramCache& cache, Internal::ShaderDataPtr shaderData, bool modifiesGeometry );
 311
 312 public:
 313
 314   /**
 315    * Destructor, non virtual as no virtual methods or inheritance
 316    */
 317   ~Program();
 318
 319 private:
 320
 321   // default constructor, not defined
 322   Program();
 323   // assignment operator, not defined
 324   Program& operator=( const Program& );
 325
 326   /**
 327    * Load the shader, from a precompiled binary if available, else from source code
 328    */
 329   void Load();
 330
 331   /**
 332    * Unload the shader
 333    */
 334   void Unload();
 335
 336   /**
 337    * Compile the shader
 338    * @param shaderType vertex or fragment shader
 339    * @param shaderId of the shader, returned
 340    * @param src of the shader
 341    * @return true if the compilation succeeded
 342    */
 343   bool CompileShader(GLenum shaderType, GLuint& shaderId, const char* src);
 344
 345   /**
 346    * Links the shaders together to create program
 347    */
 348   void Link();
 349
 350   /**
 351    * Frees the shader programs
 352    */
 353   void FreeShaders();
 354
 355   /**
 356    * Resets caches
 357    */
 358   void ResetAttribsUniformCache();
 359
 360 private:  // Data
 361
 362   ProgramCache& mCache;                       ///< The program cache
 363   Integration::GlAbstraction& mGlAbstraction; ///< The OpenGL Abstraction layer
 364   const Matrix* mProjectionMatrix;            ///< currently set projection matrix
 365   const Matrix* mViewMatrix;                  ///< currently set view matrix
 366   bool mLinked;                               ///< whether the program is linked
 367   GLuint mVertexShaderId;                     ///< GL identifier for vertex shader
 368   GLuint mFragmentShaderId;                   ///< GL identifier for fragment shader
 369   GLuint mProgramId;                          ///< GL identifier for program
 370   Internal::ShaderDataPtr mProgramData;       ///< Shader program source and binary (when compiled & linked or loaded)
 371
 372   // location caches
 373   typedef std::pair< std::string, GLint > NameLocationPair;
 374   typedef std::vector< NameLocationPair > Locations;
 375
 376   Locations mAttributeLocations;      ///< attribute location cache
 377   Locations mUniformLocations;        ///< uniform location cache
 378   std::vector<GLint> mSamplerUniformLocations; ///< sampler uniform location cache
 379
 380   // uniform value caching
 381   GLint mUniformCacheInt[ MAX_UNIFORM_CACHE_SIZE ];         ///< Value cache for uniforms of single int
 382   GLfloat mUniformCacheFloat[ MAX_UNIFORM_CACHE_SIZE ];     ///< Value cache for uniforms of single float
 383   GLfloat mUniformCacheFloat2[ MAX_UNIFORM_CACHE_SIZE ][2]; ///< Value cache for uniforms of two floats
 384   GLfloat mUniformCacheFloat4[ MAX_UNIFORM_CACHE_SIZE ][4]; ///< Value cache for uniforms of four floats
 385   Vector3 mSizeUniformCache;                                ///< Cache value for size uniform
 386   bool mModifiesGeometry;  ///< True if the program changes geometry
 387
 388 };
 389
 390 } // namespace Internal
 391
 392 } // namespace Dali
 393
 394 #endif // __DALI_INTERNAL_PROGRAM_H__