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   }
  88 }
  89
  90 // flags for resending data to renderer
  91 enum Flags
  92 {
  93   RESEND_DATA_PROVIDER = 1,
  94   RESEND_GEOMETRY = 1 << 1,
  95   RESEND_FACE_CULLING_MODE = 1 << 2,
  96   RESEND_BLEND_COLOR = 1 << 3,
  97   RESEND_BLEND_BIT_MASK = 1 << 4,
  98   RESEND_PREMULTIPLIED_ALPHA = 1 << 5
  99 };
 100
 101 }
 102
 103 namespace Dali
 104 {
 105 namespace Internal
 106 {
 107 namespace SceneGraph
 108 {
 109
 110 Renderer* Renderer::New()
 111 {
 112   return new ( gRendererMemoryPool.AllocateRawThreadSafe() ) Renderer();
 113 }
 114
 115 Renderer::Renderer()
 116 :mSceneController(0),
 117  mRenderer(NULL),
 118  mMaterial(NULL),
 119  mGeometry(NULL),
 120  mBlendColor(NULL),
 121  mBlendBitmask(0u),
 122  mFaceCullingMode( Dali::Renderer::NONE ),
 123  mBlendingMode( Dali::BlendingMode::AUTO ),
 124  mReferenceCount(0),
 125  mRegenerateUniformMap(0),
 126  mResendFlag(0),
 127  mResourcesReady(false),
 128  mFinishedResourceAcquisition(false),
 129  mDepthIndex(0)
 130 {
 131   mUniformMapChanged[0]=false;
 132   mUniformMapChanged[1]=false;
 133
 134   // Observe our own PropertyOwner's uniform map
 135   AddUniformMapObserver( *this );
 136 }
 137
 138 Renderer::~Renderer()
 139 {
 140   if (mMaterial)
 141   {
 142     mMaterial->RemoveConnectionObserver(*this);
 143     mMaterial=NULL;
 144   }
 145   if (mGeometry)
 146   {
 147     mGeometry->RemoveConnectionObserver(*this);
 148     mGeometry=NULL;
 149   }
 150 }
 151
 152 void Renderer::operator delete( void* ptr )
 153 {
 154   gRendererMemoryPool.FreeThreadSafe( static_cast<Renderer*>( ptr ) );
 155 }
 156
 157
 158 void Renderer::PrepareRender( BufferIndex updateBufferIndex )
 159 {
 160   mResourcesReady = false;
 161   mFinishedResourceAcquisition = false;
 162
 163   // Can only be considered ready when all the scene graph objects are connected to the renderer
 164   if( ( mGeometry ) && ( mGeometry->GetVertexBuffers().Count() > 0 ) &&
 165       ( mMaterial ) && ( mMaterial->GetShader() != NULL ) )
 166   {
 167     mMaterial->GetResourcesStatus( mResourcesReady, mFinishedResourceAcquisition );
 168   }
 169
 170   if( mRegenerateUniformMap > UNIFORM_MAP_READY )
 171   {
 172     DALI_ASSERT_DEBUG( mGeometry != NULL && "No geometry available in DoPrepareRender()" );
 173     DALI_ASSERT_DEBUG( mMaterial != NULL && "No geometry available in DoPrepareRender()" );
 174
 175     if( mRegenerateUniformMap == REGENERATE_UNIFORM_MAP)
 176     {
 177       CollectedUniformMap& localMap = mCollectedUniformMap[ updateBufferIndex ];
 178       localMap.Resize(0);
 179
 180       const UniformMap& rendererUniformMap = PropertyOwner::GetUniformMap();
 181       AddMappings( localMap, rendererUniformMap );
 182
 183       AddMappings( localMap, mMaterial->GetUniformMap() );
 184       AddMappings( localMap, mMaterial->GetShader()->GetUniformMap() );
 185       AddMappings( localMap, mGeometry->GetUniformMap() );
 186
 187     }
 188     else if( mRegenerateUniformMap == COPY_UNIFORM_MAP )
 189     {
 190       // Copy old map into current map
 191       CollectedUniformMap& localMap = mCollectedUniformMap[ updateBufferIndex ];
 192       CollectedUniformMap& oldMap = mCollectedUniformMap[ 1-updateBufferIndex ];
 193
 194       localMap.Resize( oldMap.Count() );
 195
 196       unsigned int index=0;
 197       for( CollectedUniformMap::Iterator iter = oldMap.Begin(), end = oldMap.End() ; iter != end ; ++iter, ++index )
 198       {
 199         localMap[index] = *iter;
 200       }
 201     }
 202
 203     mUniformMapChanged[updateBufferIndex] = true;
 204     mRegenerateUniformMap--;
 205   }
 206
 207   if( mResendFlag == 0 )
 208   {
 209     return;
 210   }
 211
 212   if( mResendFlag & RESEND_DATA_PROVIDER )
 213   {
 214     RenderDataProvider* dataProvider = NewRenderDataProvider();
 215
 216     typedef MessageValue1< Render::Renderer, OwnerPointer<RenderDataProvider> > DerivedType;
 217     unsigned int* slot = mSceneController->GetRenderQueue().ReserveMessageSlot( updateBufferIndex, sizeof( DerivedType ) );
 218     new (slot) DerivedType( mRenderer, &Render::Renderer::SetRenderDataProvider, dataProvider );
 219     mResendFlag &= ~RESEND_DATA_PROVIDER;
 220   }
 221
 222   if( mResendFlag & RESEND_GEOMETRY )
 223   {
 224     // The first call to GetRenderGeometry() creates the geometry and sends it in a message
 225     RenderGeometry* geometry = mGeometry->GetRenderGeometry( mSceneController );
 226
 227     typedef MessageValue1< Render::Renderer, RenderGeometry* > DerivedType;
 228     unsigned int* slot = mSceneController->GetRenderQueue().ReserveMessageSlot( updateBufferIndex, sizeof( DerivedType ) );
 229
 230     new (slot) DerivedType( mRenderer, &Render::Renderer::SetGeometry, geometry );
 231     mResendFlag &= ~RESEND_GEOMETRY;
 232   }
 233
 234   if( mResendFlag & RESEND_FACE_CULLING_MODE )
 235   {
 236     typedef MessageValue1< Render::Renderer, Dali::Renderer::FaceCullingMode > DerivedType;
 237     unsigned int* slot = mSceneController->GetRenderQueue().ReserveMessageSlot( updateBufferIndex, sizeof( DerivedType ) );
 238     new (slot) DerivedType( mRenderer, &Render::Renderer::SetFaceCullingMode, mFaceCullingMode );
 239     mResendFlag &= ~RESEND_FACE_CULLING_MODE;
 240   }
 241
 242   if( mResendFlag & RESEND_BLEND_BIT_MASK )
 243   {
 244     typedef MessageValue1< Render::Renderer, unsigned int > DerivedType;
 245     unsigned int* slot = mSceneController->GetRenderQueue().ReserveMessageSlot( updateBufferIndex, sizeof( DerivedType ) );
 246     new (slot) DerivedType( mRenderer, &Render::Renderer::SetBlendingBitMask, mBlendBitmask );
 247     mResendFlag &= ~RESEND_BLEND_BIT_MASK;
 248   }
 249
 250   if( mResendFlag & RESEND_BLEND_COLOR )
 251   {
 252     typedef MessageValue1< Render::Renderer, const Vector4* > DerivedType;
 253     unsigned int* slot = mSceneController->GetRenderQueue().ReserveMessageSlot( updateBufferIndex, sizeof( DerivedType ) );
 254     new (slot) DerivedType( mRenderer, &Render::Renderer::SetBlendColor, mBlendColor );
 255     mResendFlag &= ~RESEND_BLEND_COLOR;
 256   }
 257
 258   if( mResendFlag & RESEND_PREMULTIPLIED_ALPHA  )
 259   {
 260     typedef MessageValue1< Render::Renderer, bool > DerivedType;
 261     unsigned int* slot = mSceneController->GetRenderQueue().ReserveMessageSlot( updateBufferIndex, sizeof( DerivedType ) );
 262     new (slot) DerivedType( mRenderer, &Render::Renderer::EnablePreMultipliedAlpha, mPremultipledAlphaEnabled );
 263     mResendFlag &= ~RESEND_PREMULTIPLIED_ALPHA;
 264   }
 265 }
 266
 267 void Renderer::SetMaterial( BufferIndex bufferIndex, Material* material)
 268 {
 269   DALI_ASSERT_DEBUG( material != NULL && "Material pointer is NULL" );
 270
 271   mMaterial = material;
 272   mMaterial->AddConnectionObserver( *this );
 273   mRegenerateUniformMap = REGENERATE_UNIFORM_MAP;
 274
 275   mResendFlag |= RESEND_DATA_PROVIDER;
 276 }
 277
 278 void Renderer::SetGeometry( BufferIndex bufferIndex, Geometry* geometry)
 279 {
 280   DALI_ASSERT_DEBUG( geometry != NULL && "Geometry pointer is NULL");
 281   if( mGeometry)
 282   {
 283     mGeometry->RemoveConnectionObserver(*this);
 284     mGeometry->OnRendererDisconnect();
 285   }
 286
 287   mGeometry = geometry;
 288   mGeometry->AddConnectionObserver( *this ); // Observe geometry connections / uniform mapping changes
 289   mRegenerateUniformMap = REGENERATE_UNIFORM_MAP;
 290
 291   if( mRenderer )
 292   {
 293     mResendFlag |= RESEND_GEOMETRY;
 294   }
 295 }
 296
 297 void Renderer::SetDepthIndex( int depthIndex )
 298 {
 299   mDepthIndex = depthIndex;
 300 }
 301
 302 void Renderer::SetFaceCullingMode( unsigned int faceCullingMode )
 303 {
 304   mFaceCullingMode = static_cast<Dali::Renderer::FaceCullingMode>(faceCullingMode);
 305   mResendFlag |= RESEND_FACE_CULLING_MODE;
 306 }
 307
 308 void Renderer::SetBlendingMode( unsigned int blendingMode )
 309 {
 310   mBlendingMode = static_cast< BlendingMode::Type >( blendingMode );
 311 }
 312
 313 void Renderer::SetBlendingOptions( unsigned int options )
 314 {
 315   if( mBlendBitmask != options)
 316   {
 317     mBlendBitmask = options;
 318     mResendFlag |= RESEND_BLEND_BIT_MASK;
 319   }
 320 }
 321
 322 void Renderer::SetBlendColor( const Vector4& blendColor )
 323 {
 324   if( !mBlendColor )
 325   {
 326     mBlendColor = new Vector4( blendColor );
 327   }
 328   else
 329   {
 330     *mBlendColor = blendColor;
 331   }
 332
 333   mResendFlag |= RESEND_BLEND_COLOR;
 334 }
 335
 336 void Renderer::EnablePreMultipliedAlpha( bool preMultipled )
 337 {
 338   mPremultipledAlphaEnabled = preMultipled;
 339   mResendFlag |= RESEND_PREMULTIPLIED_ALPHA;
 340 }
 341
 342 //Called when a node with this renderer is added to the stage
 343 void Renderer::OnStageConnect()
 344 {
 345   ++mReferenceCount;
 346   if( !mRenderer)
 347   {
 348     RenderDataProvider* dataProvider = NewRenderDataProvider();
 349
 350     RenderGeometry* renderGeometry = mGeometry->GetRenderGeometry(mSceneController);
 351     mRenderer = Render::Renderer::New( dataProvider, renderGeometry,
 352                                        mBlendBitmask, mBlendColor,
 353                                        static_cast< Dali::Renderer::FaceCullingMode >( mFaceCullingMode ),
 354                                        mPremultipledAlphaEnabled );
 355     mSceneController->GetRenderMessageDispatcher().AddRenderer( *mRenderer );
 356     mResendFlag = 0;
 357   }
 358 }
 359
 360 //Called when the node with this renderer has gone out of the stage
 361 void Renderer::OnStageDisconnect()
 362 {
 363   --mReferenceCount;
 364   if( mReferenceCount == 0 )
 365   {
 366     mSceneController->GetRenderMessageDispatcher().RemoveRenderer( *mRenderer );
 367     if( mGeometry )
 368     {
 369       mGeometry->OnRendererDisconnect();
 370     }
 371     mRenderer = NULL;
 372   }
 373 }
 374
 375 //Called when SceneGraph::Renderer is added to update manager ( that happens when an "event-thread renderer" is created )
 376 void Renderer::ConnectToSceneGraph( SceneController& sceneController, BufferIndex bufferIndex )
 377 {
 378   mRegenerateUniformMap = REGENERATE_UNIFORM_MAP;
 379   mSceneController = &sceneController;
 380 }
 381
 382
 383 //Called just before destroying the scene-graph renderer ( when the "event-thread renderer" is no longer referenced )
 384 void Renderer::DisconnectFromSceneGraph( SceneController& sceneController, BufferIndex bufferIndex )
 385 {
 386   //Remove renderer from RenderManager
 387   if( mRenderer )
 388   {
 389     mSceneController->GetRenderMessageDispatcher().RemoveRenderer( *mRenderer );
 390     mRenderer = NULL;
 391     mSceneController = NULL;
 392   }
 393 }
 394
 395 RenderDataProvider* Renderer::NewRenderDataProvider()
 396 {
 397   RenderDataProvider* dataProvider = new RenderDataProvider();
 398
 399   dataProvider->mUniformMapDataProvider = this;
 400   dataProvider->mShader = mMaterial->GetShader();
 401
 402   size_t textureCount( mMaterial->GetTextureCount() );
 403   dataProvider->mTextures.resize( textureCount );
 404   for( unsigned int i(0); i<textureCount; ++i )
 405   {
 406     dataProvider->mTextures[i] = Render::Texture( mMaterial->GetTextureUniformName(i),
 407                                                   mMaterial->GetTextureId(i),
 408                                                   mMaterial->GetTextureSampler(i));
 409   }
 410
 411   return dataProvider;
 412 }
 413
 414 Render::Renderer& Renderer::GetRenderer()
 415 {
 416   return *mRenderer;
 417 }
 418
 419 const CollectedUniformMap& Renderer::GetUniformMap( BufferIndex bufferIndex ) const
 420 {
 421   return mCollectedUniformMap[bufferIndex];
 422 };
 423
 424 void Renderer::GetReadyAndComplete( bool& ready, bool& complete ) const
 425 {
 426   ready = mResourcesReady;
 427   complete = mFinishedResourceAcquisition;
 428 }
 429
 430 Renderer::Opacity Renderer::GetOpacity( BufferIndex updateBufferIndex, const Node& node ) const
 431 {
 432   Renderer::Opacity opacity = Renderer::OPAQUE;
 433
 434   if( mMaterial )
 435   {
 436     switch( mBlendingMode )
 437     {
 438       case BlendingMode::ON: // If the renderer should always be use blending
 439       {
 440         opacity = Renderer::TRANSLUCENT;
 441         break;
 442       }
 443       case BlendingMode::AUTO:
 444       {
 445         if(mMaterial->IsTranslucent() ) // If the renderer should determine opacity using the material
 446         {
 447           opacity = Renderer::TRANSLUCENT;
 448         }
 449         else // renderer should determine opacity using the actor color
 450         {
 451           float alpha = node.GetWorldColor( updateBufferIndex ).a;
 452           if( alpha <= FULLY_TRANSPARENT )
 453           {
 454             opacity = TRANSPARENT;
 455           }
 456           else if( alpha <= FULLY_OPAQUE )
 457           {
 458             opacity = TRANSLUCENT;
 459           }
 460         }
 461         break;
 462       }
 463       case BlendingMode::OFF: // the renderer should never use blending
 464       default:
 465       {
 466         opacity = Renderer::OPAQUE;
 467         break;
 468       }
 469     }
 470   }
 471
 472   return opacity;
 473 }
 474
 475 void Renderer::ConnectionsChanged( PropertyOwner& object )
 476 {
 477   // One of our child objects has changed it's connections. Ensure the uniform
 478   // map gets regenerated during PrepareRender
 479   mRegenerateUniformMap = REGENERATE_UNIFORM_MAP;
 480
 481   // Ensure the child object pointers get re-sent to the renderer
 482   mResendFlag |= RESEND_DATA_PROVIDER;
 483 }
 484
 485 void Renderer::ConnectedUniformMapChanged()
 486 {
 487   mRegenerateUniformMap = REGENERATE_UNIFORM_MAP;
 488 }
 489
 490 void Renderer::UniformMappingsChanged( const UniformMap& mappings )
 491 {
 492   // The mappings are either from PropertyOwner base class, or the Actor
 493   mRegenerateUniformMap = REGENERATE_UNIFORM_MAP;
 494 }
 495
 496 void Renderer::ObservedObjectDestroyed(PropertyOwner& owner)
 497 {
 498   if( reinterpret_cast<PropertyOwner*>(mGeometry) == &owner )
 499   {
 500     mGeometry = NULL;
 501   }
 502   else if( reinterpret_cast<PropertyOwner*>(mMaterial) == &owner )
 503   {
 504     mMaterial = NULL;
 505   }
 506 }
 507
 508 } // namespace SceneGraph
 509 } // namespace Internal
 510 } // namespace Dali