2 * Copyright (c) 2016 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/gl-resources/frame-buffer-texture.h>
36 #include <dali/internal/render/gl-resources/texture-cache.h>
37 #include <dali/internal/render/queue/render-queue.h>
38 #include <dali/internal/render/renderers/render-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>
53 typedef OwnerContainer< Render::Renderer* > RendererOwnerContainer;
54 typedef RendererOwnerContainer::Iterator RendererOwnerIter;
56 typedef OwnerContainer< Render::Geometry* > GeometryOwnerContainer;
57 typedef GeometryOwnerContainer::Iterator GeometryOwnerIter;
59 typedef OwnerContainer< Render::Sampler* > SamplerOwnerContainer;
60 typedef SamplerOwnerContainer::Iterator SamplerOwnerIter;
62 typedef OwnerContainer< Render::NewTexture* > TextureOwnerContainer;
63 typedef TextureOwnerContainer::Iterator TextureOwnerIter;
65 typedef OwnerContainer< Render::FrameBuffer* > FrameBufferOwnerContainer;
66 typedef FrameBufferOwnerContainer::Iterator FrameBufferOwnerIter;
68 typedef OwnerContainer< Render::PropertyBuffer* > PropertyBufferOwnerContainer;
69 typedef PropertyBufferOwnerContainer::Iterator PropertyBufferOwnerIter;
71 typedef OwnerContainer< Render::RenderTracker* > RenderTrackerContainer;
72 typedef RenderTrackerContainer::Iterator RenderTrackerIter;
73 typedef RenderTrackerContainer::ConstIterator RenderTrackerConstIter;
76 * Structure to contain internal data
78 struct RenderManager::Impl
80 Impl( Integration::GlAbstraction& glAbstraction,
81 Integration::GlSyncAbstraction& glSyncAbstraction,
82 LockedResourceQueue& textureUploadedQ,
83 TextureUploadedDispatcher& postProcessDispatcher )
84 : context( glAbstraction ),
85 glSyncAbstraction( glSyncAbstraction ),
87 textureCache( renderQueue, postProcessDispatcher, context ),
88 textureUploadedQueue( textureUploadedQ ),
90 backgroundColor( Dali::Stage::DEFAULT_BACKGROUND_COLOR ),
92 renderBufferIndex( SceneGraphBuffers::INITIAL_UPDATE_BUFFER_INDEX ),
97 frameBufferContainer(),
98 renderersAdded( false ),
99 firstRenderCompleted( false ),
100 defaultShader( NULL ),
101 programController( glAbstraction )
109 void AddRenderTracker( Render::RenderTracker* renderTracker )
111 DALI_ASSERT_DEBUG( renderTracker != NULL );
112 mRenderTrackers.PushBack( renderTracker );
115 void RemoveRenderTracker( Render::RenderTracker* renderTracker )
117 DALI_ASSERT_DEBUG( renderTracker != NULL );
118 for(RenderTrackerIter iter = mRenderTrackers.Begin(), end = mRenderTrackers.End(); iter != end; ++iter)
120 if( *iter == renderTracker )
122 mRenderTrackers.Erase( iter );
128 void UpdateTrackers()
130 for(RenderTrackerIter iter = mRenderTrackers.Begin(), end = mRenderTrackers.End(); iter != end; ++iter)
132 (*iter)->PollSyncObject();
136 // the order is important for destruction,
137 // programs are owned by context at the moment.
138 Context context; ///< holds the GL state
139 Integration::GlSyncAbstraction& glSyncAbstraction; ///< GL sync abstraction
140 RenderQueue renderQueue; ///< A message queue for receiving messages from the update-thread.
141 TextureCache textureCache; ///< Cache for all GL textures
142 LockedResourceQueue& textureUploadedQueue; ///< A queue for requesting resource post processing in update thread
144 // Render instructions describe what should be rendered during RenderManager::Render()
145 // Owned by RenderManager. Update manager updates instructions for the next frame while we render the current one
146 RenderInstructionContainer instructions;
148 Vector4 backgroundColor; ///< The glClear color used at the beginning of each frame.
150 unsigned int frameCount; ///< The current frame count
151 BufferIndex renderBufferIndex; ///< The index of the buffer to read from; this is opposite of the "update" buffer
153 Rect<int> defaultSurfaceRect; ///< Rectangle for the default surface we are rendering to
155 RendererOwnerContainer rendererContainer; ///< List of owned renderers
156 SamplerOwnerContainer samplerContainer; ///< List of owned samplers
157 TextureOwnerContainer textureContainer; ///< List of owned textures
158 FrameBufferOwnerContainer frameBufferContainer; ///< List of owned framebuffers
159 PropertyBufferOwnerContainer propertyBufferContainer; ///< List of owned property buffers
160 GeometryOwnerContainer geometryContainer; ///< List of owned Geometries
164 RenderTrackerContainer mRenderTrackers; ///< List of render trackers
166 bool firstRenderCompleted; ///< False until the first render is done
167 Shader* defaultShader; ///< Default shader to use
168 ProgramController programController; ///< Owner of the GL programs
171 RenderManager* RenderManager::New( Integration::GlAbstraction& glAbstraction,
172 Integration::GlSyncAbstraction& glSyncAbstraction,
173 LockedResourceQueue& textureUploadedQ )
175 RenderManager* manager = new RenderManager;
176 manager->mImpl = new Impl( glAbstraction, glSyncAbstraction, textureUploadedQ, *manager );
180 RenderManager::RenderManager()
185 RenderManager::~RenderManager()
190 RenderQueue& RenderManager::GetRenderQueue()
192 return mImpl->renderQueue;
195 TextureCache& RenderManager::GetTextureCache()
197 return mImpl->textureCache;
200 void RenderManager::ContextCreated()
202 mImpl->context.GlContextCreated();
203 mImpl->programController.GlContextCreated();
205 // renderers, textures and gpu buffers cannot reinitialize themselves
206 // so they rely on someone reloading the data for them
209 void RenderManager::ContextDestroyed()
211 mImpl->context.GlContextDestroyed();
212 mImpl->programController.GlContextDestroyed();
214 // inform texture cache
215 mImpl->textureCache.GlContextDestroyed(); // Clears gl texture ids
218 for( TextureOwnerIter iter = mImpl->textureContainer.Begin(); iter != mImpl->textureContainer.End(); ++iter )
220 (*iter)->GlContextDestroyed();
223 //Inform framebuffers
224 for( FrameBufferOwnerIter iter = mImpl->frameBufferContainer.Begin(); iter != mImpl->frameBufferContainer.End(); ++iter )
226 (*iter)->GlContextDestroyed();
230 RendererOwnerContainer::Iterator end = mImpl->rendererContainer.End();
231 RendererOwnerContainer::Iterator iter = mImpl->rendererContainer.Begin();
232 for( ; iter != end; ++iter )
234 GlResourceOwner* renderer = *iter;
235 renderer->GlContextDestroyed(); // Clear up vertex buffers
239 void RenderManager::DispatchTextureUploaded(ResourceId request)
241 mImpl->textureUploadedQueue.PushBack( request );
244 void RenderManager::SetShaderSaver( ShaderSaver& upstream )
246 mImpl->programController.SetShaderSaver( upstream );
249 RenderInstructionContainer& RenderManager::GetRenderInstructionContainer()
251 return mImpl->instructions;
254 void RenderManager::SetBackgroundColor( const Vector4& color )
256 mImpl->backgroundColor = color;
259 void RenderManager::SetDefaultSurfaceRect(const Rect<int>& rect)
261 mImpl->defaultSurfaceRect = rect;
264 void RenderManager::AddRenderer( Render::Renderer* renderer )
266 // Initialize the renderer as we are now in render thread
267 renderer->Initialize( mImpl->context, mImpl->textureCache );
269 mImpl->rendererContainer.PushBack( renderer );
271 if( !mImpl->renderersAdded )
273 mImpl->renderersAdded = true;
277 void RenderManager::RemoveRenderer( Render::Renderer* renderer )
279 DALI_ASSERT_DEBUG( NULL != renderer );
281 RendererOwnerContainer& renderers = mImpl->rendererContainer;
284 for ( RendererOwnerIter iter = renderers.Begin(); iter != renderers.End(); ++iter )
286 if ( *iter == renderer )
288 renderers.Erase( iter ); // Renderer found; now destroy it
294 void RenderManager::AddSampler( Render::Sampler* sampler )
296 mImpl->samplerContainer.PushBack( sampler );
299 void RenderManager::RemoveSampler( Render::Sampler* sampler )
301 DALI_ASSERT_DEBUG( NULL != sampler );
303 SamplerOwnerContainer& samplers = mImpl->samplerContainer;
306 for ( SamplerOwnerIter iter = samplers.Begin(); iter != samplers.End(); ++iter )
308 if ( *iter == sampler )
310 samplers.Erase( iter ); // Sampler found; now destroy it
316 void RenderManager::AddTexture( Render::NewTexture* texture )
318 mImpl->textureContainer.PushBack( texture );
319 texture->Initialize(mImpl->context);
322 void RenderManager::RemoveTexture( Render::NewTexture* texture )
324 DALI_ASSERT_DEBUG( NULL != texture );
326 TextureOwnerContainer& textures = mImpl->textureContainer;
329 for ( TextureOwnerIter iter = textures.Begin(); iter != textures.End(); ++iter )
331 if ( *iter == texture )
333 texture->Destroy( mImpl->context );
334 textures.Erase( iter ); // Texture found; now destroy it
340 void RenderManager::UploadTexture( Render::NewTexture* texture, PixelDataPtr pixelData, const NewTexture::UploadParams& params )
342 texture->Upload( mImpl->context, pixelData, params );
345 void RenderManager::GenerateMipmaps( Render::NewTexture* texture )
347 texture->GenerateMipmaps( mImpl->context );
350 void RenderManager::SetFilterMode( Render::Sampler* sampler, unsigned int minFilterMode, unsigned int magFilterMode )
352 sampler->mMinificationFilter = static_cast<Dali::FilterMode::Type>(minFilterMode);
353 sampler->mMagnificationFilter = static_cast<Dali::FilterMode::Type>(magFilterMode );
356 void RenderManager::SetWrapMode( Render::Sampler* sampler, unsigned int rWrapMode, unsigned int sWrapMode, unsigned int tWrapMode )
358 sampler->mRWrapMode = static_cast<Dali::WrapMode::Type>(rWrapMode);
359 sampler->mSWrapMode = static_cast<Dali::WrapMode::Type>(sWrapMode);
360 sampler->mTWrapMode = static_cast<Dali::WrapMode::Type>(tWrapMode);
363 void RenderManager::AddFrameBuffer( Render::FrameBuffer* frameBuffer )
365 mImpl->frameBufferContainer.PushBack( frameBuffer );
366 frameBuffer->Initialize(mImpl->context);
369 void RenderManager::RemoveFrameBuffer( Render::FrameBuffer* frameBuffer )
371 DALI_ASSERT_DEBUG( NULL != frameBuffer );
373 FrameBufferOwnerContainer& framebuffers = mImpl->frameBufferContainer;
376 for ( FrameBufferOwnerIter iter = framebuffers.Begin(); iter != framebuffers.End(); ++iter )
378 if ( *iter == frameBuffer )
380 frameBuffer->Destroy( mImpl->context );
381 framebuffers.Erase( iter ); // frameBuffer found; now destroy it
387 void RenderManager::AttachColorTextureToFrameBuffer( Render::FrameBuffer* frameBuffer, Render::NewTexture* texture, unsigned int mipmapLevel, unsigned int layer )
389 frameBuffer->AttachColorTexture( mImpl->context, texture, mipmapLevel, layer );
392 void RenderManager::AddPropertyBuffer( Render::PropertyBuffer* propertyBuffer )
394 mImpl->propertyBufferContainer.PushBack( propertyBuffer );
397 void RenderManager::RemovePropertyBuffer( Render::PropertyBuffer* propertyBuffer )
399 DALI_ASSERT_DEBUG( NULL != propertyBuffer );
401 PropertyBufferOwnerContainer& propertyBuffers = mImpl->propertyBufferContainer;
404 for ( PropertyBufferOwnerIter iter = propertyBuffers.Begin(); iter != propertyBuffers.End(); ++iter )
406 if ( *iter == propertyBuffer )
408 propertyBuffers.Erase( iter ); // Property buffer found; now destroy it
414 void RenderManager::SetPropertyBufferFormat(Render::PropertyBuffer* propertyBuffer, Render::PropertyBuffer::Format* format )
416 propertyBuffer->SetFormat( format );
419 void RenderManager::SetPropertyBufferData( Render::PropertyBuffer* propertyBuffer, Dali::Vector<char>* data, size_t size )
421 propertyBuffer->SetData( data, size );
424 void RenderManager::SetIndexBuffer( Render::Geometry* geometry, Dali::Vector<unsigned short>& indices )
426 geometry->SetIndexBuffer( indices );
429 void RenderManager::AddGeometry( Render::Geometry* geometry )
431 mImpl->geometryContainer.PushBack( geometry );
434 void RenderManager::RemoveGeometry( Render::Geometry* geometry )
436 DALI_ASSERT_DEBUG( NULL != geometry );
438 GeometryOwnerContainer& geometries = mImpl->geometryContainer;
441 for ( GeometryOwnerIter iter = geometries.Begin(); iter != geometries.End(); ++iter )
443 if ( *iter == geometry )
445 geometries.Erase( iter ); // Geometry found; now destroy it
451 void RenderManager::AddVertexBuffer( Render::Geometry* geometry, Render::PropertyBuffer* propertyBuffer )
453 DALI_ASSERT_DEBUG( NULL != geometry );
455 GeometryOwnerContainer& geometries = mImpl->geometryContainer;
458 for ( GeometryOwnerIter iter = geometries.Begin(); iter != geometries.End(); ++iter )
460 if ( *iter == geometry )
462 (*iter)->AddPropertyBuffer( propertyBuffer );
468 void RenderManager::RemoveVertexBuffer( Render::Geometry* geometry, Render::PropertyBuffer* propertyBuffer )
470 DALI_ASSERT_DEBUG( NULL != geometry );
472 GeometryOwnerContainer& geometries = mImpl->geometryContainer;
475 for ( GeometryOwnerIter iter = geometries.Begin(); iter != geometries.End(); ++iter )
477 if ( *iter == geometry )
479 (*iter)->RemovePropertyBuffer( propertyBuffer );
485 void RenderManager::SetGeometryType( Render::Geometry* geometry, unsigned int geometryType )
487 geometry->SetType( Render::Geometry::Type(geometryType) );
490 void RenderManager::AddRenderTracker( Render::RenderTracker* renderTracker )
492 mImpl->AddRenderTracker(renderTracker);
495 void RenderManager::RemoveRenderTracker( Render::RenderTracker* renderTracker )
497 mImpl->RemoveRenderTracker(renderTracker);
500 void RenderManager::SetDefaultShader( Shader* shader )
502 mImpl->defaultShader = shader;
505 ProgramCache* RenderManager::GetProgramCache()
507 return &(mImpl->programController);
510 bool RenderManager::Render( Integration::RenderStatus& status )
512 DALI_PRINT_RENDER_START( mImpl->renderBufferIndex );
514 // Core::Render documents that GL context must be current before calling Render
515 DALI_ASSERT_DEBUG( mImpl->context.IsGlContextCreated() );
517 // Increment the frame count at the beginning of each frame
518 ++(mImpl->frameCount);
520 // Process messages queued during previous update
521 mImpl->renderQueue.ProcessMessages( mImpl->renderBufferIndex );
523 // No need to make any gl calls if we've done 1st glClear & don't have any renderers to render during startup.
524 if( !mImpl->firstRenderCompleted || mImpl->renderersAdded )
526 // switch rendering to adaptor provided (default) buffer
527 mImpl->context.BindFramebuffer( GL_FRAMEBUFFER, 0 );
529 mImpl->context.Viewport( mImpl->defaultSurfaceRect.x,
530 mImpl->defaultSurfaceRect.y,
531 mImpl->defaultSurfaceRect.width,
532 mImpl->defaultSurfaceRect.height );
534 mImpl->context.ClearColor( mImpl->backgroundColor.r,
535 mImpl->backgroundColor.g,
536 mImpl->backgroundColor.b,
537 mImpl->backgroundColor.a );
539 mImpl->context.ClearStencil( 0 );
541 // Clear the entire color, depth and stencil buffers for the default framebuffer.
542 // It is important to clear all 3 buffers, for performance on deferred renderers like Mali
543 // e.g. previously when the depth & stencil buffers were NOT cleared, it caused the DDK to exceed a "vertex count limit",
544 // and then stall. That problem is only noticeable when rendering a large number of vertices per frame.
545 mImpl->context.SetScissorTest( false );
546 mImpl->context.ColorMask( true );
547 mImpl->context.DepthMask( true );
548 mImpl->context.StencilMask( 0xFF ); // 8 bit stencil mask, all 1's
549 mImpl->context.Clear( GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT | GL_STENCIL_BUFFER_BIT, Context::FORCE_CLEAR );
551 // reset the program matrices for all programs once per frame
552 // this ensures we will set view and projection matrix once per program per camera
553 mImpl->programController.ResetProgramMatrices();
555 // if we don't have default shader, no point doing the render calls
556 if( mImpl->defaultShader )
558 size_t count = mImpl->instructions.Count( mImpl->renderBufferIndex );
559 for ( size_t i = 0; i < count; ++i )
561 RenderInstruction& instruction = mImpl->instructions.At( mImpl->renderBufferIndex, i );
563 DoRender( instruction, *mImpl->defaultShader );
565 GLenum attachments[] = { GL_DEPTH, GL_STENCIL };
566 mImpl->context.InvalidateFramebuffer(GL_FRAMEBUFFER, 2, attachments);
568 mImpl->UpdateTrackers();
570 mImpl->firstRenderCompleted = true;
574 //Notify RenderGeometries that rendering has finished
575 for ( GeometryOwnerIter iter = mImpl->geometryContainer.Begin(); iter != mImpl->geometryContainer.End(); ++iter )
577 (*iter)->OnRenderFinished();
581 * The rendering has finished; swap to the next buffer.
582 * Ideally the update has just finished using this buffer; otherwise the render thread
583 * should block until the update has finished.
585 mImpl->renderBufferIndex = (0 != mImpl->renderBufferIndex) ? 0 : 1;
587 DALI_PRINT_RENDER_END();
589 // check if anything has been posted to the update thread, if IsEmpty then no update required.
590 return !mImpl->textureUploadedQueue.IsEmpty();
593 void RenderManager::DoRender( RenderInstruction& instruction, Shader& defaultShader )
595 Rect<int> viewportRect;
598 if ( instruction.mIsClearColorSet )
600 clearColor = instruction.mClearColor;
604 clearColor = Dali::RenderTask::DEFAULT_CLEAR_COLOR;
607 FrameBufferTexture* offscreen = NULL;
609 if ( instruction.mOffscreenTextureId != 0 )
611 offscreen = mImpl->textureCache.GetFramebuffer( instruction.mOffscreenTextureId );
612 DALI_ASSERT_DEBUG( NULL != offscreen );
614 if( NULL != offscreen &&
615 offscreen->Prepare() )
617 // Check whether a viewport is specified, otherwise the full surface size is used
618 if ( instruction.mIsViewportSet )
620 // For glViewport the lower-left corner is (0,0)
621 const int y = ( offscreen->GetHeight() - instruction.mViewport.height ) - instruction.mViewport.y;
622 viewportRect.Set( instruction.mViewport.x, y, instruction.mViewport.width, instruction.mViewport.height );
626 viewportRect.Set( 0, 0, offscreen->GetWidth(), offscreen->GetHeight() );
631 // Offscreen is NULL or could not be prepared.
635 else if( instruction.mFrameBuffer != 0 )
637 instruction.mFrameBuffer->Bind( mImpl->context );
638 if ( instruction.mIsViewportSet )
640 // For glViewport the lower-left corner is (0,0)
641 const int y = ( instruction.mFrameBuffer->GetHeight() - instruction.mViewport.height ) - instruction.mViewport.y;
642 viewportRect.Set( instruction.mViewport.x, y, instruction.mViewport.width, instruction.mViewport.height );
646 viewportRect.Set( 0, 0, instruction.mFrameBuffer->GetWidth(), instruction.mFrameBuffer->GetHeight() );
649 else // !(instruction.mOffscreenTexture)
651 // switch rendering to adaptor provided (default) buffer
652 mImpl->context.BindFramebuffer( GL_FRAMEBUFFER, 0 );
654 // Check whether a viewport is specified, otherwise the full surface size is used
655 if ( instruction.mIsViewportSet )
657 // For glViewport the lower-left corner is (0,0)
658 const int y = ( mImpl->defaultSurfaceRect.height - instruction.mViewport.height ) - instruction.mViewport.y;
659 viewportRect.Set( instruction.mViewport.x, y, instruction.mViewport.width, instruction.mViewport.height );
663 viewportRect = mImpl->defaultSurfaceRect;
667 mImpl->context.Viewport(viewportRect.x, viewportRect.y, viewportRect.width, viewportRect.height);
669 if ( instruction.mIsClearColorSet )
671 mImpl->context.ClearColor( clearColor.r,
676 // Clear the viewport area only
677 mImpl->context.SetScissorTest( true );
678 mImpl->context.Scissor( viewportRect.x, viewportRect.y, viewportRect.width, viewportRect.height );
679 mImpl->context.ColorMask( true );
680 mImpl->context.Clear( GL_COLOR_BUFFER_BIT , Context::CHECK_CACHED_VALUES );
681 mImpl->context.SetScissorTest( false );
684 Render::ProcessRenderInstruction( instruction,
688 mImpl->renderBufferIndex );
690 if(instruction.mOffscreenTextureId != 0)
692 GLenum attachments[] = { GL_DEPTH_ATTACHMENT, GL_STENCIL_ATTACHMENT };
693 mImpl->context.InvalidateFramebuffer(GL_FRAMEBUFFER, 2, attachments);
696 if( instruction.mRenderTracker && offscreen != NULL )
698 // This will create a sync object every frame this render tracker
699 // is alive (though it should be now be created only for
700 // render-once render tasks)
701 instruction.mRenderTracker->CreateSyncObject( mImpl->glSyncAbstraction );
702 instruction.mRenderTracker = NULL; // Only create once.
706 } // namespace SceneGraph
708 } // namespace Internal