dali/internal/render/renderers/render-renderer.h

   1 #ifndef DALI_INTERNAL_RENDER_RENDERER_H
   2 #define DALI_INTERNAL_RENDER_RENDERER_H
   3
   4 /*
   5  * Copyright (c) 2016 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 // INTERNAL INCLUDES
  22 #include <dali/public-api/math/matrix.h>
  23 #include <dali/public-api/math/vector4.h>
  24 #include <dali/public-api/rendering/texture-set.h>
  25 #include <dali/internal/common/blending-options.h>
  26 #include <dali/internal/common/message.h>
  27 #include <dali/internal/common/type-abstraction-enums.h>
  28 #include <dali/internal/event/common/property-input-impl.h>
  29 #include <dali/internal/render/data-providers/render-data-provider.h>
  30 #include <dali/internal/render/gl-resources/gl-resource-owner.h>
  31 #include <dali/internal/render/renderers/render-geometry.h>
  32 #include <dali/internal/update/manager/render-instruction-processor.h>
  33 #include <dali/integration-api/debug.h>
  34
  35 namespace Dali
  36 {
  37
  38 namespace Internal
  39 {
  40 class Context;
  41 class Texture;
  42 class Program;
  43
  44 namespace SceneGraph
  45 {
  46 class SceneController;
  47 class Shader;
  48 class TextureCache;
  49 class NodeDataProvider;
  50 }
  51
  52 namespace Render
  53 {
  54
  55 /**
  56  * Renderers are used to render meshes
  57  * These objects are used during RenderManager::Render(), so properties modified during
  58  * the Update must either be double-buffered, or set via a message added to the RenderQueue.
  59  */
  60 class Renderer : public GlResourceOwner
  61 {
  62 public:
  63
  64   /**
  65    * @brief Struct to encapsulate stencil parameters required for control of the stencil buffer.
  66    */
  67   struct StencilParameters
  68   {
  69     StencilParameters( RenderMode::Type renderMode, StencilFunction::Type stencilFunction, int stencilFunctionMask,
  70                        int stencilFunctionReference, int stencilMask, StencilOperation::Type stencilOperationOnFail,
  71                        StencilOperation::Type stencilOperationOnZFail, StencilOperation::Type stencilOperationOnZPass )
  72     : stencilFunctionMask      ( stencilFunctionMask      ),
  73       stencilFunctionReference ( stencilFunctionReference ),
  74       stencilMask              ( stencilMask              ),
  75       renderMode               ( renderMode               ),
  76       stencilFunction          ( stencilFunction          ),
  77       stencilOperationOnFail   ( stencilOperationOnFail   ),
  78       stencilOperationOnZFail  ( stencilOperationOnZFail  ),
  79       stencilOperationOnZPass  ( stencilOperationOnZPass  )
  80     {
  81     }
  82
  83     int stencilFunctionMask;                          ///< The stencil function mask
  84     int stencilFunctionReference;                     ///< The stencil function reference
  85     int stencilMask;                                  ///< The stencil mask
  86     RenderMode::Type       renderMode:3;              ///< The render mode
  87     StencilFunction::Type  stencilFunction:3;         ///< The stencil function
  88     StencilOperation::Type stencilOperationOnFail:3;  ///< The stencil operation for stencil test fail
  89     StencilOperation::Type stencilOperationOnZFail:3; ///< The stencil operation for depth test fail
  90     StencilOperation::Type stencilOperationOnZPass:3; ///< The stencil operation for depth test pass
  91   };
  92
  93   /**
  94    * @copydoc Dali::Internal::GlResourceOwner::GlContextDestroyed()
  95    */
  96   void GlContextDestroyed();
  97
  98   /**
  99    * @copydoc Dali::Internal::GlResourceOwner::GlCleanup()
 100    */
 101   void GlCleanup();
 102
 103   /**
 104    * Create a new renderer instance
 105    * @param[in] dataProviders The data providers for the renderer
 106    * @param[in] geometry The geometry for the renderer
 107    * @param[in] blendingBitmask A bitmask of blending options.
 108    * @param[in] blendColor The blend color to pass to GL
 109    * @param[in] faceCullingMode The face-culling mode.
 110    * @param[in] preMultipliedAlphaEnabled whether alpha is pre-multiplied.
 111    * @param[in] depthWriteMode Depth buffer write mode
 112    * @param[in] depthTestMode Depth buffer test mode
 113    * @param[in] depthFunction Depth function
 114    * @param[in] stencilParameters Struct containing all stencil related options
 115    */
 116   static Renderer* New( SceneGraph::RenderDataProvider* dataProviders,
 117                         Render::Geometry* geometry,
 118                         unsigned int blendingBitmask,
 119                         const Vector4* blendColor,
 120                         FaceCullingMode::Type faceCullingMode,
 121                         bool preMultipliedAlphaEnabled,
 122                         DepthWriteMode::Type depthWriteMode,
 123                         DepthTestMode::Type depthTestMode,
 124                         DepthFunction::Type depthFunction,
 125                         StencilParameters& stencilParameters );
 126
 127   /**
 128    * Constructor.
 129    * @param[in] dataProviders The data providers for the renderer
 130    * @param[in] geometry The geometry for the renderer
 131    * @param[in] blendingBitmask A bitmask of blending options.
 132    * @param[in] blendColor The blend color to pass to GL
 133    * @param[in] faceCullingMode The face-culling mode.
 134    * @param[in] preMultipliedAlphaEnabled whether alpha is pre-multiplied.
 135    * @param[in] depthWriteMode Depth buffer write mode
 136    * @param[in] depthTestMode Depth buffer test mode
 137    * @param[in] depthFunction Depth function
 138    * @param[in] stencilParameters Struct containing all stencil related options
 139    */
 140   Renderer( SceneGraph::RenderDataProvider* dataProviders,
 141             Render::Geometry* geometry,
 142             unsigned int blendingBitmask,
 143             const Vector4* blendColor,
 144             FaceCullingMode::Type faceCullingMode,
 145             bool preMultipliedAlphaEnabled,
 146             DepthWriteMode::Type depthWriteMode,
 147             DepthTestMode::Type depthTestMode,
 148             DepthFunction::Type depthFunction,
 149             StencilParameters& stencilParameters );
 150
 151   /**
 152    * Change the data providers of the renderer
 153    * @param[in] dataProviders The data providers
 154    */
 155   void SetRenderDataProvider( SceneGraph::RenderDataProvider* dataProviders );
 156
 157   /**
 158    * Change the geometry used by the renderer
 159    * @param[in] geometry The new geometry
 160    */
 161   void SetGeometry( Render::Geometry* geometry );
 162
 163   /**
 164    * Second-phase construction.
 165    * This is called when the renderer is inside render thread
 166    * @param[in] context Context used by the renderer
 167    * @param[in] textureCache The texture cache to use
 168    */
 169   void Initialize( Context& context, SceneGraph::TextureCache& textureCache );
 170
 171   /**
 172    * Destructor
 173    */
 174   ~Renderer();
 175
 176   /**
 177    * Set the face-culling mode.
 178    * @param[in] mode The face-culling mode.
 179    */
 180   void SetFaceCullingMode( FaceCullingMode::Type mode );
 181
 182   /**
 183    * Set the bitmask for blending options
 184    * @param[in] bitmask A bitmask of blending options.
 185    */
 186   void SetBlendingBitMask( unsigned int bitmask );
 187
 188   /**
 189    * Set the blend color for blending options
 190    * @param[in] blendColor The blend color to pass to GL
 191    */
 192   void SetBlendColor( const Vector4* color );
 193
 194   /**
 195    * Set the first element index to draw by the indexed draw
 196    * @param[in] firstElement index of first element to draw
 197    */
 198   void SetIndexedDrawFirstElement( size_t firstElement );
 199
 200   /**
 201    * Set the number of elements to draw by the indexed draw
 202    * @param[in] elementsCount number of elements to draw
 203    */
 204   void SetIndexedDrawElementsCount( size_t elementsCount );
 205
 206   /**
 207    * @brief Set whether the Pre-multiplied Alpha Blending is required
 208    *
 209    * @param[in] preMultipled whether alpha is pre-multiplied.
 210    */
 211   void EnablePreMultipliedAlpha( bool preMultipled );
 212
 213   /**
 214    * Sets the depth write mode
 215    * @param[in] depthWriteMode The depth write mode
 216    */
 217   void SetDepthWriteMode( DepthWriteMode::Type depthWriteMode );
 218
 219   /**
 220    * Query the Renderer's depth write mode
 221    * @return The renderer depth write mode
 222    */
 223   DepthWriteMode::Type GetDepthWriteMode() const;
 224
 225   /**
 226    * Sets the depth test mode
 227    * @param[in] depthTestMode The depth test mode
 228    */
 229   void SetDepthTestMode( DepthTestMode::Type depthTestMode );
 230
 231   /**
 232    * Query the Renderer's depth test mode
 233    * @return The renderer depth test mode
 234    */
 235   DepthTestMode::Type GetDepthTestMode() const;
 236
 237   /**
 238    * Sets the depth function
 239    * @param[in] depthFunction The depth function
 240    */
 241   void SetDepthFunction( DepthFunction::Type depthFunction );
 242
 243   /**
 244    * Query the Renderer's depth function
 245    * @return The renderer depth function
 246    */
 247   DepthFunction::Type GetDepthFunction() const;
 248
 249   /**
 250    * Sets the render mode
 251    * @param[in] renderMode The render mode
 252    */
 253   void SetRenderMode( RenderMode::Type mode );
 254
 255   /**
 256    * Gets the render mode
 257    * @return The render mode
 258    */
 259   RenderMode::Type GetRenderMode() const;
 260
 261   /**
 262    * Sets the stencil function
 263    * @param[in] stencilFunction The stencil function
 264    */
 265   void SetStencilFunction( StencilFunction::Type stencilFunction );
 266
 267   /**
 268    * Gets the stencil function
 269    * @return The stencil function
 270    */
 271   StencilFunction::Type GetStencilFunction() const;
 272
 273   /**
 274    * Sets the stencil function mask
 275    * @param[in] stencilFunctionMask The stencil function mask
 276    */
 277   void SetStencilFunctionMask( int stencilFunctionMask );
 278
 279   /**
 280    * Gets the stencil function mask
 281    * @return The stencil function mask
 282    */
 283   int GetStencilFunctionMask() const;
 284
 285   /**
 286    * Sets the stencil function reference
 287    * @param[in] stencilFunctionReference The stencil function reference
 288    */
 289   void SetStencilFunctionReference( int stencilFunctionReference );
 290
 291   /**
 292    * Gets the stencil function reference
 293    * @return The stencil function reference
 294    */
 295   int GetStencilFunctionReference() const;
 296
 297   /**
 298    * Sets the stencil mask
 299    * @param[in] stencilMask The stencil mask
 300    */
 301   void SetStencilMask( int stencilMask );
 302
 303   /**
 304    * Gets the stencil mask
 305    * @return The stencil mask
 306    */
 307   int GetStencilMask() const;
 308
 309   /**
 310    * Sets the stencil operation for when the stencil test fails
 311    * @param[in] stencilOperationOnFail The stencil operation
 312    */
 313   void SetStencilOperationOnFail( StencilOperation::Type stencilOperationOnFail );
 314
 315   /**
 316    * Gets the stencil operation for when the stencil test fails
 317    * @return The stencil operation
 318    */
 319   StencilOperation::Type GetStencilOperationOnFail() const;
 320
 321   /**
 322    * Sets the stencil operation for when the depth test fails
 323    * @param[in] stencilOperationOnZFail The stencil operation
 324    */
 325   void SetStencilOperationOnZFail( StencilOperation::Type stencilOperationOnZFail );
 326
 327   /**
 328    * Gets the stencil operation for when the depth test fails
 329    * @return The stencil operation
 330    */
 331   StencilOperation::Type GetStencilOperationOnZFail() const;
 332
 333   /**
 334    * Sets the stencil operation for when the depth test passes
 335    * @param[in] stencilOperationOnZPass The stencil operation
 336    */
 337   void SetStencilOperationOnZPass( StencilOperation::Type stencilOperationOnZPass );
 338
 339   /**
 340    * Gets the stencil operation for when the depth test passes
 341    * @return The stencil operation
 342    */
 343   StencilOperation::Type GetStencilOperationOnZPass() const;
 344
 345   /**
 346    * Called to render during RenderManager::Render().
 347    * @param[in] context The context used for rendering
 348    * @param[in] textureCache The texture cache used to get textures
 349    * @param[in] bufferIndex The index of the previous update buffer.
 350    * @param[in] node The node using this renderer
 351    * @param[in] defaultShader in case there is no custom shader
 352    * @param[in] modelViewMatrix The model-view matrix.
 353    * @param[in] viewMatrix The view matrix.
 354    * @param[in] projectionMatrix The projection matrix.
 355    * @param[in] size Size of the render item
 356    * @param[in] blend If true, blending is enabled
 357    */
 358   void Render( Context& context,
 359                SceneGraph::TextureCache& textureCache,
 360                BufferIndex bufferIndex,
 361                const SceneGraph::NodeDataProvider& node,
 362                SceneGraph::Shader& defaultShader,
 363                const Matrix& modelMatrix,
 364                const Matrix& modelViewMatrix,
 365                const Matrix& viewMatrix,
 366                const Matrix& projectionMatrix,
 367                const Vector3& size,
 368                bool blend );
 369
 370   /**
 371    * Write the renderer's sort attributes to the passed in reference
 372    *
 373    * @param[in] bufferIndex The current update buffer index.
 374    * @param[out] sortAttributes
 375    */
 376   void SetSortAttributes( BufferIndex bufferIndex, SceneGraph::RenderInstructionProcessor::SortAttributes& sortAttributes ) const;
 377
 378 private:
 379
 380   struct UniformIndexMap;
 381
 382   // Undefined
 383   Renderer( const Renderer& );
 384
 385   // Undefined
 386   Renderer& operator=( const Renderer& rhs );
 387
 388   /**
 389    * Sets blending options
 390    * @param context to use
 391    * @param blend Wheter blending should be enabled or not
 392    */
 393   void SetBlending( Context& context, bool blend );
 394
 395   /**
 396    * Set the uniforms from properties according to the uniform map
 397    * @param[in] bufferIndex The index of the previous update buffer.
 398    * @param[in] node The node using the renderer
 399    * @param[in] size The size of the renderer
 400    * @param[in] program The shader program on which to set the uniforms.
 401    */
 402   void SetUniforms( BufferIndex bufferIndex, const SceneGraph::NodeDataProvider& node, const Vector3& size, Program& program );
 403
 404   /**
 405    * Set the program uniform in the map from the mapped property
 406    * @param[in] bufferIndex The index of the previous update buffer.
 407    * @param[in] program The shader program
 408    * @param[in] map The uniform
 409    */
 410   void SetUniformFromProperty( BufferIndex bufferIndex, Program& program, UniformIndexMap& map );
 411
 412   /**
 413    * Bind the textures and setup the samplers
 414    * @param[in] context The GL context
 415    * @param[in] textureCache The texture cache
 416    * @param[in] program The shader program
 417    * @return False if create or bind failed, true if success.
 418    */
 419   bool BindTextures( Context& context, SceneGraph::TextureCache& textureCache, Program& program );
 420
 421 private:
 422
 423   OwnerPointer< SceneGraph::RenderDataProvider > mRenderDataProvider;
 424
 425   Context*                     mContext;
 426   SceneGraph::TextureCache*    mTextureCache;
 427   Render::Geometry*            mGeometry;
 428
 429   struct UniformIndexMap
 430   {
 431     unsigned int               uniformIndex;                ///< The index of the cached location in the Program
 432     const PropertyInputImpl*   propertyValue;
 433   };
 434
 435   typedef Dali::Vector< UniformIndexMap > UniformIndexMappings;
 436
 437   UniformIndexMappings         mUniformIndexMap;
 438   Vector<GLint>                mAttributesLocation;
 439
 440   StencilParameters            mStencilParameters;          ///< Struct containing all stencil related options
 441   BlendingOptions              mBlendingOptions;            ///< Blending options including blend color, blend func and blend equation
 442
 443   size_t                       mIndexedDrawFirstElement;    ///< Offset of first element to draw
 444   size_t                       mIndexedDrawElementsCount;   ///< Number of elements to draw
 445
 446   DepthFunction::Type          mDepthFunction:3;            ///< The depth function
 447   FaceCullingMode::Type        mFaceCullingMode:2;          ///< The mode of face culling
 448   DepthWriteMode::Type         mDepthWriteMode:2;           ///< The depth write mode
 449   DepthTestMode::Type          mDepthTestMode:2;            ///< The depth test mode
 450   bool                         mUpdateAttributesLocation:1; ///< Indicates attribute locations have changed
 451   bool                         mPremultipledAlphaEnabled:1; ///< Flag indicating whether the Pre-multiplied Alpha Blending is required
 452
 453 };
 454
 455 } // namespace SceneGraph
 456
 457 } // namespace Internal
 458
 459 } // namespace Dali
 460
 461 #endif // DALI_INTERNAL_RENDER_RENDERER_H