dali/internal/update/rendering/scene-graph-renderer.cpp

   1 /*
   2  * Copyright (c) 2015 Samsung Electronics Co., Ltd.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 // CLASS HEADER
  18 #include "scene-graph-renderer.h"
  19
  20 // INTERNAL HEADERS
  21 #include <dali/internal/update/controllers/scene-controller.h>
  22 #include <dali/internal/render/renderers/render-geometry.h>
  23 #include <dali/internal/update/controllers/render-message-dispatcher.h>
  24 #include <dali/internal/update/rendering/scene-graph-geometry.h>
  25 #include <dali/internal/update/rendering/scene-graph-material.h>
  26 #include <dali/internal/render/shaders/scene-graph-shader.h>
  27 #include <dali/internal/render/renderers/render-renderer.h>
  28 #include <dali/internal/render/data-providers/node-data-provider.h>
  29 #include <dali/internal/update/nodes/node.h>
  30 #include <dali/internal/render/queue/render-queue.h>
  31 #include <dali/internal/common/internal-constants.h>
  32 #include <dali/internal/common/memory-pool-object-allocator.h>
  33
  34
  35 namespace // unnamed namespace
  36 {
  37
  38 const unsigned int UNIFORM_MAP_READY      = 0;
  39 const unsigned int COPY_UNIFORM_MAP       = 1;
  40 const unsigned int REGENERATE_UNIFORM_MAP = 2;
  41
  42 //Memory pool used to allocate new renderers. Memory used by this pool will be released when shutting down DALi
  43 Dali::Internal::MemoryPoolObjectAllocator<Dali::Internal::SceneGraph::Renderer> gRendererMemoryPool;
  44
  45 void AddMappings( Dali::Internal::SceneGraph::CollectedUniformMap& localMap, const Dali::Internal::SceneGraph::UniformMap& uniformMap )
  46 {
  47   // Iterate thru uniformMap.
  48   //   Any maps that aren't in localMap should be added in a single step
  49   Dali::Internal::SceneGraph::CollectedUniformMap newUniformMappings;
  50
  51   for( unsigned int i=0, count=uniformMap.Count(); i<count; ++i )
  52   {
  53     Dali::Internal::SceneGraph::UniformPropertyMapping::Hash nameHash = uniformMap[i].uniformNameHash;
  54     bool found = false;
  55
  56     for( Dali::Internal::SceneGraph::CollectedUniformMap::Iterator iter = localMap.Begin() ; iter != localMap.End() ; ++iter )
  57     {
  58       const Dali::Internal::SceneGraph::UniformPropertyMapping* map = (*iter);
  59       if( map->uniformNameHash == nameHash )
  60       {
  61         if( map->uniformName == uniformMap[i].uniformName )
  62         {
  63           found = true;
  64           break;
  65         }
  66       }
  67     }
  68     if( !found )
  69     {
  70       // it's a new mapping. Add raw ptr to temporary list
  71       newUniformMappings.PushBack( &uniformMap[i] );
  72     }
  73   }
  74
  75   if( newUniformMappings.Count() > 0 )
  76   {
  77     localMap.Reserve( localMap.Count() + newUniformMappings.Count() );
  78
  79     for( Dali::Internal::SceneGraph::CollectedUniformMap::Iterator iter = newUniformMappings.Begin(),
  80            end = newUniformMappings.End() ;
  81          iter != end ;
  82          ++iter )
  83     {
  84       const Dali::Internal::SceneGraph::UniformPropertyMapping* map = (*iter);
  85       localMap.PushBack( map );
  86     }
  87     //@todo MESH_REWORK Use memcpy to copy ptrs from one array to the other
  88   }
  89 }
  90 }
  91
  92 namespace Dali
  93 {
  94 namespace Internal
  95 {
  96 namespace SceneGraph
  97 {
  98
  99 Renderer* Renderer::New()
 100 {
 101   return new ( gRendererMemoryPool.AllocateRawThreadSafe() ) Renderer();
 102 }
 103
 104 Renderer::Renderer()
 105 :mSceneController(0),
 106  mRenderer(NULL),
 107  mMaterial(NULL),
 108  mGeometry(NULL),
 109  mReferenceCount(0),
 110  mRegenerateUniformMap(0),
 111  mResendDataProviders(false),
 112  mResendGeometry(false),
 113  mResourcesReady(false),
 114  mFinishedResourceAcquisition(false),
 115  mDepthIndex(0)
 116 {
 117   mUniformMapChanged[0]=false;
 118   mUniformMapChanged[1]=false;
 119
 120   // Observe our own PropertyOwner's uniform map
 121   AddUniformMapObserver( *this );
 122 }
 123
 124 Renderer::~Renderer()
 125 {
 126   if (mMaterial)
 127   {
 128     mMaterial->RemoveConnectionObserver(*this);
 129     mMaterial=NULL;
 130   }
 131   if (mGeometry)
 132   {
 133     mGeometry->RemoveConnectionObserver(*this);
 134     mGeometry=NULL;
 135   }
 136 }
 137
 138 void Renderer::operator delete( void* ptr )
 139 {
 140   gRendererMemoryPool.FreeThreadSafe( static_cast<Renderer*>( ptr ) );
 141 }
 142
 143
 144 void Renderer::PrepareRender( BufferIndex updateBufferIndex )
 145 {
 146   mResourcesReady = false;
 147   mFinishedResourceAcquisition = false;
 148
 149   // Can only be considered ready when all the scene graph objects are connected to the renderer
 150   if( ( mGeometry ) && ( mGeometry->GetVertexBuffers().Count() > 0 ) &&
 151       ( mMaterial ) && ( mMaterial->GetShader() != NULL ) )
 152   {
 153     mMaterial->GetResourcesStatus( mResourcesReady, mFinishedResourceAcquisition );
 154   }
 155
 156   if( mRegenerateUniformMap > UNIFORM_MAP_READY )
 157   {
 158     DALI_ASSERT_DEBUG( mGeometry != NULL && "No geometry available in DoPrepareRender()" );
 159     DALI_ASSERT_DEBUG( mMaterial != NULL && "No geometry available in DoPrepareRender()" );
 160
 161     if( mRegenerateUniformMap == REGENERATE_UNIFORM_MAP)
 162     {
 163       CollectedUniformMap& localMap = mCollectedUniformMap[ updateBufferIndex ];
 164       localMap.Resize(0);
 165
 166       const UniformMap& rendererUniformMap = PropertyOwner::GetUniformMap();
 167       AddMappings( localMap, rendererUniformMap );
 168
 169       AddMappings( localMap, mMaterial->GetUniformMap() );
 170       AddMappings( localMap, mMaterial->GetShader()->GetUniformMap() );
 171       AddMappings( localMap, mGeometry->GetUniformMap() );
 172
 173     }
 174     else if( mRegenerateUniformMap == COPY_UNIFORM_MAP )
 175     {
 176       // Copy old map into current map
 177       CollectedUniformMap& localMap = mCollectedUniformMap[ updateBufferIndex ];
 178       CollectedUniformMap& oldMap = mCollectedUniformMap[ 1-updateBufferIndex ];
 179
 180       localMap.Resize( oldMap.Count() );
 181
 182       unsigned int index=0;
 183       for( CollectedUniformMap::Iterator iter = oldMap.Begin(), end = oldMap.End() ; iter != end ; ++iter, ++index )
 184       {
 185         localMap[index] = *iter;
 186       }
 187     }
 188
 189     mUniformMapChanged[updateBufferIndex] = true;
 190     mRegenerateUniformMap--;
 191   }
 192
 193   if( mResendDataProviders )
 194   {
 195     RenderDataProvider* dataProvider = NewRenderDataProvider();
 196
 197     typedef MessageValue1< Render::Renderer, OwnerPointer<RenderDataProvider> > DerivedType;
 198     unsigned int* slot = mSceneController->GetRenderQueue().ReserveMessageSlot( updateBufferIndex, sizeof( DerivedType ) );
 199     new (slot) DerivedType( mRenderer, &Render::Renderer::SetRenderDataProvider, dataProvider );
 200     mResendDataProviders = false;
 201   }
 202
 203   if( mResendGeometry )
 204   {
 205     // The first call to GetRenderGeometry() creates the geometry and sends it in a message
 206     RenderGeometry* geometry = mGeometry->GetRenderGeometry( mSceneController );
 207
 208     typedef MessageValue1< Render::Renderer, RenderGeometry* > DerivedType;
 209     unsigned int* slot = mSceneController->GetRenderQueue().ReserveMessageSlot( updateBufferIndex, sizeof( DerivedType ) );
 210
 211     new (slot) DerivedType( mRenderer, &Render::Renderer::SetGeometry, geometry );
 212     mResendGeometry = false;
 213   }
 214 }
 215
 216 void Renderer::SetMaterial( BufferIndex bufferIndex, Material* material)
 217 {
 218   DALI_ASSERT_DEBUG( material != NULL && "Material pointer is NULL" );
 219
 220   mMaterial = material;
 221   mMaterial->AddConnectionObserver( *this );
 222   mRegenerateUniformMap = REGENERATE_UNIFORM_MAP;
 223
 224   mResendDataProviders = true;
 225 }
 226
 227 void Renderer::SetGeometry( BufferIndex bufferIndex, Geometry* geometry)
 228 {
 229   DALI_ASSERT_DEBUG( geometry != NULL && "Geometry pointer is NULL");
 230   if( mGeometry)
 231   {
 232     mGeometry->RemoveConnectionObserver(*this);
 233     mGeometry->OnRendererDisconnect();
 234   }
 235
 236   mGeometry = geometry;
 237   mGeometry->AddConnectionObserver( *this ); // Observe geometry connections / uniform mapping changes
 238   mRegenerateUniformMap = REGENERATE_UNIFORM_MAP;
 239
 240   if( mRenderer )
 241   {
 242     mResendGeometry = true;
 243   }
 244 }
 245
 246 void Renderer::SetDepthIndex( int depthIndex )
 247 {
 248   mDepthIndex = depthIndex;
 249 }
 250
 251 //Called when a node with this renderer is added to the stage
 252 void Renderer::OnStageConnect()
 253 {
 254   ++mReferenceCount;
 255   if( !mRenderer)
 256   {
 257     RenderDataProvider* dataProvider = NewRenderDataProvider();
 258
 259     RenderGeometry* renderGeometry = mGeometry->GetRenderGeometry(mSceneController);
 260     mRenderer = Render::Renderer::New( dataProvider, renderGeometry );
 261     mSceneController->GetRenderMessageDispatcher().AddRenderer( *mRenderer );
 262     mResendDataProviders = false;
 263     mResendGeometry = false;
 264   }
 265 }
 266
 267 //Called when the node with this renderer has gone out of the stage
 268 void Renderer::OnStageDisconnect()
 269 {
 270   --mReferenceCount;
 271   if( mReferenceCount == 0 )
 272   {
 273     mSceneController->GetRenderMessageDispatcher().RemoveRenderer( *mRenderer );
 274     if( mGeometry )
 275     {
 276       mGeometry->OnRendererDisconnect();
 277     }
 278     mRenderer = NULL;
 279   }
 280 }
 281
 282 //Called when SceneGraph::Renderer is added to update manager ( that happens when an "event-thread renderer" is created )
 283 void Renderer::ConnectToSceneGraph( SceneController& sceneController, BufferIndex bufferIndex )
 284 {
 285   mRegenerateUniformMap = REGENERATE_UNIFORM_MAP;
 286   mSceneController = &sceneController;
 287 }
 288
 289
 290 //Called just before destroying the scene-graph renderer ( when the "event-thread renderer" is no longer referenced )
 291 void Renderer::DisconnectFromSceneGraph( SceneController& sceneController, BufferIndex bufferIndex )
 292 {
 293   //Remove renderer from RenderManager
 294   if( mRenderer )
 295   {
 296     mSceneController->GetRenderMessageDispatcher().RemoveRenderer( *mRenderer );
 297     mRenderer = NULL;
 298     mSceneController = NULL;
 299   }
 300 }
 301
 302 RenderDataProvider* Renderer::NewRenderDataProvider()
 303 {
 304   RenderDataProvider* dataProvider = new RenderDataProvider();
 305
 306   dataProvider->mMaterialDataProvider = mMaterial;
 307   dataProvider->mUniformMapDataProvider = this;
 308   dataProvider->mShader = mMaterial->GetShader();
 309
 310   size_t textureCount( mMaterial->GetTextureCount() );
 311   dataProvider->mTextures.resize( textureCount );
 312   for( unsigned int i(0); i<textureCount; ++i )
 313   {
 314     dataProvider->mTextures[i] = Render::Texture( mMaterial->GetTextureUniformName(i),
 315                                                   mMaterial->GetTextureId(i),
 316                                                   mMaterial->GetTextureSampler(i));
 317   }
 318
 319   return dataProvider;
 320 }
 321
 322 Render::Renderer& Renderer::GetRenderer()
 323 {
 324   return *mRenderer;
 325 }
 326
 327 const CollectedUniformMap& Renderer::GetUniformMap( BufferIndex bufferIndex ) const
 328 {
 329   return mCollectedUniformMap[bufferIndex];
 330 };
 331
 332 void Renderer::GetReadyAndComplete( bool& ready, bool& complete ) const
 333 {
 334   ready = mResourcesReady;
 335   complete = mFinishedResourceAcquisition;
 336 }
 337
 338 Renderer::Opacity Renderer::GetOpacity( BufferIndex updateBufferIndex, const Node& node ) const
 339 {
 340   Renderer::Opacity opacity = Renderer::OPAQUE;
 341
 342   if( mMaterial )
 343   {
 344     if( mMaterial->GetBlendPolicy() == Material::TRANSLUCENT )
 345     {
 346       opacity = Renderer::TRANSLUCENT;
 347     }
 348     else if( mMaterial->GetBlendPolicy() == Material::USE_ACTOR_COLOR  )
 349     {
 350       float alpha = node.GetWorldColor( updateBufferIndex ).a;
 351       if( alpha <= FULLY_TRANSPARENT )
 352       {
 353         opacity = TRANSPARENT;
 354       }
 355       else if( alpha <= FULLY_OPAQUE )
 356       {
 357         opacity = TRANSLUCENT;
 358       }
 359     }
 360   }
 361
 362   return opacity;
 363 }
 364
 365 void Renderer::ConnectionsChanged( PropertyOwner& object )
 366 {
 367   // One of our child objects has changed it's connections. Ensure the uniform
 368   // map gets regenerated during PrepareRender
 369   mRegenerateUniformMap = REGENERATE_UNIFORM_MAP;
 370
 371   // Ensure the child object pointers get re-sent to the renderer
 372   mResendDataProviders = true;
 373 }
 374
 375 void Renderer::ConnectedUniformMapChanged()
 376 {
 377   mRegenerateUniformMap = REGENERATE_UNIFORM_MAP;
 378 }
 379
 380 void Renderer::UniformMappingsChanged( const UniformMap& mappings )
 381 {
 382   // The mappings are either from PropertyOwner base class, or the Actor
 383   mRegenerateUniformMap = REGENERATE_UNIFORM_MAP;
 384 }
 385
 386 void Renderer::ObservedObjectDestroyed(PropertyOwner& owner)
 387 {
 388   if( reinterpret_cast<PropertyOwner*>(mGeometry) == &owner )
 389   {
 390     mGeometry = NULL;
 391   }
 392   else if( reinterpret_cast<PropertyOwner*>(mMaterial) == &owner )
 393   {
 394     mMaterial = NULL;
 395   }
 396 }
 397
 398 } // namespace SceneGraph
 399 } // namespace Internal
 400 } // namespace Dali