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-texture-set.h>
  25 #include <dali/internal/render/shaders/scene-graph-shader.h>
  26 #include <dali/internal/render/renderers/render-renderer.h>
  27 #include <dali/internal/render/data-providers/node-data-provider.h>
  28 #include <dali/internal/update/nodes/node.h>
  29 #include <dali/internal/render/queue/render-queue.h>
  30 #include <dali/internal/common/internal-constants.h>
  31 #include <dali/internal/common/memory-pool-object-allocator.h>
  32
  33
  34 namespace // unnamed namespace
  35 {
  36
  37 const unsigned int UNIFORM_MAP_READY      = 0;
  38 const unsigned int COPY_UNIFORM_MAP       = 1;
  39 const unsigned int REGENERATE_UNIFORM_MAP = 2;
  40
  41 //Memory pool used to allocate new renderers. Memory used by this pool will be released when shutting down DALi
  42 Dali::Internal::MemoryPoolObjectAllocator<Dali::Internal::SceneGraph::Renderer> gRendererMemoryPool;
  43
  44 void AddMappings( Dali::Internal::SceneGraph::CollectedUniformMap& localMap, const Dali::Internal::SceneGraph::UniformMap& uniformMap )
  45 {
  46   // Iterate thru uniformMap.
  47   //   Any maps that aren't in localMap should be added in a single step
  48   Dali::Internal::SceneGraph::CollectedUniformMap newUniformMappings;
  49
  50   for( unsigned int i=0, count=uniformMap.Count(); i<count; ++i )
  51   {
  52     Dali::Internal::SceneGraph::UniformPropertyMapping::Hash nameHash = uniformMap[i].uniformNameHash;
  53     bool found = false;
  54
  55     for( Dali::Internal::SceneGraph::CollectedUniformMap::Iterator iter = localMap.Begin() ; iter != localMap.End() ; ++iter )
  56     {
  57       const Dali::Internal::SceneGraph::UniformPropertyMapping* map = (*iter);
  58       if( map->uniformNameHash == nameHash )
  59       {
  60         if( map->uniformName == uniformMap[i].uniformName )
  61         {
  62           found = true;
  63           break;
  64         }
  65       }
  66     }
  67     if( !found )
  68     {
  69       // it's a new mapping. Add raw ptr to temporary list
  70       newUniformMappings.PushBack( &uniformMap[i] );
  71     }
  72   }
  73
  74   if( newUniformMappings.Count() > 0 )
  75   {
  76     localMap.Reserve( localMap.Count() + newUniformMappings.Count() );
  77
  78     for( Dali::Internal::SceneGraph::CollectedUniformMap::Iterator iter = newUniformMappings.Begin(),
  79            end = newUniformMappings.End() ;
  80          iter != end ;
  81          ++iter )
  82     {
  83       const Dali::Internal::SceneGraph::UniformPropertyMapping* map = (*iter);
  84       localMap.PushBack( map );
  85     }
  86   }
  87 }
  88
  89 // flags for resending data to renderer
  90 enum Flags
  91 {
  92   RESEND_DATA_PROVIDER = 1,
  93   RESEND_GEOMETRY = 1 << 1,
  94   RESEND_FACE_CULLING_MODE = 1 << 2,
  95   RESEND_BLEND_COLOR = 1 << 3,
  96   RESEND_BLEND_BIT_MASK = 1 << 4,
  97   RESEND_PREMULTIPLIED_ALPHA = 1 << 5,
  98   RESEND_INDEXED_DRAW_FIRST_ELEMENT = 1 << 6,
  99   RESEND_INDEXED_DRAW_ELEMENTS_COUNT = 1 << 7,
 100 };
 101
 102 }
 103
 104 namespace Dali
 105 {
 106 namespace Internal
 107 {
 108 namespace SceneGraph
 109 {
 110
 111 Renderer* Renderer::New()
 112 {
 113   return new ( gRendererMemoryPool.AllocateRawThreadSafe() ) Renderer();
 114 }
 115
 116 Renderer::Renderer()
 117 :mSceneController( 0 ),
 118  mRenderer( NULL ),
 119  mTextureSet( NULL ),
 120  mGeometry( NULL ),
 121  mShader( NULL ),
 122  mBlendColor( NULL ),
 123  mBlendBitmask( 0u ),
 124  mFaceCullingMode( Dali::Renderer::NONE ),
 125  mBlendingMode( Dali::BlendingMode::AUTO ),
 126  mIndexedDrawFirstElement( 0 ),
 127  mIndexedDrawElementsCount( 0 ),
 128  mReferenceCount( 0 ),
 129  mRegenerateUniformMap( 0 ),
 130  mResendFlag( 0 ),
 131  mResourcesReady( false ),
 132  mFinishedResourceAcquisition( false ),
 133  mDepthIndex( 0 )
 134 {
 135   mUniformMapChanged[0] = false;
 136   mUniformMapChanged[1] = false;
 137
 138   // Observe our own PropertyOwner's uniform map
 139   AddUniformMapObserver( *this );
 140 }
 141
 142 Renderer::~Renderer()
 143 {
 144   if (mTextureSet)
 145   {
 146     mTextureSet->RemoveConnectionObserver(*this);
 147     mTextureSet=NULL;
 148   }
 149   if( mShader )
 150   {
 151     mShader->RemoveConnectionObserver(*this);
 152     mShader=NULL;
 153   }
 154
 155 }
 156
 157 void Renderer::operator delete( void* ptr )
 158 {
 159   gRendererMemoryPool.FreeThreadSafe( static_cast<Renderer*>( ptr ) );
 160 }
 161
 162
 163 void Renderer::PrepareRender( BufferIndex updateBufferIndex )
 164 {
 165   mResourcesReady = false;
 166   mFinishedResourceAcquisition = false;
 167
 168   // Can only be considered ready when all the scene graph objects are connected to the renderer
 169   if( mGeometry && mShader )
 170   {
 171     if( mTextureSet )
 172     {
 173       mTextureSet->GetResourcesStatus( mResourcesReady, mFinishedResourceAcquisition );
 174     }
 175     else
 176     {
 177       mResourcesReady = true;
 178       mFinishedResourceAcquisition = true;
 179     }
 180   }
 181
 182   if( mRegenerateUniformMap > UNIFORM_MAP_READY )
 183   {
 184     DALI_ASSERT_DEBUG( mGeometry != NULL && "No geometry available in PrepareRender()" );
 185     DALI_ASSERT_DEBUG( mShader != NULL && "No shader available in PrepareRender()" );
 186
 187     if( mRegenerateUniformMap == REGENERATE_UNIFORM_MAP)
 188     {
 189       CollectedUniformMap& localMap = mCollectedUniformMap[ updateBufferIndex ];
 190       localMap.Resize(0);
 191
 192       const UniformMap& rendererUniformMap = PropertyOwner::GetUniformMap();
 193       AddMappings( localMap, rendererUniformMap );
 194
 195       if( mTextureSet )
 196       {
 197         AddMappings( localMap, mTextureSet->GetUniformMap() );
 198       }
 199
 200       AddMappings( localMap, mShader->GetUniformMap() );
 201     }
 202     else if( mRegenerateUniformMap == COPY_UNIFORM_MAP )
 203     {
 204       // Copy old map into current map
 205       CollectedUniformMap& localMap = mCollectedUniformMap[ updateBufferIndex ];
 206       CollectedUniformMap& oldMap = mCollectedUniformMap[ 1-updateBufferIndex ];
 207
 208       localMap.Resize( oldMap.Count() );
 209
 210       unsigned int index=0;
 211       for( CollectedUniformMap::Iterator iter = oldMap.Begin(), end = oldMap.End() ; iter != end ; ++iter, ++index )
 212       {
 213         localMap[index] = *iter;
 214       }
 215     }
 216
 217     mUniformMapChanged[updateBufferIndex] = true;
 218     mRegenerateUniformMap--;
 219   }
 220
 221   if( mResendFlag == 0 )
 222   {
 223     return;
 224   }
 225
 226   if( mResendFlag & RESEND_DATA_PROVIDER )
 227   {
 228     RenderDataProvider* dataProvider = NewRenderDataProvider();
 229
 230     typedef MessageValue1< Render::Renderer, OwnerPointer<RenderDataProvider> > DerivedType;
 231     unsigned int* slot = mSceneController->GetRenderQueue().ReserveMessageSlot( updateBufferIndex, sizeof( DerivedType ) );
 232     new (slot) DerivedType( mRenderer, &Render::Renderer::SetRenderDataProvider, dataProvider );
 233     mResendFlag &= ~RESEND_DATA_PROVIDER;
 234   }
 235
 236   if( mResendFlag & RESEND_GEOMETRY )
 237   {
 238     typedef MessageValue1< Render::Renderer, Render::Geometry* > DerivedType;
 239     unsigned int* slot = mSceneController->GetRenderQueue().ReserveMessageSlot( updateBufferIndex, sizeof( DerivedType ) );
 240
 241     new (slot) DerivedType( mRenderer, &Render::Renderer::SetGeometry, mGeometry );
 242     mResendFlag &= ~RESEND_GEOMETRY;
 243   }
 244
 245   if( mResendFlag & RESEND_FACE_CULLING_MODE )
 246   {
 247     typedef MessageValue1< Render::Renderer, Dali::Renderer::FaceCullingMode > DerivedType;
 248     unsigned int* slot = mSceneController->GetRenderQueue().ReserveMessageSlot( updateBufferIndex, sizeof( DerivedType ) );
 249     new (slot) DerivedType( mRenderer, &Render::Renderer::SetFaceCullingMode, mFaceCullingMode );
 250     mResendFlag &= ~RESEND_FACE_CULLING_MODE;
 251   }
 252
 253   if( mResendFlag & RESEND_BLEND_BIT_MASK )
 254   {
 255     typedef MessageValue1< Render::Renderer, unsigned int > DerivedType;
 256     unsigned int* slot = mSceneController->GetRenderQueue().ReserveMessageSlot( updateBufferIndex, sizeof( DerivedType ) );
 257     new (slot) DerivedType( mRenderer, &Render::Renderer::SetBlendingBitMask, mBlendBitmask );
 258     mResendFlag &= ~RESEND_BLEND_BIT_MASK;
 259   }
 260
 261   if( mResendFlag & RESEND_BLEND_COLOR )
 262   {
 263     typedef MessageValue1< Render::Renderer, const Vector4* > DerivedType;
 264     unsigned int* slot = mSceneController->GetRenderQueue().ReserveMessageSlot( updateBufferIndex, sizeof( DerivedType ) );
 265     new (slot) DerivedType( mRenderer, &Render::Renderer::SetBlendColor, mBlendColor );
 266     mResendFlag &= ~RESEND_BLEND_COLOR;
 267   }
 268
 269   if( mResendFlag & RESEND_PREMULTIPLIED_ALPHA  )
 270   {
 271     typedef MessageValue1< Render::Renderer, bool > DerivedType;
 272     unsigned int* slot = mSceneController->GetRenderQueue().ReserveMessageSlot( updateBufferIndex, sizeof( DerivedType ) );
 273     new (slot) DerivedType( mRenderer, &Render::Renderer::EnablePreMultipliedAlpha, mPremultipledAlphaEnabled );
 274     mResendFlag &= ~RESEND_PREMULTIPLIED_ALPHA;
 275   }
 276
 277   if( mResendFlag & RESEND_INDEXED_DRAW_FIRST_ELEMENT )
 278   {
 279     typedef MessageValue1< Render::Renderer, size_t > DerivedType;
 280     unsigned int* slot = mSceneController->GetRenderQueue().ReserveMessageSlot( updateBufferIndex, sizeof( DerivedType ) );
 281     new (slot) DerivedType( mRenderer, &Render::Renderer::SetIndexedDrawFirstElement, mIndexedDrawFirstElement );
 282     mResendFlag &= ~RESEND_INDEXED_DRAW_FIRST_ELEMENT;
 283   }
 284
 285   if( mResendFlag & RESEND_INDEXED_DRAW_ELEMENTS_COUNT )
 286   {
 287     typedef MessageValue1< Render::Renderer, size_t > DerivedType;
 288     unsigned int* slot = mSceneController->GetRenderQueue().ReserveMessageSlot( updateBufferIndex, sizeof( DerivedType ) );
 289     new (slot) DerivedType( mRenderer, &Render::Renderer::SetIndexedDrawElementsCount, mIndexedDrawElementsCount );
 290     mResendFlag &= ~RESEND_INDEXED_DRAW_FIRST_ELEMENT;
 291   }
 292
 293
 294 }
 295
 296 void Renderer::SetTextures( TextureSet* textureSet )
 297 {
 298   DALI_ASSERT_DEBUG( textureSet != NULL && "Texture set pointer is NULL" );
 299
 300   if( mTextureSet )
 301   {
 302     mTextureSet->RemoveConnectionObserver(*this);
 303   }
 304
 305   mTextureSet = textureSet;
 306   mTextureSet->AddConnectionObserver( *this );
 307   mRegenerateUniformMap = REGENERATE_UNIFORM_MAP;
 308   mResendFlag |= RESEND_DATA_PROVIDER;
 309 }
 310
 311 void Renderer::SetShader( Shader* shader )
 312 {
 313   DALI_ASSERT_DEBUG( shader != NULL && "Shader pointer is NULL" );
 314
 315   if( mShader )
 316   {
 317     mShader->RemoveConnectionObserver(*this);
 318   }
 319
 320   mShader = shader;
 321   mShader->AddConnectionObserver( *this );
 322   mRegenerateUniformMap = REGENERATE_UNIFORM_MAP;
 323   mResendFlag |= RESEND_DATA_PROVIDER;
 324 }
 325
 326 void Renderer::SetGeometry( Render::Geometry* geometry )
 327 {
 328   DALI_ASSERT_DEBUG( geometry != NULL && "Geometry pointer is NULL");
 329   mGeometry = geometry;
 330
 331   if( mRenderer )
 332   {
 333     mResendFlag |= RESEND_GEOMETRY;
 334   }
 335 }
 336
 337 void Renderer::SetDepthIndex( int depthIndex )
 338 {
 339   mDepthIndex = depthIndex;
 340 }
 341
 342 void Renderer::SetFaceCullingMode( unsigned int faceCullingMode )
 343 {
 344   mFaceCullingMode = static_cast<Dali::Renderer::FaceCullingMode>(faceCullingMode);
 345   mResendFlag |= RESEND_FACE_CULLING_MODE;
 346 }
 347
 348 void Renderer::SetBlendingMode( unsigned int blendingMode )
 349 {
 350   mBlendingMode = static_cast< BlendingMode::Type >( blendingMode );
 351 }
 352
 353 void Renderer::SetBlendingOptions( unsigned int options )
 354 {
 355   if( mBlendBitmask != options)
 356   {
 357     mBlendBitmask = options;
 358     mResendFlag |= RESEND_BLEND_BIT_MASK;
 359   }
 360 }
 361
 362 void Renderer::SetBlendColor( const Vector4& blendColor )
 363 {
 364   if( !mBlendColor )
 365   {
 366     mBlendColor = new Vector4( blendColor );
 367   }
 368   else
 369   {
 370     *mBlendColor = blendColor;
 371   }
 372
 373   mResendFlag |= RESEND_BLEND_COLOR;
 374 }
 375
 376 void Renderer::SetIndexedDrawFirstElement( size_t firstElement )
 377 {
 378   mIndexedDrawFirstElement = firstElement;
 379   mResendFlag |= RESEND_INDEXED_DRAW_FIRST_ELEMENT;
 380 }
 381
 382 void Renderer::SetIndexedDrawElementsCount( size_t elementsCount )
 383 {
 384   mIndexedDrawElementsCount = elementsCount;
 385   mResendFlag |= RESEND_INDEXED_DRAW_ELEMENTS_COUNT;
 386 }
 387
 388 void Renderer::EnablePreMultipliedAlpha( bool preMultipled )
 389 {
 390   mPremultipledAlphaEnabled = preMultipled;
 391   mResendFlag |= RESEND_PREMULTIPLIED_ALPHA;
 392 }
 393
 394 //Called when a node with this renderer is added to the stage
 395 void Renderer::OnStageConnect()
 396 {
 397   ++mReferenceCount;
 398   if( !mRenderer)
 399   {
 400     RenderDataProvider* dataProvider = NewRenderDataProvider();
 401
 402     mRenderer = Render::Renderer::New( dataProvider, mGeometry,
 403                                        mBlendBitmask, mBlendColor,
 404                                        static_cast< Dali::Renderer::FaceCullingMode >( mFaceCullingMode ),
 405                                        mPremultipledAlphaEnabled );
 406     mSceneController->GetRenderMessageDispatcher().AddRenderer( *mRenderer );
 407     mResendFlag = 0;
 408   }
 409 }
 410
 411 //Called when the node with this renderer has gone out of the stage
 412 void Renderer::OnStageDisconnect()
 413 {
 414   --mReferenceCount;
 415   if( mReferenceCount == 0 )
 416   {
 417     mSceneController->GetRenderMessageDispatcher().RemoveRenderer( *mRenderer );
 418     mRenderer = NULL;
 419   }
 420 }
 421
 422 //Called when SceneGraph::Renderer is added to update manager ( that happens when an "event-thread renderer" is created )
 423 void Renderer::ConnectToSceneGraph( SceneController& sceneController, BufferIndex bufferIndex )
 424 {
 425   mRegenerateUniformMap = REGENERATE_UNIFORM_MAP;
 426   mSceneController = &sceneController;
 427 }
 428
 429
 430 //Called just before destroying the scene-graph renderer ( when the "event-thread renderer" is no longer referenced )
 431 void Renderer::DisconnectFromSceneGraph( SceneController& sceneController, BufferIndex bufferIndex )
 432 {
 433   //Remove renderer from RenderManager
 434   if( mRenderer )
 435   {
 436     mSceneController->GetRenderMessageDispatcher().RemoveRenderer( *mRenderer );
 437     mRenderer = NULL;
 438     mSceneController = NULL;
 439   }
 440 }
 441
 442 RenderDataProvider* Renderer::NewRenderDataProvider()
 443 {
 444   RenderDataProvider* dataProvider = new RenderDataProvider();
 445
 446   dataProvider->mUniformMapDataProvider = this;
 447   dataProvider->mShader = mShader;
 448
 449   if( mTextureSet )
 450   {
 451     size_t textureCount( mTextureSet->GetTextureCount() );
 452     dataProvider->mTextures.resize( textureCount );
 453     for( unsigned int i(0); i<textureCount; ++i )
 454     {
 455       dataProvider->mTextures[i] = Render::Texture( mTextureSet->GetTextureId(i),
 456                                                     mTextureSet->GetTextureSampler(i));
 457     }
 458   }
 459
 460   return dataProvider;
 461 }
 462
 463 Render::Renderer& Renderer::GetRenderer()
 464 {
 465   return *mRenderer;
 466 }
 467
 468 const CollectedUniformMap& Renderer::GetUniformMap( BufferIndex bufferIndex ) const
 469 {
 470   return mCollectedUniformMap[bufferIndex];
 471 };
 472
 473 void Renderer::GetReadyAndComplete( bool& ready, bool& complete ) const
 474 {
 475   ready = mResourcesReady;
 476   complete = mFinishedResourceAcquisition;
 477 }
 478
 479 Renderer::Opacity Renderer::GetOpacity( BufferIndex updateBufferIndex, const Node& node ) const
 480 {
 481   Renderer::Opacity opacity = Renderer::OPAQUE;
 482
 483   switch( mBlendingMode )
 484   {
 485     case BlendingMode::ON: // If the renderer should always be use blending
 486     {
 487       opacity = Renderer::TRANSLUCENT;
 488       break;
 489     }
 490     case BlendingMode::AUTO:
 491     {
 492       bool shaderRequiresBlending( mShader->GeometryHintEnabled( Dali::ShaderEffect::HINT_BLENDING ) );
 493       if( shaderRequiresBlending || ( mTextureSet && mTextureSet->HasAlpha() ) )
 494       {
 495         opacity = Renderer::TRANSLUCENT;
 496       }
 497       else // renderer should determine opacity using the actor color
 498       {
 499         float alpha = node.GetWorldColor( updateBufferIndex ).a;
 500         if( alpha <= FULLY_TRANSPARENT )
 501         {
 502           opacity = TRANSPARENT;
 503         }
 504         else if( alpha <= FULLY_OPAQUE )
 505         {
 506           opacity = TRANSLUCENT;
 507         }
 508       }
 509       break;
 510     }
 511     case BlendingMode::OFF: // the renderer should never use blending
 512     default:
 513     {
 514       opacity = Renderer::OPAQUE;
 515       break;
 516     }
 517   }
 518
 519
 520   return opacity;
 521 }
 522
 523 void Renderer::ConnectionsChanged( PropertyOwner& object )
 524 {
 525   // One of our child objects has changed it's connections. Ensure the uniform
 526   // map gets regenerated during PrepareRender
 527   mRegenerateUniformMap = REGENERATE_UNIFORM_MAP;
 528
 529   // Ensure the child object pointers get re-sent to the renderer
 530   mResendFlag |= RESEND_DATA_PROVIDER;
 531 }
 532
 533 void Renderer::ConnectedUniformMapChanged()
 534 {
 535   mRegenerateUniformMap = REGENERATE_UNIFORM_MAP;
 536 }
 537
 538 void Renderer::UniformMappingsChanged( const UniformMap& mappings )
 539 {
 540   // The mappings are either from PropertyOwner base class, or the Actor
 541   mRegenerateUniformMap = REGENERATE_UNIFORM_MAP;
 542 }
 543
 544 void Renderer::ObservedObjectDestroyed(PropertyOwner& owner)
 545 {
 546   if( reinterpret_cast<PropertyOwner*>(mTextureSet) == &owner )
 547   {
 548     mTextureSet = NULL;
 549   }
 550   else if( reinterpret_cast<PropertyOwner*>(mShader) == &owner )
 551   {
 552     mShader = NULL;
 553   }
 554 }
 555
 556 } // namespace SceneGraph
 557 } // namespace Internal
 558 } // namespace Dali