1 #ifndef DALI_INTERNAL_SCENE_GRAPH_RENDERER_H
2 #define DALI_INTERNAL_SCENE_GRAPH_RENDERER_H
5 * Copyright (c) 2018 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
20 #include <dali/public-api/rendering/geometry.h>
21 #include <dali/public-api/rendering/renderer.h> // Dali::Renderer
22 #include <dali/devel-api/rendering/renderer-devel.h>
23 #include <dali/internal/common/blending-options.h>
24 #include <dali/internal/common/type-abstraction-enums.h>
25 #include <dali/internal/event/common/event-thread-services.h>
26 #include <dali/internal/update/common/property-owner.h>
27 #include <dali/internal/update/common/uniform-map.h>
28 #include <dali/internal/update/common/scene-graph-connection-change-propagator.h>
29 #include <dali/internal/update/common/animatable-property.h>
30 #include <dali/internal/render/data-providers/render-data-provider.h>
31 #include <dali/internal/render/renderers/render-renderer.h>
47 class SceneController;
50 typedef Dali::Vector< Renderer* > RendererContainer;
51 typedef RendererContainer::Iterator RendererIter;
52 typedef RendererContainer::ConstIterator RendererConstIter;
57 class Renderer : public PropertyOwner,
58 public UniformMapDataProvider,
59 public UniformMap::Observer,
60 public ConnectionChangePropagator::Observer
72 * Construct a new Renderer
74 static Renderer* New();
82 * Overriden delete operator
83 * Deletes the renderer from its global memory pool
85 void operator delete( void* ptr );
88 * Set the texture set for the renderer
89 * @param[in] textureSet The texture set this renderer will use
91 void SetTextures( TextureSet* textureSet );
94 * Returns current texture set object
95 * @return Pointer to the texture set
97 const TextureSet* GetTextures() const
103 * Set the shader for the renderer
104 * @param[in] shader The shader this renderer will use
106 void SetShader( Shader* shader );
109 * Get the shader used by this renderer
110 * @return the shader this renderer uses
112 const Shader& GetShader() const
118 * Set the geometry for the renderer
119 * @param[in] geometry The geometry this renderer will use
121 void SetGeometry( Render::Geometry* geometry );
124 * Set the depth index
125 * @param[in] depthIndex the new depth index to use
127 void SetDepthIndex( int depthIndex );
130 * @brief Get the depth index
131 * @return The depth index
133 int GetDepthIndex() const
139 * Set the face culling mode
140 * @param[in] faceCullingMode to use
142 void SetFaceCullingMode( FaceCullingMode::Type faceCullingMode );
145 * Get face culling mode
146 * @return The face culling mode
148 FaceCullingMode::Type GetFaceCullingMode() const;
151 * Set the blending mode
152 * @param[in] blendingMode to use
154 void SetBlendMode( BlendMode::Type blendingMode );
157 * Get the blending mode
158 * @return The the blending mode
160 BlendMode::Type GetBlendMode() const;
163 * Set the blending options. This should only be called from the update thread.
164 * @param[in] options A bitmask of blending options.
166 void SetBlendingOptions( uint32_t options );
169 * Get the blending options
170 * @return The the blending mode
172 uint32_t GetBlendingOptions() const;
175 * Set the blend color for blending operation
176 * @param blendColor to pass to GL
178 void SetBlendColor( const Vector4& blendColor );
181 * Get the blending color
182 * @return The blend color
184 Vector4 GetBlendColor() const;
187 * Set the index of first element for indexed draw
188 * @param[in] firstElement index of first element to draw
190 void SetIndexedDrawFirstElement( uint32_t firstElement );
193 * Get the index of first element for indexed draw
194 * @return The index of first element for indexed draw
196 uint32_t GetIndexedDrawFirstElement() const;
199 * Set the number of elements to draw by indexed draw
200 * @param[in] elementsCount number of elements to draw
202 void SetIndexedDrawElementsCount( uint32_t elementsCount );
205 * Get the number of elements to draw by indexed draw
206 * @return The number of elements to draw by indexed draw
208 uint32_t GetIndexedDrawElementsCount() const;
211 * @brief Set whether the Pre-multiplied Alpha Blending is required
212 * @param[in] preMultipled whether alpha is pre-multiplied.
214 void EnablePreMultipliedAlpha( bool preMultipled );
217 * @brief Query whether alpha is pre-multiplied.
218 * @return True is alpha is pre-multiplied, false otherwise.
220 bool IsPreMultipliedAlphaEnabled() const;
223 * Sets the depth buffer write mode
224 * @param[in] depthWriteMode The depth buffer write mode
226 void SetDepthWriteMode( DepthWriteMode::Type depthWriteMode );
229 * Get the depth buffer write mode
230 * @return The depth buffer write mode
232 DepthWriteMode::Type GetDepthWriteMode() const;
235 * Sets the depth buffer test mode
236 * @param[in] depthTestMode The depth buffer test mode
238 void SetDepthTestMode( DepthTestMode::Type depthTestMode );
241 * Get the depth buffer test mode
242 * @return The depth buffer test mode
244 DepthTestMode::Type GetDepthTestMode() const;
247 * Sets the depth function
248 * @param[in] depthFunction The depth function
250 void SetDepthFunction( DepthFunction::Type depthFunction );
253 * Get the depth function
254 * @return The depth function
256 DepthFunction::Type GetDepthFunction() const;
259 * Sets the render mode
260 * @param[in] mode The render mode
262 void SetRenderMode( RenderMode::Type mode );
265 * Sets the stencil function
266 * @param[in] stencilFunction The stencil function
268 void SetStencilFunction( StencilFunction::Type stencilFunction );
271 * Sets the stencil function mask
272 * @param[in] stencilFunctionMask The stencil function mask
274 void SetStencilFunctionMask( int stencilFunctionMask );
277 * Sets the stencil function reference
278 * @param[in] stencilFunctionReference The stencil function reference
280 void SetStencilFunctionReference( int stencilFunctionReference );
283 * Sets the stencil mask
284 * @param[in] stencilMask The stencil mask
286 void SetStencilMask( int stencilMask );
289 * Sets the stencil operation for when the stencil test fails
290 * @param[in] stencilOperationOnFail The stencil operation
292 void SetStencilOperationOnFail( StencilOperation::Type stencilOperationOnFail );
295 * Sets the stencil operation for when the depth test fails
296 * @param[in] stencilOperationOnZFail The stencil operation
298 void SetStencilOperationOnZFail( StencilOperation::Type stencilOperationOnZFail );
301 * Sets the stencil operation for when the depth test passes
302 * @param[in] stencilOperationOnZPass The stencil operation
304 void SetStencilOperationOnZPass( StencilOperation::Type stencilOperationOnZPass );
307 * Gets the stencil parameters
308 * @return The stencil parameters
310 const Render::Renderer::StencilParameters& GetStencilParameters() const;
314 * @param[in] updateBufferIndex The current update buffer index.
315 * @param[in] opacity The opacity
317 void BakeOpacity( BufferIndex updateBufferIndex, float opacity );
321 * @param[in] bufferIndex The buffer to read from.
322 * @return The opacity
324 float GetOpacity( BufferIndex updateBufferIndex ) const;
327 * Sets the rendering behavior
328 * @param[in] renderingBehavior The rendering behavior required.
330 void SetRenderingBehavior( DevelRenderer::Rendering::Type renderingBehavior );
333 * Gets the rendering behavior
334 * @return The rendering behavior
336 DevelRenderer::Rendering::Type GetRenderingBehavior() const;
339 * Prepare the object for rendering.
340 * This is called by the UpdateManager when an object is due to be rendered in the current frame.
341 * @param[in] updateBufferIndex The current update buffer index.
343 void PrepareRender( BufferIndex updateBufferIndex );
346 * Retrieve the Render thread renderer
347 * @return The associated render thread renderer
349 Render::Renderer& GetRenderer();
352 * Query whether the renderer is fully opaque, fully transparent or transparent.
353 * @param[in] updateBufferIndex The current update buffer index.
354 * @return OPAQUE if fully opaque, TRANSPARENT if fully transparent and TRANSLUCENT if in between
356 OpacityType GetOpacityType( BufferIndex updateBufferIndex, const Node& node ) const;
359 * Called by the TextureSet to notify to the renderer that it has changed
361 void TextureSetChanged();
364 * Called by the TextureSet to notify to the renderer that it is about to be deleted
366 void TextureSetDeleted();
369 * Connect the object to the scene graph
371 * @param[in] sceneController The scene controller - used for sending messages to render thread
372 * @param[in] bufferIndex The current buffer index - used for sending messages to render thread
374 void ConnectToSceneGraph( SceneController& sceneController, BufferIndex bufferIndex );
377 * Disconnect the object from the scene graph
378 * @param[in] sceneController The scene controller - used for sending messages to render thread
379 * @param[in] bufferIndex The current buffer index - used for sending messages to render thread
381 void DisconnectFromSceneGraph( SceneController& sceneController, BufferIndex bufferIndex );
383 public: // Implementation of ConnectionChangePropagator
385 * @copydoc ConnectionChangePropagator::AddObserver
387 void AddConnectionObserver(ConnectionChangePropagator::Observer& observer){};
390 * @copydoc ConnectionChangePropagator::RemoveObserver
392 void RemoveConnectionObserver(ConnectionChangePropagator::Observer& observer){};
394 public: // UniformMap::Observer
396 * @copydoc UniformMap::Observer::UniformMappingsChanged
398 virtual void UniformMappingsChanged( const UniformMap& mappings );
400 public: // ConnectionChangePropagator::Observer
403 * @copydoc ConnectionChangePropagator::ConnectionsChanged
405 virtual void ConnectionsChanged( PropertyOwner& owner );
408 * @copydoc ConnectionChangePropagator::ConnectedUniformMapChanged
410 virtual void ConnectedUniformMapChanged( );
413 * @copydoc ConnectionChangePropagator::ConnectedUniformMapChanged
415 virtual void ObservedObjectDestroyed(PropertyOwner& owner);
417 public: // PropertyOwner implementation
419 * @copydoc Dali::Internal::SceneGraph::PropertyOwner::ResetDefaultProperties()
421 virtual void ResetDefaultProperties( BufferIndex updateBufferIndex ){};
423 public: // From UniformMapDataProvider
426 * @copydoc UniformMapDataProvider::GetUniformMapChanged
428 virtual bool GetUniformMapChanged( BufferIndex bufferIndex ) const{ return mUniformMapChanged[bufferIndex];}
431 * @copydoc UniformMapDataProvider::GetUniformMap
433 virtual const CollectedUniformMap& GetUniformMap( BufferIndex bufferIndex ) const;
438 * Protected constructor; See also Renderer::New()
443 * Update texture set to the render data provider
445 void UpdateTextureSet();
449 CollectedUniformMap mCollectedUniformMap[2]; ///< Uniform maps collected by the renderer
451 SceneController* mSceneController; ///< Used for initializing renderers
452 Render::Renderer* mRenderer; ///< Raw pointer to the renderer (that's owned by RenderManager)
453 TextureSet* mTextureSet; ///< The texture set this renderer uses. (Not owned)
454 Render::Geometry* mGeometry; ///< The geometry this renderer uses. (Not owned)
455 Shader* mShader; ///< The shader this renderer uses. (Not owned)
456 RenderDataProvider* mRenderDataProvider; ///< The render data provider
457 OwnerPointer< Vector4 > mBlendColor; ///< The blend color for blending operation
459 Dali::Internal::Render::Renderer::StencilParameters mStencilParameters; ///< Struct containing all stencil related options
461 uint32_t mIndexedDrawFirstElement; ///< first element index to be drawn using indexed draw
462 uint32_t mIndexedDrawElementsCount; ///< number of elements to be drawn using indexed draw
463 uint32_t mBlendBitmask; ///< The bitmask of blending options
464 uint32_t mRegenerateUniformMap; ///< 2 if the map should be regenerated, 1 if it should be copied.
465 uint32_t mResendFlag; ///< Indicate whether data should be resent to the renderer
467 DepthFunction::Type mDepthFunction:4; ///< Local copy of the depth function
468 FaceCullingMode::Type mFaceCullingMode:3; ///< Local copy of the mode of face culling
469 BlendMode::Type mBlendMode:3; ///< Local copy of the mode of blending
470 DepthWriteMode::Type mDepthWriteMode:3; ///< Local copy of the depth write mode
471 DepthTestMode::Type mDepthTestMode:3; ///< Local copy of the depth test mode
472 DevelRenderer::Rendering::Type mRenderingBehavior:2; ///< The rendering behavior
474 bool mUniformMapChanged[2]; ///< Records if the uniform map has been altered this frame
475 bool mPremultipledAlphaEnabled:1; ///< Flag indicating whether the Pre-multiplied Alpha Blending is required
479 AnimatableProperty< float > mOpacity; ///< The opacity value
480 int32_t mDepthIndex; ///< Used only in PrepareRenderInstructions
486 inline void SetTexturesMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, const TextureSet& textureSet )
488 typedef MessageValue1< Renderer, TextureSet* > LocalType;
490 // Reserve some memory inside the message queue
491 uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
493 // Construct message in the message queue memory; note that delete should not be called on the return value
494 new (slot) LocalType( &renderer, &Renderer::SetTextures, const_cast<TextureSet*>(&textureSet) );
497 inline void SetGeometryMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, const Render::Geometry& geometry )
499 typedef MessageValue1< Renderer, Render::Geometry* > LocalType;
501 // Reserve some memory inside the message queue
502 uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
504 // Construct message in the message queue memory; note that delete should not be called on the return value
505 new (slot) LocalType( &renderer, &Renderer::SetGeometry, const_cast<Render::Geometry*>(&geometry) );
508 inline void SetShaderMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, const Shader& shader )
510 typedef MessageValue1< Renderer, Shader* > LocalType;
512 // Reserve some memory inside the message queue
513 uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
515 // Construct message in the message queue memory; note that delete should not be called on the return value
516 new (slot) LocalType( &renderer, &Renderer::SetShader, const_cast<Shader*>( &shader ) );
519 inline void SetDepthIndexMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, int depthIndex )
521 typedef MessageValue1< Renderer, int > LocalType;
523 // Reserve some memory inside the message queue
524 uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
526 // Construct message in the message queue memory; note that delete should not be called on the return value
527 new (slot) LocalType( &renderer, &Renderer::SetDepthIndex, depthIndex );
530 inline void SetFaceCullingModeMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, FaceCullingMode::Type faceCullingMode )
532 typedef MessageValue1< Renderer, FaceCullingMode::Type > LocalType;
534 // Reserve some memory inside the message queue
535 uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
537 new (slot) LocalType( &renderer, &Renderer::SetFaceCullingMode, faceCullingMode );
540 inline void SetBlendModeMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, BlendMode::Type blendingMode )
542 typedef MessageValue1< Renderer, BlendMode::Type > LocalType;
544 // Reserve some memory inside the message queue
545 uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
547 new (slot) LocalType( &renderer, &Renderer::SetBlendMode, blendingMode );
550 inline void SetBlendingOptionsMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, uint32_t options )
552 typedef MessageValue1< Renderer, uint32_t > LocalType;
554 // Reserve some memory inside the message queue
555 uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
557 new (slot) LocalType( &renderer, &Renderer::SetBlendingOptions, options );
560 inline void SetBlendColorMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, const Vector4& blendColor )
562 typedef MessageValue1< Renderer, Vector4 > LocalType;
564 // Reserve some memory inside the message queue
565 uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
567 new (slot) LocalType( &renderer, &Renderer::SetBlendColor, blendColor );
570 inline void SetIndexedDrawFirstElementMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, uint32_t firstElement )
572 typedef MessageValue1< Renderer, uint32_t > LocalType;
574 // Reserve some memory inside the message queue
575 uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
577 new (slot) LocalType( &renderer, &Renderer::SetIndexedDrawFirstElement, firstElement );
580 inline void SetIndexedDrawElementsCountMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, uint32_t elementsCount )
582 typedef MessageValue1< Renderer, uint32_t > LocalType;
584 // Reserve some memory inside the message queue
585 uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
587 new (slot) LocalType( &renderer, &Renderer::SetIndexedDrawElementsCount, elementsCount );
590 inline void SetEnablePreMultipliedAlphaMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, bool preMultiplied )
592 typedef MessageValue1< Renderer, bool > LocalType;
594 // Reserve some memory inside the message queue
595 uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
597 new (slot) LocalType( &renderer, &Renderer::EnablePreMultipliedAlpha, preMultiplied );
600 inline void SetDepthWriteModeMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, DepthWriteMode::Type depthWriteMode )
602 typedef MessageValue1< Renderer, DepthWriteMode::Type > LocalType;
604 // Reserve some memory inside the message queue
605 uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
607 new (slot) LocalType( &renderer, &Renderer::SetDepthWriteMode, depthWriteMode );
610 inline void SetDepthTestModeMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, DepthTestMode::Type depthTestMode )
612 typedef MessageValue1< Renderer, DepthTestMode::Type > LocalType;
614 // Reserve some memory inside the message queue
615 uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
617 new (slot) LocalType( &renderer, &Renderer::SetDepthTestMode, depthTestMode );
620 inline void SetDepthFunctionMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, DepthFunction::Type depthFunction )
622 typedef MessageValue1< Renderer, DepthFunction::Type > LocalType;
624 // Reserve some memory inside the message queue
625 uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
627 new (slot) LocalType( &renderer, &Renderer::SetDepthFunction, depthFunction );
630 inline void SetRenderModeMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, RenderMode::Type mode )
632 typedef MessageValue1< Renderer, RenderMode::Type > LocalType;
634 // Reserve some memory inside the message queue
635 uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
637 new (slot) LocalType( &renderer, &Renderer::SetRenderMode, mode );
640 inline void SetStencilFunctionMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, StencilFunction::Type stencilFunction )
642 typedef MessageValue1< Renderer, StencilFunction::Type > LocalType;
644 // Reserve some memory inside the message queue
645 uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
647 new (slot) LocalType( &renderer, &Renderer::SetStencilFunction, stencilFunction );
650 inline void SetStencilFunctionMaskMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, int mask )
652 typedef MessageValue1< Renderer, int > LocalType;
654 // Reserve some memory inside the message queue
655 uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
657 new (slot) LocalType( &renderer, &Renderer::SetStencilFunctionMask, mask );
660 inline void SetStencilFunctionReferenceMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, int stencilFunctionReference )
662 typedef MessageValue1< Renderer, int > LocalType;
664 // Reserve some memory inside the message queue
665 uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
667 new (slot) LocalType( &renderer, &Renderer::SetStencilFunctionReference, stencilFunctionReference );
670 inline void SetStencilMaskMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, int stencilMask )
672 typedef MessageValue1< Renderer, int > LocalType;
674 // Reserve some memory inside the message queue
675 uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
677 new (slot) LocalType( &renderer, &Renderer::SetStencilMask, stencilMask );
680 inline void SetStencilOperationOnFailMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, StencilOperation::Type stencilOperation )
682 typedef MessageValue1< Renderer, StencilOperation::Type > LocalType;
684 // Reserve some memory inside the message queue
685 uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
687 new (slot) LocalType( &renderer, &Renderer::SetStencilOperationOnFail, stencilOperation );
690 inline void SetStencilOperationOnZFailMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, StencilOperation::Type stencilOperation )
692 typedef MessageValue1< Renderer, StencilOperation::Type > LocalType;
694 // Reserve some memory inside the message queue
695 uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
697 new (slot) LocalType( &renderer, &Renderer::SetStencilOperationOnZFail, stencilOperation );
700 inline void SetStencilOperationOnZPassMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, StencilOperation::Type stencilOperation )
702 typedef MessageValue1< Renderer, StencilOperation::Type > LocalType;
704 // Reserve some memory inside the message queue
705 uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
707 new (slot) LocalType( &renderer, &Renderer::SetStencilOperationOnZPass, stencilOperation );
710 inline void BakeOpacityMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, float opacity )
712 typedef MessageDoubleBuffered1< Renderer, float > LocalType;
714 // Reserve some memory inside the message queue
715 uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
717 new (slot) LocalType( &renderer, &Renderer::BakeOpacity, opacity );
720 inline void SetRenderingBehaviorMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, DevelRenderer::Rendering::Type renderingBehavior )
722 using LocalType = MessageValue1< Renderer, DevelRenderer::Rendering::Type >;
724 // Reserve some memory inside the message queue
725 uint32_t* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
727 new (slot) LocalType( &renderer, &Renderer::SetRenderingBehavior, renderingBehavior );
730 } // namespace SceneGraph
731 } // namespace Internal
734 #endif // DALI_INTERNAL_SCENE_GRAPH_RENDERER_H