2 * Copyright (c) 2019 Samsung Electronics Co., Ltd.
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 #include <dali/internal/render/common/render-manager.h>
22 #include <dali/public-api/actors/sampling.h>
23 #include <dali/public-api/common/dali-common.h>
24 #include <dali/public-api/common/stage.h>
25 #include <dali/public-api/render-tasks/render-task.h>
26 #include <dali/integration-api/debug.h>
27 #include <dali/integration-api/core.h>
28 #include <dali/internal/common/owner-pointer.h>
29 #include <dali/internal/render/common/render-algorithms.h>
30 #include <dali/internal/render/common/render-debug.h>
31 #include <dali/internal/render/common/render-tracker.h>
32 #include <dali/internal/render/common/render-instruction-container.h>
33 #include <dali/internal/render/common/render-instruction.h>
34 #include <dali/internal/render/gl-resources/context.h>
35 #include <dali/internal/render/queue/render-queue.h>
36 #include <dali/internal/render/renderers/render-frame-buffer.h>
37 #include <dali/internal/render/renderers/render-texture-frame-buffer.h>
38 #include <dali/internal/render/renderers/render-surface-frame-buffer.h>
39 #include <dali/internal/render/renderers/render-geometry.h>
40 #include <dali/internal/render/renderers/render-renderer.h>
41 #include <dali/internal/render/renderers/render-sampler.h>
42 #include <dali/internal/render/shaders/program-controller.h>
54 * Structure to contain internal data
56 struct RenderManager::Impl
58 Impl( Integration::GlAbstraction& glAbstraction,
59 Integration::GlSyncAbstraction& glSyncAbstraction,
60 Integration::DepthBufferAvailable depthBufferAvailableParam,
61 Integration::StencilBufferAvailable stencilBufferAvailableParam )
62 : context( glAbstraction ),
63 currentContext( &context ),
64 glAbstraction( glAbstraction ),
65 glSyncAbstraction( glSyncAbstraction ),
69 backgroundColor( Dali::Stage::DEFAULT_BACKGROUND_COLOR ),
71 renderBufferIndex( SceneGraphBuffers::INITIAL_UPDATE_BUFFER_INDEX ),
76 frameBufferContainer(),
77 lastFrameWasRendered( false ),
78 programController( glAbstraction ),
79 depthBufferAvailable( depthBufferAvailableParam ),
80 stencilBufferAvailable( stencilBufferAvailableParam )
88 void AddRenderTracker( Render::RenderTracker* renderTracker )
90 DALI_ASSERT_DEBUG( renderTracker != NULL );
91 mRenderTrackers.PushBack( renderTracker );
94 void RemoveRenderTracker( Render::RenderTracker* renderTracker )
96 mRenderTrackers.EraseObject( renderTracker );
99 Context* CreateSurfaceContext()
101 surfaceContextContainer.PushBack( new Context( glAbstraction ) );
102 return surfaceContextContainer[ surfaceContextContainer.Count() - 1 ];
105 void DestroySurfaceContext( Context* surfaceContext )
107 surfaceContextContainer.EraseObject( surfaceContext );
110 void UpdateTrackers()
112 for( auto&& iter : mRenderTrackers )
114 iter->PollSyncObject();
118 // the order is important for destruction,
119 // programs are owned by context at the moment.
120 Context context; ///< Holds the GL state of the share resource context
121 Context* currentContext; ///< Holds the GL state of the current context for rendering
122 OwnerContainer< Context* > surfaceContextContainer; ///< List of owned contexts holding the GL state per surface
123 Integration::GlAbstraction& glAbstraction; ///< GL abstraction
124 Integration::GlSyncAbstraction& glSyncAbstraction; ///< GL sync abstraction
125 RenderQueue renderQueue; ///< A message queue for receiving messages from the update-thread.
127 // Render instructions describe what should be rendered during RenderManager::Render()
128 // Owned by RenderManager. Update manager updates instructions for the next frame while we render the current one
129 RenderInstructionContainer instructions;
130 Render::RenderAlgorithms renderAlgorithms; ///< The RenderAlgorithms object is used to action the renders required by a RenderInstruction
132 Vector4 backgroundColor; ///< The glClear color used at the beginning of each frame.
134 uint32_t frameCount; ///< The current frame count
135 BufferIndex renderBufferIndex; ///< The index of the buffer to read from; this is opposite of the "update" buffer
137 Rect<int32_t> defaultSurfaceRect; ///< Rectangle for the default surface we are rendering to
139 OwnerContainer< Render::Renderer* > rendererContainer; ///< List of owned renderers
140 OwnerContainer< Render::Sampler* > samplerContainer; ///< List of owned samplers
141 OwnerContainer< Render::Texture* > textureContainer; ///< List of owned textures
142 OwnerContainer< Render::FrameBuffer* > frameBufferContainer; ///< List of owned framebuffers
143 OwnerContainer< Render::PropertyBuffer* > propertyBufferContainer; ///< List of owned property buffers
144 OwnerContainer< Render::Geometry* > geometryContainer; ///< List of owned Geometries
146 bool lastFrameWasRendered; ///< Keeps track of the last frame being rendered due to having render instructions
148 OwnerContainer< Render::RenderTracker* > mRenderTrackers; ///< List of render trackers
150 ProgramController programController; ///< Owner of the GL programs
152 Integration::DepthBufferAvailable depthBufferAvailable; ///< Whether the depth buffer is available
153 Integration::StencilBufferAvailable stencilBufferAvailable; ///< Whether the stencil buffer is available
157 RenderManager* RenderManager::New( Integration::GlAbstraction& glAbstraction,
158 Integration::GlSyncAbstraction& glSyncAbstraction,
159 Integration::DepthBufferAvailable depthBufferAvailable,
160 Integration::StencilBufferAvailable stencilBufferAvailable )
162 RenderManager* manager = new RenderManager;
163 manager->mImpl = new Impl( glAbstraction,
165 depthBufferAvailable,
166 stencilBufferAvailable );
170 RenderManager::RenderManager()
175 RenderManager::~RenderManager()
180 RenderQueue& RenderManager::GetRenderQueue()
182 return mImpl->renderQueue;
185 void RenderManager::ContextCreated()
187 mImpl->context.GlContextCreated();
188 mImpl->programController.GlContextCreated();
190 // renderers, textures and gpu buffers cannot reinitialize themselves
191 // so they rely on someone reloading the data for them
194 void RenderManager::ContextDestroyed()
196 mImpl->context.GlContextDestroyed();
197 mImpl->programController.GlContextDestroyed();
200 for( auto&& texture : mImpl->textureContainer )
202 texture->GlContextDestroyed();
205 //Inform framebuffers
206 for( auto&& framebuffer : mImpl->frameBufferContainer )
208 framebuffer->GlContextDestroyed();
212 for( auto&& renderer : mImpl->rendererContainer )
214 renderer->GlContextDestroyed();
218 void RenderManager::SetShaderSaver( ShaderSaver& upstream )
220 mImpl->programController.SetShaderSaver( upstream );
223 RenderInstructionContainer& RenderManager::GetRenderInstructionContainer()
225 return mImpl->instructions;
228 void RenderManager::SetBackgroundColor( const Vector4& color )
230 mImpl->backgroundColor = color;
233 void RenderManager::SetDefaultSurfaceRect(const Rect<int32_t>& rect)
235 mImpl->defaultSurfaceRect = rect;
238 void RenderManager::AddRenderer( OwnerPointer< Render::Renderer >& renderer )
240 // Initialize the renderer as we are now in render thread
241 renderer->Initialize( mImpl->context );
243 mImpl->rendererContainer.PushBack( renderer.Release() );
246 void RenderManager::RemoveRenderer( Render::Renderer* renderer )
248 mImpl->rendererContainer.EraseObject( renderer );
251 void RenderManager::AddSampler( OwnerPointer< Render::Sampler >& sampler )
253 mImpl->samplerContainer.PushBack( sampler.Release() );
256 void RenderManager::RemoveSampler( Render::Sampler* sampler )
258 mImpl->samplerContainer.EraseObject( sampler );
261 void RenderManager::AddTexture( OwnerPointer< Render::Texture >& texture )
263 texture->Initialize( mImpl->context );
264 mImpl->textureContainer.PushBack( texture.Release() );
267 void RenderManager::RemoveTexture( Render::Texture* texture )
269 DALI_ASSERT_DEBUG( NULL != texture );
271 // Find the texture, use reference to pointer so we can do the erase safely
272 for ( auto&& iter : mImpl->textureContainer )
274 if ( iter == texture )
276 texture->Destroy( mImpl->context );
277 mImpl->textureContainer.Erase( &iter ); // Texture found; now destroy it
283 void RenderManager::UploadTexture( Render::Texture* texture, PixelDataPtr pixelData, const Texture::UploadParams& params )
285 texture->Upload( mImpl->context, pixelData, params );
288 void RenderManager::GenerateMipmaps( Render::Texture* texture )
290 texture->GenerateMipmaps( mImpl->context );
293 void RenderManager::SetFilterMode( Render::Sampler* sampler, uint32_t minFilterMode, uint32_t magFilterMode )
295 sampler->mMinificationFilter = static_cast<Dali::FilterMode::Type>(minFilterMode);
296 sampler->mMagnificationFilter = static_cast<Dali::FilterMode::Type>(magFilterMode );
299 void RenderManager::SetWrapMode( Render::Sampler* sampler, uint32_t rWrapMode, uint32_t sWrapMode, uint32_t tWrapMode )
301 sampler->mRWrapMode = static_cast<Dali::WrapMode::Type>(rWrapMode);
302 sampler->mSWrapMode = static_cast<Dali::WrapMode::Type>(sWrapMode);
303 sampler->mTWrapMode = static_cast<Dali::WrapMode::Type>(tWrapMode);
306 void RenderManager::AddFrameBuffer( Render::FrameBuffer* frameBuffer )
308 mImpl->frameBufferContainer.PushBack( frameBuffer );
309 if ( frameBuffer->IsSurfaceBacked() )
311 frameBuffer->Initialize( *mImpl->CreateSurfaceContext() );
315 frameBuffer->Initialize( mImpl->context );
319 void RenderManager::RemoveFrameBuffer( Render::FrameBuffer* frameBuffer )
321 DALI_ASSERT_DEBUG( NULL != frameBuffer );
323 // Find the sampler, use reference so we can safely do the erase
324 for ( auto&& iter : mImpl->frameBufferContainer )
326 if ( iter == frameBuffer )
328 frameBuffer->Destroy( mImpl->context );
330 if ( frameBuffer->IsSurfaceBacked() )
332 auto surfaceFrameBuffer = static_cast<Render::SurfaceFrameBuffer*>( frameBuffer );
333 mImpl->DestroySurfaceContext( surfaceFrameBuffer->GetContext() );
336 mImpl->frameBufferContainer.Erase( &iter ); // frameBuffer found; now destroy it
343 void RenderManager::AttachColorTextureToFrameBuffer( Render::FrameBuffer* frameBuffer, Render::Texture* texture, uint32_t mipmapLevel, uint32_t layer )
345 if ( !frameBuffer->IsSurfaceBacked() )
347 auto textureFrameBuffer = static_cast<Render::TextureFrameBuffer*>( frameBuffer );
348 textureFrameBuffer->AttachColorTexture( mImpl->context, texture, mipmapLevel, layer );
352 void RenderManager::AddPropertyBuffer( OwnerPointer< Render::PropertyBuffer >& propertyBuffer )
354 mImpl->propertyBufferContainer.PushBack( propertyBuffer.Release() );
357 void RenderManager::RemovePropertyBuffer( Render::PropertyBuffer* propertyBuffer )
359 mImpl->propertyBufferContainer.EraseObject( propertyBuffer );
362 void RenderManager::SetPropertyBufferFormat( Render::PropertyBuffer* propertyBuffer, OwnerPointer< Render::PropertyBuffer::Format>& format )
364 propertyBuffer->SetFormat( format.Release() );
367 void RenderManager::SetPropertyBufferData( Render::PropertyBuffer* propertyBuffer, OwnerPointer< Vector<uint8_t> >& data, uint32_t size )
369 propertyBuffer->SetData( data.Release(), size );
372 void RenderManager::SetIndexBuffer( Render::Geometry* geometry, Dali::Vector<uint16_t>& indices )
374 geometry->SetIndexBuffer( indices );
377 void RenderManager::AddGeometry( OwnerPointer< Render::Geometry >& geometry )
379 mImpl->geometryContainer.PushBack( geometry.Release() );
382 void RenderManager::RemoveGeometry( Render::Geometry* geometry )
384 mImpl->geometryContainer.EraseObject( geometry );
387 void RenderManager::AttachVertexBuffer( Render::Geometry* geometry, Render::PropertyBuffer* propertyBuffer )
389 DALI_ASSERT_DEBUG( NULL != geometry );
392 for ( auto&& iter : mImpl->geometryContainer )
394 if ( iter == geometry )
396 iter->AddPropertyBuffer( propertyBuffer );
402 void RenderManager::RemoveVertexBuffer( Render::Geometry* geometry, Render::PropertyBuffer* propertyBuffer )
404 DALI_ASSERT_DEBUG( NULL != geometry );
407 for ( auto&& iter : mImpl->geometryContainer )
409 if ( iter == geometry )
411 iter->RemovePropertyBuffer( propertyBuffer );
417 void RenderManager::SetGeometryType( Render::Geometry* geometry, uint32_t geometryType )
419 geometry->SetType( Render::Geometry::Type(geometryType) );
422 void RenderManager::AddRenderTracker( Render::RenderTracker* renderTracker )
424 mImpl->AddRenderTracker(renderTracker);
427 void RenderManager::RemoveRenderTracker( Render::RenderTracker* renderTracker )
429 mImpl->RemoveRenderTracker(renderTracker);
432 ProgramCache* RenderManager::GetProgramCache()
434 return &(mImpl->programController);
437 void RenderManager::Render( Integration::RenderStatus& status, bool forceClear )
439 DALI_PRINT_RENDER_START( mImpl->renderBufferIndex );
441 // Core::Render documents that GL context must be current before calling Render
442 DALI_ASSERT_DEBUG( mImpl->context.IsGlContextCreated() );
444 // Increment the frame count at the beginning of each frame
447 // Process messages queued during previous update
448 mImpl->renderQueue.ProcessMessages( mImpl->renderBufferIndex );
450 const uint32_t count = mImpl->instructions.Count( mImpl->renderBufferIndex );
451 const bool haveInstructions = count > 0u;
453 // Only render if we have instructions to render, or the last frame was rendered (and therefore a clear is required).
454 if( haveInstructions || mImpl->lastFrameWasRendered || forceClear )
456 // Mark that we will require a post-render step to be performed (includes swap-buffers).
457 status.SetNeedsPostRender( true );
459 // Switch to the shared context
460 if ( mImpl->currentContext != &mImpl->context )
462 mImpl->currentContext = &mImpl->context;
463 // Clear the current cached program when the context is switched
464 mImpl->programController.ClearCurrentProgram();
468 // Upload the geometries
469 for( uint32_t i = 0; i < count; ++i )
471 RenderInstruction& instruction = mImpl->instructions.At( mImpl->renderBufferIndex, i );
473 const Matrix* viewMatrix = instruction.GetViewMatrix( mImpl->renderBufferIndex );
474 const Matrix* projectionMatrix = instruction.GetProjectionMatrix( mImpl->renderBufferIndex );
476 DALI_ASSERT_DEBUG( viewMatrix );
477 DALI_ASSERT_DEBUG( projectionMatrix );
479 if( viewMatrix && projectionMatrix )
481 const RenderListContainer::SizeType renderListCount = instruction.RenderListCount();
483 // Iterate through each render list.
484 for( RenderListContainer::SizeType index = 0; index < renderListCount; ++index )
486 const RenderList* renderList = instruction.GetRenderList( index );
488 if( renderList && !renderList->IsEmpty() )
490 const std::size_t itemCount = renderList->Count();
491 for( uint32_t itemIndex = 0u; itemIndex < itemCount; ++itemIndex )
493 const RenderItem& item = renderList->GetItem( itemIndex );
494 if( DALI_LIKELY( item.mRenderer ) )
496 item.mRenderer->Upload( *mImpl->currentContext );
504 for( uint32_t i = 0; i < count; ++i )
506 RenderInstruction& instruction = mImpl->instructions.At( mImpl->renderBufferIndex, i );
508 DoRender( instruction );
511 GLenum attachments[] = { GL_DEPTH, GL_STENCIL };
512 mImpl->context.InvalidateFramebuffer(GL_FRAMEBUFFER, 2, attachments);
513 for ( auto&& context : mImpl->surfaceContextContainer )
515 context->InvalidateFramebuffer(GL_FRAMEBUFFER, 2, attachments);
518 //Notify RenderGeometries that rendering has finished
519 for ( auto&& iter : mImpl->geometryContainer )
521 iter->OnRenderFinished();
526 DALI_LOG_RELEASE_INFO( "RenderManager::Render: Skip rendering [%d, %d, %d]\n", haveInstructions, mImpl->lastFrameWasRendered, forceClear );
529 mImpl->UpdateTrackers();
531 // If this frame was rendered due to instructions existing, we mark this so we know to clear the next frame.
532 mImpl->lastFrameWasRendered = haveInstructions;
535 * The rendering has finished; swap to the next buffer.
536 * Ideally the update has just finished using this buffer; otherwise the render thread
537 * should block until the update has finished.
539 mImpl->renderBufferIndex = (0 != mImpl->renderBufferIndex) ? 0 : 1;
541 DALI_PRINT_RENDER_END();
544 void RenderManager::DoRender( RenderInstruction& instruction )
546 Rect<int32_t> viewportRect;
549 if ( instruction.mIsClearColorSet )
551 clearColor = instruction.mClearColor;
555 clearColor = Dali::RenderTask::DEFAULT_CLEAR_COLOR;
558 Rect<int32_t> surfaceRect = mImpl->defaultSurfaceRect;
559 Vector4 backgroundColor = mImpl->backgroundColor;
560 Integration::DepthBufferAvailable depthBufferAvailable = mImpl->depthBufferAvailable;
561 Integration::StencilBufferAvailable stencilBufferAvailable = mImpl->stencilBufferAvailable;
563 Render::SurfaceFrameBuffer* surfaceFrameBuffer = nullptr;
564 if ( instruction.mFrameBuffer != 0 )
566 if ( instruction.mFrameBuffer->IsSurfaceBacked() )
568 surfaceFrameBuffer = static_cast<Render::SurfaceFrameBuffer*>( instruction.mFrameBuffer );
570 if ( mImpl->currentContext->IsSurfacelessContextSupported() )
572 Context* surfaceContext = surfaceFrameBuffer->GetContext();
573 if ( mImpl->currentContext != surfaceContext )
575 // Switch the correct context if rendering to a surface
576 mImpl->currentContext = surfaceContext;
577 // Clear the current cached program when the context is switched
578 mImpl->programController.ClearCurrentProgram();
582 surfaceRect = Rect<int32_t>( 0, 0, static_cast<int32_t>( surfaceFrameBuffer->GetWidth() ), static_cast<int32_t>( surfaceFrameBuffer->GetHeight() ) );
583 backgroundColor = surfaceFrameBuffer->GetBackgroundColor();
587 // Switch to shared context for off-screen buffer
588 mImpl->currentContext = &mImpl->context;
592 DALI_ASSERT_DEBUG( mImpl->currentContext->IsGlContextCreated() );
594 // reset the program matrices for all programs once per frame
595 // this ensures we will set view and projection matrix once per program per camera
596 mImpl->programController.ResetProgramMatrices();
598 if( instruction.mFrameBuffer )
600 instruction.mFrameBuffer->Bind( *mImpl->currentContext );
604 mImpl->currentContext->BindFramebuffer( GL_FRAMEBUFFER, 0u );
607 if ( surfaceFrameBuffer )
609 mImpl->currentContext->Viewport( surfaceRect.x,
612 surfaceRect.height );
614 mImpl->currentContext->ClearColor( backgroundColor.r,
620 // Clear the entire color, depth and stencil buffers for the default framebuffer, if required.
621 // It is important to clear all 3 buffers when they are being used, for performance on deferred renderers
622 // e.g. previously when the depth & stencil buffers were NOT cleared, it caused the DDK to exceed a "vertex count limit",
623 // and then stall. That problem is only noticeable when rendering a large number of vertices per frame.
625 mImpl->currentContext->SetScissorTest( false );
627 GLbitfield clearMask = GL_COLOR_BUFFER_BIT;
629 mImpl->currentContext->ColorMask( true );
631 if( depthBufferAvailable == Integration::DepthBufferAvailable::TRUE )
633 mImpl->currentContext->DepthMask( true );
634 clearMask |= GL_DEPTH_BUFFER_BIT;
637 if( stencilBufferAvailable == Integration::StencilBufferAvailable::TRUE)
639 mImpl->currentContext->ClearStencil( 0 );
640 mImpl->currentContext->StencilMask( 0xFF ); // 8 bit stencil mask, all 1's
641 clearMask |= GL_STENCIL_BUFFER_BIT;
644 mImpl->currentContext->Clear( clearMask, Context::FORCE_CLEAR );
646 if( !instruction.mIgnoreRenderToFbo && ( instruction.mFrameBuffer != 0 ) )
648 if ( instruction.mFrameBuffer->IsSurfaceBacked() ) // Surface rendering
650 if ( instruction.mIsViewportSet )
652 // For glViewport the lower-left corner is (0,0)
653 // For glViewport the lower-left corner is (0,0)
654 const int32_t y = ( surfaceRect.height - instruction.mViewport.height ) - instruction.mViewport.y;
655 viewportRect.Set( instruction.mViewport.x, y, instruction.mViewport.width, instruction.mViewport.height );
659 viewportRect = surfaceRect;
662 else // Offscreen buffer rendering
664 if ( instruction.mIsViewportSet )
666 // For glViewport the lower-left corner is (0,0)
667 const int32_t y = ( instruction.mFrameBuffer->GetHeight() - instruction.mViewport.height ) - instruction.mViewport.y;
668 viewportRect.Set( instruction.mViewport.x, y, instruction.mViewport.width, instruction.mViewport.height );
672 viewportRect.Set( 0, 0, instruction.mFrameBuffer->GetWidth(), instruction.mFrameBuffer->GetHeight() );
676 else // No Offscreen frame buffer rendering
678 // Check whether a viewport is specified, otherwise the full surface size is used
679 if ( instruction.mFrameBuffer != 0 )
681 if ( instruction.mIsViewportSet )
683 // For glViewport the lower-left corner is (0,0)
684 const int32_t y = ( instruction.mFrameBuffer->GetHeight() - instruction.mViewport.height ) - instruction.mViewport.y;
685 viewportRect.Set( instruction.mViewport.x, y, instruction.mViewport.width, instruction.mViewport.height );
689 viewportRect.Set( 0, 0, instruction.mFrameBuffer->GetWidth(), instruction.mFrameBuffer->GetHeight() );
694 viewportRect = surfaceRect;
698 mImpl->currentContext->Viewport(viewportRect.x, viewportRect.y, viewportRect.width, viewportRect.height);
700 if ( instruction.mIsClearColorSet )
702 mImpl->currentContext->ClearColor( clearColor.r,
707 // Clear the viewport area only
708 mImpl->currentContext->SetScissorTest( true );
709 mImpl->currentContext->Scissor( viewportRect.x, viewportRect.y, viewportRect.width, viewportRect.height );
710 mImpl->currentContext->ColorMask( true );
711 mImpl->currentContext->Clear( GL_COLOR_BUFFER_BIT , Context::CHECK_CACHED_VALUES );
712 mImpl->currentContext->SetScissorTest( false );
715 mImpl->renderAlgorithms.ProcessRenderInstruction(
717 *mImpl->currentContext,
718 mImpl->renderBufferIndex,
719 depthBufferAvailable,
720 stencilBufferAvailable );
722 if( instruction.mRenderTracker && ( instruction.mFrameBuffer != 0 ) )
724 // This will create a sync object every frame this render tracker
725 // is alive (though it should be now be created only for
726 // render-once render tasks)
727 instruction.mRenderTracker->CreateSyncObject( mImpl->glSyncAbstraction );
728 instruction.mRenderTracker = NULL; // Only create once.
731 if ( surfaceFrameBuffer )
733 surfaceFrameBuffer->PostRender();
737 } // namespace SceneGraph
739 } // namespace Internal