1 #ifndef DALI_INTERNAL_SCENE_GRAPH_RENDERER_H
2 #define DALI_INTERNAL_SCENE_GRAPH_RENDERER_H
5 * Copyright (c) 2016 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 );
93 * Set the shader for the renderer
94 * @param[in] shader The shader this renderer will use
96 void SetShader( Shader* shader );
99 * Get the shader used by this renderer
100 * @return the shader this renderer uses
108 * Set the geometry for the renderer
109 * @param[in] geometry The geometry this renderer will use
111 void SetGeometry( Render::Geometry* geometry );
114 * Set the depth index
115 * @param[in] depthIndex the new depth index to use
117 void SetDepthIndex( int depthIndex );
120 * @brief Get the depth index
121 * @return The depth index
123 int GetDepthIndex() const
129 * Set the face culling mode
130 * @param[in] faceCullingMode to use
132 void SetFaceCullingMode( FaceCullingMode::Type faceCullingMode );
135 * Set the blending mode
136 * @param[in] blendingMode to use
138 void SetBlendMode( BlendMode::Type blendingMode );
141 * Set the blending options. This should only be called from the update thread.
142 * @param[in] options A bitmask of blending options.
144 void SetBlendingOptions( unsigned int options );
147 * Set the blend color for blending operation
148 * @param blendColor to pass to GL
150 void SetBlendColor( const Vector4& blendColor );
153 * Set the index of first element for indexed draw
154 * @param[in] firstElement index of first element to draw
156 void SetIndexedDrawFirstElement( size_t firstElement );
159 * Set the number of elements to draw by indexed draw
160 * @param[in] elementsCount number of elements to draw
162 void SetIndexedDrawElementsCount( size_t elementsCount );
165 * @brief Set whether the Pre-multiplied Alpha Blending is required
166 * @param[in] preMultipled whether alpha is pre-multiplied.
168 void EnablePreMultipliedAlpha( bool preMultipled );
171 * Sets the depth buffer write mode
172 * @param[in] depthWriteMode The depth buffer write mode
174 void SetDepthWriteMode( DepthWriteMode::Type depthWriteMode );
177 * Sets the depth buffer test mode
178 * @param[in] depthTestMode The depth buffer test mode
180 void SetDepthTestMode( DepthTestMode::Type depthTestMode );
183 * Sets the depth function
184 * @param[in] depthFunction The depth function
186 void SetDepthFunction( DepthFunction::Type depthFunction );
189 * Sets the render mode
190 * @param[in] mode The render mode
192 void SetRenderMode( RenderMode::Type mode );
195 * Sets the stencil function
196 * @param[in] stencilFunction The stencil function
198 void SetStencilFunction( StencilFunction::Type stencilFunction );
201 * Sets the stencil function mask
202 * @param[in] stencilFunctionMask The stencil function mask
204 void SetStencilFunctionMask( int stencilFunctionMask );
207 * Sets the stencil function reference
208 * @param[in] stencilFunctionReference The stencil function reference
210 void SetStencilFunctionReference( int stencilFunctionReference );
213 * Sets the stencil mask
214 * @param[in] stencilMask The stencil mask
216 void SetStencilMask( int stencilMask );
219 * Sets the stencil operation for when the stencil test fails
220 * @param[in] stencilOperationOnFail The stencil operation
222 void SetStencilOperationOnFail( StencilOperation::Type stencilOperationOnFail );
225 * Sets the stencil operation for when the depth test fails
226 * @param[in] stencilOperationOnZFail The stencil operation
228 void SetStencilOperationOnZFail( StencilOperation::Type stencilOperationOnZFail );
231 * Sets the stencil operation for when the depth test passes
232 * @param[in] stencilOperationOnZPass The stencil operation
234 void SetStencilOperationOnZPass( StencilOperation::Type stencilOperationOnZPass );
237 * Prepare the object for rendering.
238 * This is called by the UpdateManager when an object is due to be rendered in the current frame.
239 * @param[in] updateBufferIndex The current update buffer index.
241 void PrepareRender( BufferIndex updateBufferIndex );
244 * Retrieve the Render thread renderer
245 * @return The associated render thread renderer
247 Render::Renderer& GetRenderer();
250 * Check whether the renderer has been marked as ready to render
251 * ready means that renderer has all resources and should produce correct result
252 * complete means all resources have finished loading
253 * It's possible that renderer is complete but not ready,
254 * for example in case of resource load failed
255 * @param[out] ready TRUE if the renderer has resources to render
256 * @param[out] complete TRUE if the renderer resources are complete
258 void GetReadyAndComplete( bool& ready, bool& complete ) const;
261 * Query whether the renderer is fully opaque, fully transparent or transparent.
262 * @param[in] updateBufferIndex The current update buffer index.
263 * @return OPAQUE if fully opaque, TRANSPARENT if fully transparent and TRANSLUCENT if in between
265 Opacity GetOpacity( BufferIndex updateBufferIndex, const Node& node ) const;
268 * Called by the TextureSet to notify to the renderer that it has changed
270 void TextureSetChanged();
272 public: // Implementation of ObjectOwnerContainer template methods
274 * Connect the object to the scene graph
276 * @param[in] sceneController The scene controller - used for sending messages to render thread
277 * @param[in] bufferIndex The current buffer index - used for sending messages to render thread
279 void ConnectToSceneGraph( SceneController& sceneController, BufferIndex bufferIndex );
282 * Disconnect the object from the scene graph
283 * @param[in] sceneController The scene controller - used for sending messages to render thread
284 * @param[in] bufferIndex The current buffer index - used for sending messages to render thread
286 void DisconnectFromSceneGraph( SceneController& sceneController, BufferIndex bufferIndex );
288 public: // Implementation of ConnectionChangePropagator
290 * @copydoc ConnectionChangePropagator::AddObserver
292 void AddConnectionObserver(ConnectionChangePropagator::Observer& observer){};
295 * @copydoc ConnectionChangePropagator::RemoveObserver
297 void RemoveConnectionObserver(ConnectionChangePropagator::Observer& observer){};
302 public: // UniformMap::Observer
304 * @copydoc UniformMap::Observer::UniformMappingsChanged
306 virtual void UniformMappingsChanged( const UniformMap& mappings );
308 public: // ConnectionChangePropagator::Observer
311 * @copydoc ConnectionChangePropagator::ConnectionsChanged
313 virtual void ConnectionsChanged( PropertyOwner& owner );
316 * @copydoc ConnectionChangePropagator::ConnectedUniformMapChanged
318 virtual void ConnectedUniformMapChanged( );
321 * @copydoc ConnectionChangePropagator::ConnectedUniformMapChanged
323 virtual void ObservedObjectDestroyed(PropertyOwner& owner);
325 public: // PropertyOwner implementation
327 * @copydoc Dali::Internal::SceneGraph::PropertyOwner::ResetDefaultProperties()
329 virtual void ResetDefaultProperties( BufferIndex updateBufferIndex ){};
331 public: // From UniformMapDataProvider
334 * @copydoc UniformMapDataProvider::GetUniformMapChanged
336 virtual bool GetUniformMapChanged( BufferIndex bufferIndex ) const{ return mUniformMapChanged[bufferIndex];}
339 * @copydoc UniformMapDataProvider::GetUniformMap
341 virtual const CollectedUniformMap& GetUniformMap( BufferIndex bufferIndex ) const;
346 * Protected constructor; See also Renderer::New()
351 * Helper function to create a new render data provider
352 * @return the new (initialized) data provider
354 RenderDataProvider* NewRenderDataProvider();
358 CollectedUniformMap mCollectedUniformMap[2]; ///< Uniform maps collected by the renderer
359 SceneController* mSceneController; ///< Used for initializing renderers
360 Render::Renderer* mRenderer; ///< Raw pointer to the renderer (that's owned by RenderManager)
361 TextureSet* mTextureSet; ///< The texture set this renderer uses. (Not owned)
362 Render::Geometry* mGeometry; ///< The geometry this renderer uses. (Not owned)
363 Shader* mShader; ///< The shader this renderer uses. (Not owned)
364 Vector4* mBlendColor; ///< The blend color for blending operation
366 Dali::Internal::Render::Renderer::StencilParameters mStencilParameters; ///< Struct containing all stencil related options
368 size_t mIndexedDrawFirstElement; ///< first element index to be drawn using indexed draw
369 size_t mIndexedDrawElementsCount; ///< number of elements to be drawn using indexed draw
370 unsigned int mBlendBitmask; ///< The bitmask of blending options
371 unsigned int mRegenerateUniformMap; ///< 2 if the map should be regenerated, 1 if it should be copied.
372 unsigned int mResendFlag; ///< Indicate whether data should be resent to the renderer
374 DepthFunction::Type mDepthFunction:3; ///< Local copy of the depth function
375 FaceCullingMode::Type mFaceCullingMode:2; ///< Local copy of the mode of face culling
376 BlendMode::Type mBlendMode:2; ///< Local copy of the mode of blending
377 DepthWriteMode::Type mDepthWriteMode:2; ///< Local copy of the depth write mode
378 DepthTestMode::Type mDepthTestMode:2; ///< Local copy of the depth test mode
380 bool mUniformMapChanged[2]; ///< Records if the uniform map has been altered this frame
381 bool mResourcesReady; ///< Set during the Update algorithm; true if the renderer has resources ready for the current frame.
382 bool mFinishedResourceAcquisition; ///< Set during DoPrepareResources; true if ready & all resource acquisition has finished (successfully or otherwise)
383 bool mPremultipledAlphaEnabled:1; ///< Flag indicating whether the Pre-multiplied Alpha Blending is required
387 int mDepthIndex; ///< Used only in PrepareRenderInstructions
392 inline void SetTexturesMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, const TextureSet& textureSet )
394 typedef MessageValue1< Renderer, TextureSet* > LocalType;
396 // Reserve some memory inside the message queue
397 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
399 // Construct message in the message queue memory; note that delete should not be called on the return value
400 new (slot) LocalType( &renderer, &Renderer::SetTextures, const_cast<TextureSet*>(&textureSet) );
403 inline void SetGeometryMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, const Render::Geometry& geometry )
405 typedef MessageValue1< Renderer, Render::Geometry* > LocalType;
407 // Reserve some memory inside the message queue
408 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
410 // Construct message in the message queue memory; note that delete should not be called on the return value
411 new (slot) LocalType( &renderer, &Renderer::SetGeometry, const_cast<Render::Geometry*>(&geometry) );
414 inline void SetShaderMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, Shader& shader )
416 typedef MessageValue1< Renderer, Shader* > LocalType;
418 // Reserve some memory inside the message queue
419 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
421 // Construct message in the message queue memory; note that delete should not be called on the return value
422 new (slot) LocalType( &renderer, &Renderer::SetShader, &shader );
425 inline void SetDepthIndexMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, int depthIndex )
427 typedef MessageValue1< Renderer, int > LocalType;
429 // Reserve some memory inside the message queue
430 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
432 // Construct message in the message queue memory; note that delete should not be called on the return value
433 new (slot) LocalType( &renderer, &Renderer::SetDepthIndex, depthIndex );
436 inline void SetFaceCullingModeMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, FaceCullingMode::Type faceCullingMode )
438 typedef MessageValue1< Renderer, FaceCullingMode::Type > LocalType;
440 // Reserve some memory inside the message queue
441 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
443 new (slot) LocalType( &renderer, &Renderer::SetFaceCullingMode, faceCullingMode );
446 inline void SetBlendModeMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, BlendMode::Type blendingMode )
448 typedef MessageValue1< Renderer, BlendMode::Type > LocalType;
450 // Reserve some memory inside the message queue
451 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
453 new (slot) LocalType( &renderer, &Renderer::SetBlendMode, blendingMode );
456 inline void SetBlendingOptionsMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, unsigned int options )
458 typedef MessageValue1< Renderer, unsigned int > LocalType;
460 // Reserve some memory inside the message queue
461 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
463 new (slot) LocalType( &renderer, &Renderer::SetBlendingOptions, options );
466 inline void SetBlendColorMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, const Vector4& blendColor )
468 typedef MessageValue1< Renderer, Vector4 > LocalType;
470 // Reserve some memory inside the message queue
471 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
473 new (slot) LocalType( &renderer, &Renderer::SetBlendColor, blendColor );
476 inline void SetIndexedDrawFirstElementMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, size_t firstElement )
478 typedef MessageValue1< Renderer, size_t > LocalType;
480 // Reserve some memory inside the message queue
481 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
483 new (slot) LocalType( &renderer, &Renderer::SetIndexedDrawFirstElement, firstElement );
486 inline void SetIndexedDrawElementsCountMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, size_t elementsCount )
488 typedef MessageValue1< Renderer, size_t > LocalType;
490 // Reserve some memory inside the message queue
491 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
493 new (slot) LocalType( &renderer, &Renderer::SetIndexedDrawElementsCount, elementsCount );
496 inline void SetEnablePreMultipliedAlphaMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, bool preMultiplied )
498 typedef MessageValue1< Renderer, bool > LocalType;
500 // Reserve some memory inside the message queue
501 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
503 new (slot) LocalType( &renderer, &Renderer::EnablePreMultipliedAlpha, preMultiplied );
506 inline void SetDepthWriteModeMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, DepthWriteMode::Type depthWriteMode )
508 typedef MessageValue1< Renderer, DepthWriteMode::Type > LocalType;
510 // Reserve some memory inside the message queue
511 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
513 new (slot) LocalType( &renderer, &Renderer::SetDepthWriteMode, depthWriteMode );
516 inline void SetDepthTestModeMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, DepthTestMode::Type depthTestMode )
518 typedef MessageValue1< Renderer, DepthTestMode::Type > LocalType;
520 // Reserve some memory inside the message queue
521 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
523 new (slot) LocalType( &renderer, &Renderer::SetDepthTestMode, depthTestMode );
526 inline void SetDepthFunctionMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, DepthFunction::Type depthFunction )
528 typedef MessageValue1< Renderer, DepthFunction::Type > LocalType;
530 // Reserve some memory inside the message queue
531 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
533 new (slot) LocalType( &renderer, &Renderer::SetDepthFunction, depthFunction );
536 inline void SetRenderModeMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, RenderMode::Type mode )
538 typedef MessageValue1< Renderer, RenderMode::Type > LocalType;
540 // Reserve some memory inside the message queue
541 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
543 new (slot) LocalType( &renderer, &Renderer::SetRenderMode, mode );
546 inline void SetStencilFunctionMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, StencilFunction::Type stencilFunction )
548 typedef MessageValue1< Renderer, StencilFunction::Type > LocalType;
550 // Reserve some memory inside the message queue
551 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
553 new (slot) LocalType( &renderer, &Renderer::SetStencilFunction, stencilFunction );
556 inline void SetStencilFunctionMaskMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, int mask )
558 typedef MessageValue1< Renderer, int > LocalType;
560 // Reserve some memory inside the message queue
561 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
563 new (slot) LocalType( &renderer, &Renderer::SetStencilFunctionMask, mask );
566 inline void SetStencilFunctionReferenceMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, int stencilFunctionReference )
568 typedef MessageValue1< Renderer, int > LocalType;
570 // Reserve some memory inside the message queue
571 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
573 new (slot) LocalType( &renderer, &Renderer::SetStencilFunctionReference, stencilFunctionReference );
576 inline void SetStencilMaskMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, int stencilMask )
578 typedef MessageValue1< Renderer, int > LocalType;
580 // Reserve some memory inside the message queue
581 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
583 new (slot) LocalType( &renderer, &Renderer::SetStencilMask, stencilMask );
586 inline void SetStencilOperationOnFailMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, StencilOperation::Type stencilOperation )
588 typedef MessageValue1< Renderer, StencilOperation::Type > LocalType;
590 // Reserve some memory inside the message queue
591 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
593 new (slot) LocalType( &renderer, &Renderer::SetStencilOperationOnFail, stencilOperation );
596 inline void SetStencilOperationOnZFailMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, StencilOperation::Type stencilOperation )
598 typedef MessageValue1< Renderer, StencilOperation::Type > LocalType;
600 // Reserve some memory inside the message queue
601 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
603 new (slot) LocalType( &renderer, &Renderer::SetStencilOperationOnZFail, stencilOperation );
606 inline void SetStencilOperationOnZPassMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, StencilOperation::Type stencilOperation )
608 typedef MessageValue1< Renderer, StencilOperation::Type > LocalType;
610 // Reserve some memory inside the message queue
611 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
613 new (slot) LocalType( &renderer, &Renderer::SetStencilOperationOnZPass, stencilOperation );
617 } // namespace SceneGraph
618 } // namespace Internal
621 #endif // DALI_INTERNAL_SCENE_GRAPH_RENDERER_H