1 #ifndef DALI_INTERNAL_SCENE_GRAPH_RENDERER_H
2 #define DALI_INTERNAL_SCENE_GRAPH_RENDERER_H
5 * Copyright (c) 2017 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/internal/common/blending-options.h>
23 #include <dali/internal/common/type-abstraction-enums.h>
24 #include <dali/internal/event/common/event-thread-services.h>
25 #include <dali/internal/update/common/property-owner.h>
26 #include <dali/internal/update/common/uniform-map.h>
27 #include <dali/internal/update/common/scene-graph-connection-change-propagator.h>
28 #include <dali/internal/render/data-providers/render-data-provider.h>
29 #include <dali/internal/render/renderers/render-renderer.h>
45 class SceneController;
48 typedef Dali::Vector< Renderer* > RendererContainer;
49 typedef RendererContainer::Iterator RendererIter;
50 typedef RendererContainer::ConstIterator RendererConstIter;
55 class Renderer : public PropertyOwner,
56 public UniformMapDataProvider,
57 public UniformMap::Observer,
58 public ConnectionChangePropagator::Observer
70 * Construct a new Renderer
72 static Renderer* New();
80 * Overriden delete operator
81 * Deletes the renderer from its global memory pool
83 void operator delete( void* ptr );
86 * Set the texture set for the renderer
87 * @param[in] textureSet The texture set this renderer will use
89 void SetTextures( TextureSet* textureSet );
92 * Returns current texture set object
93 * @return Pointer to the texture set
95 const TextureSet* GetTextures() const
101 * Set the shader for the renderer
102 * @param[in] shader The shader this renderer will use
104 void SetShader( Shader* shader );
107 * Get the shader used by this renderer
108 * @return the shader this renderer uses
110 const Shader& GetShader() const
116 * Set the geometry for the renderer
117 * @param[in] geometry The geometry this renderer will use
119 void SetGeometry( Render::Geometry* geometry );
122 * Set the depth index
123 * @param[in] depthIndex the new depth index to use
125 void SetDepthIndex( int depthIndex );
128 * @brief Get the depth index
129 * @return The depth index
131 int GetDepthIndex() const
137 * Set the face culling mode
138 * @param[in] faceCullingMode to use
140 void SetFaceCullingMode( FaceCullingMode::Type faceCullingMode );
143 * Set the blending mode
144 * @param[in] blendingMode to use
146 void SetBlendMode( BlendMode::Type blendingMode );
149 * Set the blending options. This should only be called from the update thread.
150 * @param[in] options A bitmask of blending options.
152 void SetBlendingOptions( unsigned int options );
155 * Set the blend color for blending operation
156 * @param blendColor to pass to GL
158 void SetBlendColor( const Vector4& blendColor );
161 * Set the index of first element for indexed draw
162 * @param[in] firstElement index of first element to draw
164 void SetIndexedDrawFirstElement( size_t firstElement );
167 * Set the number of elements to draw by indexed draw
168 * @param[in] elementsCount number of elements to draw
170 void SetIndexedDrawElementsCount( size_t elementsCount );
173 * @brief Set whether the Pre-multiplied Alpha Blending is required
174 * @param[in] preMultipled whether alpha is pre-multiplied.
176 void EnablePreMultipliedAlpha( bool preMultipled );
179 * Sets the depth buffer write mode
180 * @param[in] depthWriteMode The depth buffer write mode
182 void SetDepthWriteMode( DepthWriteMode::Type depthWriteMode );
185 * Sets the depth buffer test mode
186 * @param[in] depthTestMode The depth buffer test mode
188 void SetDepthTestMode( DepthTestMode::Type depthTestMode );
191 * Sets the depth function
192 * @param[in] depthFunction The depth function
194 void SetDepthFunction( DepthFunction::Type depthFunction );
197 * Sets the render mode
198 * @param[in] mode The render mode
200 void SetRenderMode( RenderMode::Type mode );
203 * Sets the stencil function
204 * @param[in] stencilFunction The stencil function
206 void SetStencilFunction( StencilFunction::Type stencilFunction );
209 * Sets the stencil function mask
210 * @param[in] stencilFunctionMask The stencil function mask
212 void SetStencilFunctionMask( int stencilFunctionMask );
215 * Sets the stencil function reference
216 * @param[in] stencilFunctionReference The stencil function reference
218 void SetStencilFunctionReference( int stencilFunctionReference );
221 * Sets the stencil mask
222 * @param[in] stencilMask The stencil mask
224 void SetStencilMask( int stencilMask );
227 * Sets the stencil operation for when the stencil test fails
228 * @param[in] stencilOperationOnFail The stencil operation
230 void SetStencilOperationOnFail( StencilOperation::Type stencilOperationOnFail );
233 * Sets the stencil operation for when the depth test fails
234 * @param[in] stencilOperationOnZFail The stencil operation
236 void SetStencilOperationOnZFail( StencilOperation::Type stencilOperationOnZFail );
239 * Sets the stencil operation for when the depth test passes
240 * @param[in] stencilOperationOnZPass The stencil operation
242 void SetStencilOperationOnZPass( StencilOperation::Type stencilOperationOnZPass );
245 * Prepare the object for rendering.
246 * This is called by the UpdateManager when an object is due to be rendered in the current frame.
247 * @param[in] updateBufferIndex The current update buffer index.
249 void PrepareRender( BufferIndex updateBufferIndex );
252 * Retrieve the Render thread renderer
253 * @return The associated render thread renderer
255 Render::Renderer& GetRenderer();
258 * Check whether the renderer has been marked as ready to render
259 * ready means that renderer has all resources and should produce correct result
260 * complete means all resources have finished loading
261 * It's possible that renderer is complete but not ready,
262 * for example in case of resource load failed
263 * @param[out] ready TRUE if the renderer has resources to render
264 * @param[out] complete TRUE if the renderer resources are complete
266 void GetReadyAndComplete( bool& ready, bool& complete ) const;
269 * Query whether the renderer is fully opaque, fully transparent or transparent.
270 * @param[in] updateBufferIndex The current update buffer index.
271 * @return OPAQUE if fully opaque, TRANSPARENT if fully transparent and TRANSLUCENT if in between
273 Opacity GetOpacity( BufferIndex updateBufferIndex, const Node& node ) const;
276 * Called by the TextureSet to notify to the renderer that it has changed
278 void TextureSetChanged();
281 * Called by the TextureSet to notify to the renderer that it is about to be deleted
283 void TextureSetDeleted();
286 * Connect the object to the scene graph
288 * @param[in] sceneController The scene controller - used for sending messages to render thread
289 * @param[in] bufferIndex The current buffer index - used for sending messages to render thread
291 void ConnectToSceneGraph( SceneController& sceneController, BufferIndex bufferIndex );
294 * Disconnect the object from the scene graph
295 * @param[in] sceneController The scene controller - used for sending messages to render thread
296 * @param[in] bufferIndex The current buffer index - used for sending messages to render thread
298 void DisconnectFromSceneGraph( SceneController& sceneController, BufferIndex bufferIndex );
300 public: // Implementation of ConnectionChangePropagator
302 * @copydoc ConnectionChangePropagator::AddObserver
304 void AddConnectionObserver(ConnectionChangePropagator::Observer& observer){};
307 * @copydoc ConnectionChangePropagator::RemoveObserver
309 void RemoveConnectionObserver(ConnectionChangePropagator::Observer& observer){};
311 public: // UniformMap::Observer
313 * @copydoc UniformMap::Observer::UniformMappingsChanged
315 virtual void UniformMappingsChanged( const UniformMap& mappings );
317 public: // ConnectionChangePropagator::Observer
320 * @copydoc ConnectionChangePropagator::ConnectionsChanged
322 virtual void ConnectionsChanged( PropertyOwner& owner );
325 * @copydoc ConnectionChangePropagator::ConnectedUniformMapChanged
327 virtual void ConnectedUniformMapChanged( );
330 * @copydoc ConnectionChangePropagator::ConnectedUniformMapChanged
332 virtual void ObservedObjectDestroyed(PropertyOwner& owner);
334 public: // PropertyOwner implementation
336 * @copydoc Dali::Internal::SceneGraph::PropertyOwner::ResetDefaultProperties()
338 virtual void ResetDefaultProperties( BufferIndex updateBufferIndex ){};
340 public: // From UniformMapDataProvider
343 * @copydoc UniformMapDataProvider::GetUniformMapChanged
345 virtual bool GetUniformMapChanged( BufferIndex bufferIndex ) const{ return mUniformMapChanged[bufferIndex];}
348 * @copydoc UniformMapDataProvider::GetUniformMap
350 virtual const CollectedUniformMap& GetUniformMap( BufferIndex bufferIndex ) const;
355 * Protected constructor; See also Renderer::New()
360 * Helper function to create a new render data provider
361 * @return the new (initialized) data provider
363 RenderDataProvider* NewRenderDataProvider();
366 * Helper function to retrieve the blend color.
367 * @return The blend color.
369 const Vector4& GetBlendColor() const;
373 CollectedUniformMap mCollectedUniformMap[2]; ///< Uniform maps collected by the renderer
374 SceneController* mSceneController; ///< Used for initializing renderers
375 Render::Renderer* mRenderer; ///< Raw pointer to the renderer (that's owned by RenderManager)
376 TextureSet* mTextureSet; ///< The texture set this renderer uses. (Not owned)
377 Render::Geometry* mGeometry; ///< The geometry this renderer uses. (Not owned)
378 Shader* mShader; ///< The shader this renderer uses. (Not owned)
379 OwnerPointer< Vector4 > mBlendColor; ///< The blend color for blending operation
381 Dali::Internal::Render::Renderer::StencilParameters mStencilParameters; ///< Struct containing all stencil related options
383 size_t mIndexedDrawFirstElement; ///< first element index to be drawn using indexed draw
384 size_t mIndexedDrawElementsCount; ///< number of elements to be drawn using indexed draw
385 unsigned int mBlendBitmask; ///< The bitmask of blending options
386 unsigned int mRegenerateUniformMap; ///< 2 if the map should be regenerated, 1 if it should be copied.
387 unsigned int mResendFlag; ///< Indicate whether data should be resent to the renderer
389 DepthFunction::Type mDepthFunction:3; ///< Local copy of the depth function
390 FaceCullingMode::Type mFaceCullingMode:2; ///< Local copy of the mode of face culling
391 BlendMode::Type mBlendMode:2; ///< Local copy of the mode of blending
392 DepthWriteMode::Type mDepthWriteMode:2; ///< Local copy of the depth write mode
393 DepthTestMode::Type mDepthTestMode:2; ///< Local copy of the depth test mode
395 bool mUniformMapChanged[2]; ///< Records if the uniform map has been altered this frame
396 bool mResourcesReady; ///< Set during the Update algorithm; true if the renderer has resources ready for the current frame.
397 bool mFinishedResourceAcquisition; ///< Set during DoPrepareResources; true if ready & all resource acquisition has finished (successfully or otherwise)
398 bool mPremultipledAlphaEnabled:1; ///< Flag indicating whether the Pre-multiplied Alpha Blending is required
402 int mDepthIndex; ///< Used only in PrepareRenderInstructions
407 inline void SetTexturesMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, const TextureSet& textureSet )
409 typedef MessageValue1< Renderer, TextureSet* > LocalType;
411 // Reserve some memory inside the message queue
412 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
414 // Construct message in the message queue memory; note that delete should not be called on the return value
415 new (slot) LocalType( &renderer, &Renderer::SetTextures, const_cast<TextureSet*>(&textureSet) );
418 inline void SetGeometryMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, const Render::Geometry& geometry )
420 typedef MessageValue1< Renderer, Render::Geometry* > LocalType;
422 // Reserve some memory inside the message queue
423 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
425 // Construct message in the message queue memory; note that delete should not be called on the return value
426 new (slot) LocalType( &renderer, &Renderer::SetGeometry, const_cast<Render::Geometry*>(&geometry) );
429 inline void SetShaderMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, Shader& shader )
431 typedef MessageValue1< Renderer, Shader* > LocalType;
433 // Reserve some memory inside the message queue
434 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
436 // Construct message in the message queue memory; note that delete should not be called on the return value
437 new (slot) LocalType( &renderer, &Renderer::SetShader, &shader );
440 inline void SetDepthIndexMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, int depthIndex )
442 typedef MessageValue1< Renderer, int > LocalType;
444 // Reserve some memory inside the message queue
445 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
447 // Construct message in the message queue memory; note that delete should not be called on the return value
448 new (slot) LocalType( &renderer, &Renderer::SetDepthIndex, depthIndex );
451 inline void SetFaceCullingModeMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, FaceCullingMode::Type faceCullingMode )
453 typedef MessageValue1< Renderer, FaceCullingMode::Type > LocalType;
455 // Reserve some memory inside the message queue
456 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
458 new (slot) LocalType( &renderer, &Renderer::SetFaceCullingMode, faceCullingMode );
461 inline void SetBlendModeMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, BlendMode::Type blendingMode )
463 typedef MessageValue1< Renderer, BlendMode::Type > LocalType;
465 // Reserve some memory inside the message queue
466 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
468 new (slot) LocalType( &renderer, &Renderer::SetBlendMode, blendingMode );
471 inline void SetBlendingOptionsMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, unsigned int options )
473 typedef MessageValue1< Renderer, unsigned int > LocalType;
475 // Reserve some memory inside the message queue
476 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
478 new (slot) LocalType( &renderer, &Renderer::SetBlendingOptions, options );
481 inline void SetBlendColorMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, const Vector4& blendColor )
483 typedef MessageValue1< Renderer, Vector4 > LocalType;
485 // Reserve some memory inside the message queue
486 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
488 new (slot) LocalType( &renderer, &Renderer::SetBlendColor, blendColor );
491 inline void SetIndexedDrawFirstElementMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, size_t firstElement )
493 typedef MessageValue1< Renderer, size_t > LocalType;
495 // Reserve some memory inside the message queue
496 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
498 new (slot) LocalType( &renderer, &Renderer::SetIndexedDrawFirstElement, firstElement );
501 inline void SetIndexedDrawElementsCountMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, size_t elementsCount )
503 typedef MessageValue1< Renderer, size_t > LocalType;
505 // Reserve some memory inside the message queue
506 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
508 new (slot) LocalType( &renderer, &Renderer::SetIndexedDrawElementsCount, elementsCount );
511 inline void SetEnablePreMultipliedAlphaMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, bool preMultiplied )
513 typedef MessageValue1< Renderer, bool > LocalType;
515 // Reserve some memory inside the message queue
516 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
518 new (slot) LocalType( &renderer, &Renderer::EnablePreMultipliedAlpha, preMultiplied );
521 inline void SetDepthWriteModeMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, DepthWriteMode::Type depthWriteMode )
523 typedef MessageValue1< Renderer, DepthWriteMode::Type > LocalType;
525 // Reserve some memory inside the message queue
526 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
528 new (slot) LocalType( &renderer, &Renderer::SetDepthWriteMode, depthWriteMode );
531 inline void SetDepthTestModeMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, DepthTestMode::Type depthTestMode )
533 typedef MessageValue1< Renderer, DepthTestMode::Type > LocalType;
535 // Reserve some memory inside the message queue
536 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
538 new (slot) LocalType( &renderer, &Renderer::SetDepthTestMode, depthTestMode );
541 inline void SetDepthFunctionMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, DepthFunction::Type depthFunction )
543 typedef MessageValue1< Renderer, DepthFunction::Type > LocalType;
545 // Reserve some memory inside the message queue
546 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
548 new (slot) LocalType( &renderer, &Renderer::SetDepthFunction, depthFunction );
551 inline void SetRenderModeMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, RenderMode::Type mode )
553 typedef MessageValue1< Renderer, RenderMode::Type > LocalType;
555 // Reserve some memory inside the message queue
556 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
558 new (slot) LocalType( &renderer, &Renderer::SetRenderMode, mode );
561 inline void SetStencilFunctionMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, StencilFunction::Type stencilFunction )
563 typedef MessageValue1< Renderer, StencilFunction::Type > LocalType;
565 // Reserve some memory inside the message queue
566 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
568 new (slot) LocalType( &renderer, &Renderer::SetStencilFunction, stencilFunction );
571 inline void SetStencilFunctionMaskMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, int mask )
573 typedef MessageValue1< Renderer, int > LocalType;
575 // Reserve some memory inside the message queue
576 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
578 new (slot) LocalType( &renderer, &Renderer::SetStencilFunctionMask, mask );
581 inline void SetStencilFunctionReferenceMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, int stencilFunctionReference )
583 typedef MessageValue1< Renderer, int > LocalType;
585 // Reserve some memory inside the message queue
586 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
588 new (slot) LocalType( &renderer, &Renderer::SetStencilFunctionReference, stencilFunctionReference );
591 inline void SetStencilMaskMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, int stencilMask )
593 typedef MessageValue1< Renderer, int > LocalType;
595 // Reserve some memory inside the message queue
596 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
598 new (slot) LocalType( &renderer, &Renderer::SetStencilMask, stencilMask );
601 inline void SetStencilOperationOnFailMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, StencilOperation::Type stencilOperation )
603 typedef MessageValue1< Renderer, StencilOperation::Type > LocalType;
605 // Reserve some memory inside the message queue
606 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
608 new (slot) LocalType( &renderer, &Renderer::SetStencilOperationOnFail, stencilOperation );
611 inline void SetStencilOperationOnZFailMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, StencilOperation::Type stencilOperation )
613 typedef MessageValue1< Renderer, StencilOperation::Type > LocalType;
615 // Reserve some memory inside the message queue
616 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
618 new (slot) LocalType( &renderer, &Renderer::SetStencilOperationOnZFail, stencilOperation );
621 inline void SetStencilOperationOnZPassMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, StencilOperation::Type stencilOperation )
623 typedef MessageValue1< Renderer, StencilOperation::Type > LocalType;
625 // Reserve some memory inside the message queue
626 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
628 new (slot) LocalType( &renderer, &Renderer::SetStencilOperationOnZPass, stencilOperation );
631 } // namespace SceneGraph
632 } // namespace Internal
635 #endif // DALI_INTERNAL_SCENE_GRAPH_RENDERER_H