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