1 #ifndef DALI_INTERNAL_SCENE_GRAPH_RENDERER2_H
2 #define DALI_INTERNAL_SCENE_GRAPH_RENDERER2_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.
21 #include <dali/public-api/rendering/geometry.h>
22 #include <dali/public-api/rendering/renderer.h> // Dali::Renderer
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/render/data-providers/render-data-provider.h>
44 class SceneController;
47 typedef Dali::Vector< Renderer* > RendererContainer;
48 typedef RendererContainer::Iterator RendererIter;
49 typedef RendererContainer::ConstIterator RendererConstIter;
54 class Renderer : public PropertyOwner,
55 public UniformMapDataProvider,
56 public UniformMap::Observer,
57 public ConnectionChangePropagator::Observer
69 * Construct a new Renderer
71 static Renderer* New();
79 * Overriden delete operator
80 * Deletes the renderer from its global memory pool
82 void operator delete( void* ptr );
85 * Set the texture set for the renderer
86 * @param[in] textureSet The texture set this renderer will use
88 void SetTextures( TextureSet* textureSet );
92 * Set the shader for the renderer
93 * @param[in] shader The shader this renderer will use
95 void SetShader( Shader* shader );
98 * Get the shader used by this renderer
99 * @return the shader this renderer uses
107 * Set the geometry for the renderer
108 * @param[in] geometry The geometry this renderer will use
110 void SetGeometry( Render::Geometry* geometry );
113 * Set the depth index
114 * @param[in] depthIndex the new depth index to use
116 void SetDepthIndex( int depthIndex );
119 * @brief Get the depth index
120 * @return The depth index
122 int GetDepthIndex() const
128 * Set the face culling mode
129 * @param[in] faceCullingMode to use
131 void SetFaceCullingMode( FaceCullingMode::Type faceCullingMode );
134 * Set the blending mode
135 * @param[in] blendingMode to use
137 void SetBlendMode( BlendMode::Type blendingMode );
140 * Set the blending options. This should only be called from the update thread.
141 * @param[in] options A bitmask of blending options.
143 void SetBlendingOptions( unsigned int options );
146 * Set the blend color for blending operation
147 * @param blendColor to pass to GL
149 void SetBlendColor( const Vector4& blendColor );
152 * Set the index of first element for indexed draw
153 * @param[in] firstElement index of first element to draw
155 void SetIndexedDrawFirstElement( size_t firstElement );
158 * Set the number of elements to draw by indexed draw
159 * @param[in] elementsCount number of elements to draw
161 void SetIndexedDrawElementsCount( size_t elementsCount );
164 * @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 * Called when an actor with this renderer is added to the stage
191 void OnStageConnect();
194 * Called when an actor with this renderer is removed from the stage
196 void OnStageDisconnect();
199 * Prepare the object for rendering.
200 * This is called by the UpdateManager when an object is due to be rendered in the current frame.
201 * @param[in] updateBufferIndex The current update buffer index.
203 void PrepareRender( BufferIndex updateBufferIndex );
206 * Retrieve the Render thread renderer
207 * @return The associated render thread renderer
209 Render::Renderer& GetRenderer();
212 * Check whether the renderer has been marked as ready to render
213 * ready means that renderer has all resources and should produce correct result
214 * complete means all resources have finished loading
215 * It's possible that renderer is complete but not ready,
216 * for example in case of resource load failed
217 * @param[out] ready TRUE if the renderer has resources to render
218 * @param[out] complete TRUE if the renderer resources are complete
220 void GetReadyAndComplete( bool& ready, bool& complete ) const;
223 * Query whether the renderer is fully opaque, fully transparent or transparent.
224 * @param[in] updateBufferIndex The current update buffer index.
225 * @return OPAQUE if fully opaque, TRANSPARENT if fully transparent and TRANSLUCENT if in between
227 Opacity GetOpacity( BufferIndex updateBufferIndex, const Node& node ) const;
230 * Query whether the renderer is currently in use by an actor on the stage
232 bool IsReferenced() const
234 return mReferenceCount > 0;
238 * Called by the TextureSet to notify to the renderer that it has changed
240 void TextureSetChanged();
242 public: // Implementation of ObjectOwnerContainer template methods
244 * Connect the object to the scene graph
246 * @param[in] sceneController The scene controller - used for sending messages to render thread
247 * @param[in] bufferIndex The current buffer index - used for sending messages to render thread
249 void ConnectToSceneGraph( SceneController& sceneController, BufferIndex bufferIndex );
252 * Disconnect the object from the scene graph
253 * @param[in] sceneController The scene controller - used for sending messages to render thread
254 * @param[in] bufferIndex The current buffer index - used for sending messages to render thread
256 void DisconnectFromSceneGraph( SceneController& sceneController, BufferIndex bufferIndex );
258 public: // Implementation of ConnectionChangePropagator
260 * @copydoc ConnectionChangePropagator::AddObserver
262 void AddConnectionObserver(ConnectionChangePropagator::Observer& observer){};
265 * @copydoc ConnectionChangePropagator::RemoveObserver
267 void RemoveConnectionObserver(ConnectionChangePropagator::Observer& observer){};
272 public: // UniformMap::Observer
274 * @copydoc UniformMap::Observer::UniformMappingsChanged
276 virtual void UniformMappingsChanged( const UniformMap& mappings );
278 public: // ConnectionChangePropagator::Observer
281 * @copydoc ConnectionChangePropagator::ConnectionsChanged
283 virtual void ConnectionsChanged( PropertyOwner& owner );
286 * @copydoc ConnectionChangePropagator::ConnectedUniformMapChanged
288 virtual void ConnectedUniformMapChanged( );
291 * @copydoc ConnectionChangePropagator::ConnectedUniformMapChanged
293 virtual void ObservedObjectDestroyed(PropertyOwner& owner);
295 public: // PropertyOwner implementation
297 * @copydoc Dali::Internal::SceneGraph::PropertyOwner::ResetDefaultProperties()
299 virtual void ResetDefaultProperties( BufferIndex updateBufferIndex ){};
301 public: // From UniformMapDataProvider
304 * @copydoc UniformMapDataProvider::GetUniformMapChanged
306 virtual bool GetUniformMapChanged( BufferIndex bufferIndex ) const{ return mUniformMapChanged[bufferIndex];}
309 * @copydoc UniformMapDataProvider::GetUniformMap
311 virtual const CollectedUniformMap& GetUniformMap( BufferIndex bufferIndex ) const;
316 * Protected constructor; See also Renderer::New()
321 * Helper function to create a new render data provider
322 * @return the new (initialized) data provider
324 RenderDataProvider* NewRenderDataProvider();
328 CollectedUniformMap mCollectedUniformMap[2]; ///< Uniform maps collected by the renderer
329 SceneController* mSceneController; ///< Used for initializing renderers
330 Render::Renderer* mRenderer; ///< Raw pointer to the renderer (that's owned by RenderManager)
331 TextureSet* mTextureSet; ///< The texture set this renderer uses. (Not owned)
332 Render::Geometry* mGeometry; ///< The geometry this renderer uses. (Not owned)
333 Shader* mShader; ///< The shader this renderer uses. (Not owned)
334 Vector4* mBlendColor; ///< The blend color for blending operation
336 size_t mIndexedDrawFirstElement; ///< first element index to be drawn using indexed draw
337 size_t mIndexedDrawElementsCount; ///< number of elements to be drawn using indexed draw
338 unsigned int mBlendBitmask; ///< The bitmask of blending options
339 unsigned int mReferenceCount; ///< Number of nodes currently using this renderer
340 unsigned int mRegenerateUniformMap; ///< 2 if the map should be regenerated, 1 if it should be copied.
341 unsigned short mResendFlag; ///< Indicate whether data should be resent to the renderer
343 DepthFunction::Type mDepthFunction:3; ///< The depth function
344 FaceCullingMode::Type mFaceCullingMode:2; ///< The mode of face culling
345 BlendMode::Type mBlendMode:2; ///< The mode of blending
346 DepthWriteMode::Type mDepthWriteMode:2; ///< The depth write mode
347 DepthTestMode::Type mDepthTestMode:2; ///< The depth test mode
349 bool mUniformMapChanged[2]; ///< Records if the uniform map has been altered this frame
350 bool mResourcesReady; ///< Set during the Update algorithm; true if the renderer has resources ready for the current frame.
351 bool mFinishedResourceAcquisition; ///< Set during DoPrepareResources; true if ready & all resource acquisition has finished (successfully or otherwise)
352 bool mPremultipledAlphaEnabled:1; ///< Flag indicating whether the Pre-multiplied Alpha Blending is required
356 int mDepthIndex; ///< Used only in PrepareRenderInstructions
361 inline void SetTexturesMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, const TextureSet& textureSet )
363 typedef MessageValue1< Renderer, TextureSet* > LocalType;
365 // Reserve some memory inside the message queue
366 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
368 // Construct message in the message queue memory; note that delete should not be called on the return value
369 new (slot) LocalType( &renderer, &Renderer::SetTextures, const_cast<TextureSet*>(&textureSet) );
372 inline void SetGeometryMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, const Render::Geometry& geometry )
374 typedef MessageValue1< Renderer, Render::Geometry* > LocalType;
376 // Reserve some memory inside the message queue
377 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
379 // Construct message in the message queue memory; note that delete should not be called on the return value
380 new (slot) LocalType( &renderer, &Renderer::SetGeometry, const_cast<Render::Geometry*>(&geometry) );
383 inline void SetShaderMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, Shader& shader )
385 typedef MessageValue1< Renderer, Shader* > LocalType;
387 // Reserve some memory inside the message queue
388 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
390 // Construct message in the message queue memory; note that delete should not be called on the return value
391 new (slot) LocalType( &renderer, &Renderer::SetShader, &shader );
394 inline void SetDepthIndexMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, int depthIndex )
396 typedef MessageValue1< Renderer, int > LocalType;
398 // Reserve some memory inside the message queue
399 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
401 // Construct message in the message queue memory; note that delete should not be called on the return value
402 new (slot) LocalType( &renderer, &Renderer::SetDepthIndex, depthIndex );
405 inline void SetFaceCullingModeMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, FaceCullingMode::Type faceCullingMode )
407 typedef MessageValue1< Renderer, FaceCullingMode::Type > LocalType;
409 // Reserve some memory inside the message queue
410 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
412 new (slot) LocalType( &renderer, &Renderer::SetFaceCullingMode, faceCullingMode );
415 inline void SetBlendModeMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, BlendMode::Type blendingMode )
417 typedef MessageValue1< Renderer, BlendMode::Type > LocalType;
419 // Reserve some memory inside the message queue
420 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
422 new (slot) LocalType( &renderer, &Renderer::SetBlendMode, blendingMode );
425 inline void SetBlendingOptionsMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, unsigned int options )
427 typedef MessageValue1< Renderer, unsigned int > LocalType;
429 // Reserve some memory inside the message queue
430 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
432 new (slot) LocalType( &renderer, &Renderer::SetBlendingOptions, options );
435 inline void SetBlendColorMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, const Vector4& blendColor )
437 typedef MessageValue1< Renderer, Vector4 > LocalType;
439 // Reserve some memory inside the message queue
440 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
442 new (slot) LocalType( &renderer, &Renderer::SetBlendColor, blendColor );
445 inline void SetIndexedDrawFirstElementMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, size_t firstElement )
447 typedef MessageValue1< Renderer, size_t > LocalType;
449 // Reserve some memory inside the message queue
450 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
452 new (slot) LocalType( &renderer, &Renderer::SetIndexedDrawFirstElement, firstElement );
455 inline void SetIndexedDrawElementsCountMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, size_t elementsCount )
457 typedef MessageValue1< Renderer, size_t > LocalType;
459 // Reserve some memory inside the message queue
460 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
462 new (slot) LocalType( &renderer, &Renderer::SetIndexedDrawElementsCount, elementsCount );
465 inline void SetEnablePreMultipliedAlphaMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, bool preMultiplied )
467 typedef MessageValue1< Renderer, bool > LocalType;
469 // Reserve some memory inside the message queue
470 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
472 new (slot) LocalType( &renderer, &Renderer::EnablePreMultipliedAlpha, preMultiplied );
475 inline void SetDepthWriteModeMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, DepthWriteMode::Type depthWriteMode )
477 typedef MessageValue1< Renderer, DepthWriteMode::Type > LocalType;
479 // Reserve some memory inside the message queue
480 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
482 new (slot) LocalType( &renderer, &Renderer::SetDepthWriteMode, depthWriteMode );
485 inline void SetDepthTestModeMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, DepthTestMode::Type depthTestMode )
487 typedef MessageValue1< Renderer, DepthTestMode::Type > LocalType;
489 // Reserve some memory inside the message queue
490 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
492 new (slot) LocalType( &renderer, &Renderer::SetDepthTestMode, depthTestMode );
495 inline void SetDepthFunctionMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, DepthFunction::Type depthFunction )
497 typedef MessageValue1< Renderer, DepthFunction::Type > LocalType;
499 // Reserve some memory inside the message queue
500 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
502 new (slot) LocalType( &renderer, &Renderer::SetDepthFunction, depthFunction );
505 inline void OnStageConnectMessage( EventThreadServices& eventThreadServices, const Renderer& renderer )
507 typedef Message< Renderer > LocalType;
509 // Reserve some memory inside the message queue
510 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
512 // Construct message in the message queue memory; note that delete should not be called on the return value
513 new (slot) LocalType( &renderer, &Renderer::OnStageConnect );
516 inline void OnStageDisconnectMessage( EventThreadServices& eventThreadServices, const Renderer& renderer )
518 typedef Message< Renderer > LocalType;
520 // Reserve some memory inside the message queue
521 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
523 // Construct message in the message queue memory; note that delete should not be called on the return value
524 new (slot) LocalType( &renderer, &Renderer::OnStageDisconnect );
527 } // namespace SceneGraph
528 } // namespace Internal
531 #endif // DALI_INTERNAL_SCENE_GRAPH_RENDERER_H