1 #ifndef DALI_INTERNAL_SCENE_GRAPH_RENDERER2_H
2 #define DALI_INTERNAL_SCENE_GRAPH_RENDERER2_H
5 * Copyright (c) 2015 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/devel-api/rendering/geometry.h>
22 #include <dali/devel-api/rendering/renderer.h> // Dali::Renderer
23 #include <dali/internal/common/blending-options.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>
43 class SceneController;
46 typedef Dali::Vector< Renderer* > RendererContainer;
47 typedef RendererContainer::Iterator RendererIter;
48 typedef RendererContainer::ConstIterator RendererConstIter;
53 class Renderer : public PropertyOwner,
54 public UniformMapDataProvider,
55 public UniformMap::Observer,
56 public ConnectionChangePropagator::Observer
68 * Construct a new Renderer
70 static Renderer* New();
78 * Overriden delete operator
79 * Deletes the renderer from its global memory pool
81 void operator delete( void* ptr );
84 * Set the texture set for the renderer
85 * @param[in] textureSet The texture set this renderer will use
87 void SetTextures( TextureSet* textureSet );
91 * Set the shader for the renderer
92 * @param[in] shader The shader this renderer will use
94 void SetShader( Shader* shader );
97 * Get the shader used by this renderer
98 * @return the shader this renderer uses
106 * Set the geometry for the renderer
107 * @param[in] geometry The geometry this renderer will use
109 void SetGeometry( Render::Geometry* geometry );
112 * Set the depth index
113 * @param[in] depthIndex the new depth index to use
115 void SetDepthIndex( int depthIndex );
118 * @brief Get the depth index
119 * @return The depth index
121 int GetDepthIndex() const
127 * Set the face culling mode
128 * @param[in] faceCullingMode to use
130 void SetFaceCullingMode( unsigned int faceCullingMode );
133 * Set the blending mode
134 * @param[in] blendingMode to use
136 void SetBlendMode( unsigned int blendingMode );
139 * Set the blending options. This should only be called from the update thread.
140 * @param[in] options A bitmask of blending options.
142 void SetBlendingOptions( unsigned int options );
145 * Set the blend color for blending operation
146 * @param blendColor to pass to GL
148 void SetBlendColor( const Vector4& blendColor );
151 * Set the index of first element for indexed draw
152 * @param[in] firstElement index of first element to draw
154 void SetIndexedDrawFirstElement( size_t firstElement );
157 * Set the number of elements to draw by indexed draw
158 * @param[in] elementsCount number of elements to draw
160 void SetIndexedDrawElementsCount( size_t elementsCount );
163 * @brief Set whether the Pre-multiplied Alpha Blending is required
165 * @param[in] preMultipled whether alpha is pre-multiplied.
167 void EnablePreMultipliedAlpha( bool preMultipled );
170 * Sets the depth buffer write mode
171 * @param[in] depthWriteMode The depth buffer write mode
173 void SetDepthWriteMode( unsigned int depthWriteMode );
176 * Called when an actor with this renderer is added to the stage
178 void OnStageConnect();
181 * Called when an actor with this renderer is removed from the stage
183 void OnStageDisconnect();
186 * Prepare the object for rendering.
187 * This is called by the UpdateManager when an object is due to be rendered in the current frame.
188 * @param[in] updateBufferIndex The current update buffer index.
190 void PrepareRender( BufferIndex updateBufferIndex );
193 * Retrieve the Render thread renderer
194 * @return The associated render thread renderer
196 Render::Renderer& GetRenderer();
199 * Check whether the renderer has been marked as ready to render
200 * ready means that renderer has all resources and should produce correct result
201 * complete means all resources have finished loading
202 * It's possible that renderer is complete but not ready,
203 * for example in case of resource load failed
204 * @param[out] ready TRUE if the renderer has resources to render
205 * @param[out] complete TRUE if the renderer resources are complete
207 void GetReadyAndComplete( bool& ready, bool& complete ) const;
210 * Query whether the renderer is fully opaque, fully transparent or transparent.
211 * @param[in] updateBufferIndex The current update buffer index.
212 * @return OPAQUE if fully opaque, TRANSPARENT if fully transparent and TRANSLUCENT if in between
214 Opacity GetOpacity( BufferIndex updateBufferIndex, const Node& node ) const;
217 * Query whether the renderer is currently in use by an actor on the stage
219 bool IsReferenced() const
221 return mReferenceCount > 0;
225 * Called by the TextureSet to notify to the renderer that it has changed
227 void TextureSetChanged();
229 public: // Implementation of ObjectOwnerContainer template methods
231 * Connect the object to the scene graph
233 * @param[in] sceneController The scene controller - used for sending messages to render thread
234 * @param[in] bufferIndex The current buffer index - used for sending messages to render thread
236 void ConnectToSceneGraph( SceneController& sceneController, BufferIndex bufferIndex );
239 * Disconnect the object from the scene graph
240 * @param[in] sceneController The scene controller - used for sending messages to render thread
241 * @param[in] bufferIndex The current buffer index - used for sending messages to render thread
243 void DisconnectFromSceneGraph( SceneController& sceneController, BufferIndex bufferIndex );
245 public: // Implementation of ConnectionChangePropagator
247 * @copydoc ConnectionChangePropagator::AddObserver
249 void AddConnectionObserver(ConnectionChangePropagator::Observer& observer){};
252 * @copydoc ConnectionChangePropagator::RemoveObserver
254 void RemoveConnectionObserver(ConnectionChangePropagator::Observer& observer){};
259 public: // UniformMap::Observer
261 * @copydoc UniformMap::Observer::UniformMappingsChanged
263 virtual void UniformMappingsChanged( const UniformMap& mappings );
265 public: // ConnectionChangePropagator::Observer
268 * @copydoc ConnectionChangePropagator::ConnectionsChanged
270 virtual void ConnectionsChanged( PropertyOwner& owner );
273 * @copydoc ConnectionChangePropagator::ConnectedUniformMapChanged
275 virtual void ConnectedUniformMapChanged( );
278 * @copydoc ConnectionChangePropagator::ConnectedUniformMapChanged
280 virtual void ObservedObjectDestroyed(PropertyOwner& owner);
282 public: // PropertyOwner implementation
284 * @copydoc Dali::Internal::SceneGraph::PropertyOwner::ResetDefaultProperties()
286 virtual void ResetDefaultProperties( BufferIndex updateBufferIndex ){};
288 public: // From UniformMapDataProvider
291 * @copydoc UniformMapDataProvider::GetUniformMapChanged
293 virtual bool GetUniformMapChanged( BufferIndex bufferIndex ) const{ return mUniformMapChanged[bufferIndex];}
296 * @copydoc UniformMapDataProvider::GetUniformMap
298 virtual const CollectedUniformMap& GetUniformMap( BufferIndex bufferIndex ) const;
303 * Protected constructor; See also Renderer::New()
308 * Helper function to create a new render data provider
309 * @return the new (initialized) data provider
311 RenderDataProvider* NewRenderDataProvider();
315 SceneController* mSceneController; ///< Used for initializing renderers whilst attached
316 Render::Renderer* mRenderer; ///< Raw pointer to the renderer (that's owned by RenderManager)
317 TextureSet* mTextureSet; ///< The texture set this renderer uses. (Not owned)
318 Render::Geometry* mGeometry; ///< The geometry this renderer uses. (Not owned)
321 Vector4* mBlendColor; ///< The blend color for blending operation
322 unsigned int mBlendBitmask; ///< The bitmask of blending options
323 FaceCullingMode::Type mFaceCullingMode; ///< The mode of face culling
324 BlendMode::Type mBlendMode; ///< The mode of blending
325 DepthWriteMode::Type mDepthWriteMode; ///< The depth write mode
327 CollectedUniformMap mCollectedUniformMap[2]; ///< Uniform maps collected by the renderer
329 size_t mIndexedDrawFirstElement; ///< first element index to be drawn using indexed draw
330 size_t mIndexedDrawElementsCount; ///< number of elements to be drawn using indexed draw
331 unsigned int mReferenceCount; ///< Number of nodes currently using this renderer
332 unsigned int mRegenerateUniformMap; ///< 2 if the map should be regenerated, 1 if it should be copied.
333 unsigned char mResendFlag; ///< Indicate whether data should be resent to the renderer
334 bool mUniformMapChanged[2]; ///< Records if the uniform map has been altered this frame
335 bool mResourcesReady; ///< Set during the Update algorithm; true if the attachment has resources ready for the current frame.
336 bool mFinishedResourceAcquisition; ///< Set during DoPrepareResources; true if ready & all resource acquisition has finished (successfully or otherwise)
337 bool mPremultipledAlphaEnabled : 1; ///< Flag indicating whether the Pre-multiplied Alpha Blending is required
341 int mDepthIndex; ///< Used only in PrepareRenderInstructions
346 inline void SetTexturesMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, const TextureSet& textureSet )
348 typedef MessageValue1< Renderer, TextureSet* > LocalType;
350 // Reserve some memory inside the message queue
351 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
353 // Construct message in the message queue memory; note that delete should not be called on the return value
354 new (slot) LocalType( &renderer, &Renderer::SetTextures, const_cast<TextureSet*>(&textureSet) );
357 inline void SetGeometryMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, const Render::Geometry& geometry )
359 typedef MessageValue1< Renderer, Render::Geometry* > LocalType;
361 // Reserve some memory inside the message queue
362 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
364 // Construct message in the message queue memory; note that delete should not be called on the return value
365 new (slot) LocalType( &renderer, &Renderer::SetGeometry, const_cast<Render::Geometry*>(&geometry) );
368 inline void SetShaderMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, Shader& shader )
370 typedef MessageValue1< Renderer, Shader* > LocalType;
372 // Reserve some memory inside the message queue
373 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
375 // Construct message in the message queue memory; note that delete should not be called on the return value
376 new (slot) LocalType( &renderer, &Renderer::SetShader, &shader );
379 inline void SetDepthIndexMessage( EventThreadServices& eventThreadServices, const Renderer& attachment, int depthIndex )
381 typedef MessageValue1< Renderer, int > LocalType;
383 // Reserve some memory inside the message queue
384 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
386 // Construct message in the message queue memory; note that delete should not be called on the return value
387 new (slot) LocalType( &attachment, &Renderer::SetDepthIndex, depthIndex );
390 inline void SetFaceCullingModeMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, Dali::FaceCullingMode::Type faceCullingMode )
392 typedef MessageValue1< Renderer, unsigned int > LocalType;
394 // Reserve some memory inside the message queue
395 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
397 new (slot) LocalType( &renderer, &Renderer::SetFaceCullingMode, faceCullingMode );
400 inline void SetBlendModeMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, BlendMode::Type blendingMode )
402 typedef MessageValue1< Renderer, unsigned int > LocalType;
404 // Reserve some memory inside the message queue
405 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
407 new (slot) LocalType( &renderer, &Renderer::SetBlendMode, blendingMode );
410 inline void SetBlendingOptionsMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, unsigned int options )
412 typedef MessageValue1< Renderer, unsigned int > LocalType;
414 // Reserve some memory inside the message queue
415 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
417 new (slot) LocalType( &renderer, &Renderer::SetBlendingOptions, options );
420 inline void SetBlendColorMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, const Vector4& blendColor )
422 typedef MessageValue1< Renderer, Vector4 > LocalType;
424 // Reserve some memory inside the message queue
425 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
427 new (slot) LocalType( &renderer, &Renderer::SetBlendColor, blendColor );
430 inline void SetIndexedDrawFirstElementMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, size_t firstElement )
432 typedef MessageValue1< Renderer, size_t > LocalType;
434 // Reserve some memory inside the message queue
435 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
437 new (slot) LocalType( &renderer, &Renderer::SetIndexedDrawFirstElement, firstElement );
440 inline void SetIndexedDrawElementsCountMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, size_t elementsCount )
442 typedef MessageValue1< Renderer, size_t > LocalType;
444 // Reserve some memory inside the message queue
445 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
447 new (slot) LocalType( &renderer, &Renderer::SetIndexedDrawElementsCount, elementsCount );
450 inline void SetEnablePreMultipliedAlphaMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, bool preMultiplied )
452 typedef MessageValue1< Renderer, bool > LocalType;
454 // Reserve some memory inside the message queue
455 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
457 new (slot) LocalType( &renderer, &Renderer::EnablePreMultipliedAlpha, preMultiplied );
460 inline void SetDepthWriteModeMessage( EventThreadServices& eventThreadServices, const Renderer& renderer, Dali::DepthWriteMode::Type depthWriteMode )
462 typedef MessageValue1< Renderer, unsigned int > LocalType;
464 // Reserve some memory inside the message queue
465 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
467 new (slot) LocalType( &renderer, &Renderer::SetDepthWriteMode, depthWriteMode );
470 inline void OnStageConnectMessage( EventThreadServices& eventThreadServices, const Renderer& renderer )
472 typedef Message< Renderer > LocalType;
474 // Reserve some memory inside the message queue
475 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
477 // Construct message in the message queue memory; note that delete should not be called on the return value
478 new (slot) LocalType( &renderer, &Renderer::OnStageConnect );
481 inline void OnStageDisconnectMessage( EventThreadServices& eventThreadServices, const Renderer& renderer )
483 typedef Message< Renderer > LocalType;
485 // Reserve some memory inside the message queue
486 unsigned int* slot = eventThreadServices.ReserveMessageSlot( sizeof( LocalType ) );
488 // Construct message in the message queue memory; note that delete should not be called on the return value
489 new (slot) LocalType( &renderer, &Renderer::OnStageDisconnect );
492 } // namespace SceneGraph
493 } // namespace Internal
496 #endif // DALI_INTERNAL_SCENE_GRAPH_RENDERER_H