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/queue/render-queue.h>
36 #include <dali/internal/render/renderers/render-frame-buffer.h>
37 #include <dali/internal/render/renderers/render-geometry.h>
38 #include <dali/internal/render/renderers/render-renderer.h>
39 #include <dali/internal/render/renderers/render-sampler.h>
40 #include <dali/internal/render/shaders/program-controller.h>
51 typedef OwnerContainer< Render::Renderer* > RendererOwnerContainer;
52 typedef RendererOwnerContainer::Iterator RendererOwnerIter;
54 typedef OwnerContainer< Render::Geometry* > GeometryOwnerContainer;
55 typedef GeometryOwnerContainer::Iterator GeometryOwnerIter;
57 typedef OwnerContainer< Render::Sampler* > SamplerOwnerContainer;
58 typedef SamplerOwnerContainer::Iterator SamplerOwnerIter;
60 typedef OwnerContainer< Render::Texture* > TextureOwnerContainer;
61 typedef TextureOwnerContainer::Iterator TextureOwnerIter;
63 typedef OwnerContainer< Render::FrameBuffer* > FrameBufferOwnerContainer;
64 typedef FrameBufferOwnerContainer::Iterator FrameBufferOwnerIter;
66 typedef OwnerContainer< Render::PropertyBuffer* > PropertyBufferOwnerContainer;
67 typedef PropertyBufferOwnerContainer::Iterator PropertyBufferOwnerIter;
69 typedef OwnerContainer< Render::RenderTracker* > RenderTrackerContainer;
70 typedef RenderTrackerContainer::Iterator RenderTrackerIter;
71 typedef RenderTrackerContainer::ConstIterator RenderTrackerConstIter;
74 * Structure to contain internal data
76 struct RenderManager::Impl
78 Impl( Integration::GlAbstraction& glAbstraction,
79 Integration::GlSyncAbstraction& glSyncAbstraction )
80 : context( glAbstraction ),
81 glSyncAbstraction( glSyncAbstraction ),
84 backgroundColor( Dali::Stage::DEFAULT_BACKGROUND_COLOR ),
86 renderBufferIndex( SceneGraphBuffers::INITIAL_UPDATE_BUFFER_INDEX ),
91 frameBufferContainer(),
92 renderersAdded( false ),
93 programController( glAbstraction )
101 void AddRenderTracker( Render::RenderTracker* renderTracker )
103 DALI_ASSERT_DEBUG( renderTracker != NULL );
104 mRenderTrackers.PushBack( renderTracker );
107 void RemoveRenderTracker( Render::RenderTracker* renderTracker )
109 DALI_ASSERT_DEBUG( renderTracker != NULL );
110 for(RenderTrackerIter iter = mRenderTrackers.Begin(), end = mRenderTrackers.End(); iter != end; ++iter)
112 if( *iter == renderTracker )
114 mRenderTrackers.Erase( iter );
120 void UpdateTrackers()
122 for(RenderTrackerIter iter = mRenderTrackers.Begin(), end = mRenderTrackers.End(); iter != end; ++iter)
124 (*iter)->PollSyncObject();
128 // the order is important for destruction,
129 // programs are owned by context at the moment.
130 Context context; ///< holds the GL state
131 Integration::GlSyncAbstraction& glSyncAbstraction; ///< GL sync abstraction
132 RenderQueue renderQueue; ///< A message queue for receiving messages from the update-thread.
134 // Render instructions describe what should be rendered during RenderManager::Render()
135 // Owned by RenderManager. Update manager updates instructions for the next frame while we render the current one
136 RenderInstructionContainer instructions;
138 Vector4 backgroundColor; ///< The glClear color used at the beginning of each frame.
140 unsigned int frameCount; ///< The current frame count
141 BufferIndex renderBufferIndex; ///< The index of the buffer to read from; this is opposite of the "update" buffer
143 Rect<int> defaultSurfaceRect; ///< Rectangle for the default surface we are rendering to
145 RendererOwnerContainer rendererContainer; ///< List of owned renderers
146 SamplerOwnerContainer samplerContainer; ///< List of owned samplers
147 TextureOwnerContainer textureContainer; ///< List of owned textures
148 FrameBufferOwnerContainer frameBufferContainer; ///< List of owned framebuffers
149 PropertyBufferOwnerContainer propertyBufferContainer; ///< List of owned property buffers
150 GeometryOwnerContainer geometryContainer; ///< List of owned Geometries
154 RenderTrackerContainer mRenderTrackers; ///< List of render trackers
156 ProgramController programController; ///< Owner of the GL programs
160 RenderManager* RenderManager::New( Integration::GlAbstraction& glAbstraction,
161 Integration::GlSyncAbstraction& glSyncAbstraction )
163 RenderManager* manager = new RenderManager;
164 manager->mImpl = new Impl( glAbstraction,
169 RenderManager::RenderManager()
174 RenderManager::~RenderManager()
179 RenderQueue& RenderManager::GetRenderQueue()
181 return mImpl->renderQueue;
184 void RenderManager::ContextCreated()
186 mImpl->context.GlContextCreated();
187 mImpl->programController.GlContextCreated();
189 // renderers, textures and gpu buffers cannot reinitialize themselves
190 // so they rely on someone reloading the data for them
193 void RenderManager::ContextDestroyed()
195 mImpl->context.GlContextDestroyed();
196 mImpl->programController.GlContextDestroyed();
199 for( TextureOwnerIter iter = mImpl->textureContainer.Begin(); iter != mImpl->textureContainer.End(); ++iter )
201 (*iter)->GlContextDestroyed();
204 //Inform framebuffers
205 for( FrameBufferOwnerIter iter = mImpl->frameBufferContainer.Begin(); iter != mImpl->frameBufferContainer.End(); ++iter )
207 (*iter)->GlContextDestroyed();
211 RendererOwnerContainer::Iterator end = mImpl->rendererContainer.End();
212 RendererOwnerContainer::Iterator iter = mImpl->rendererContainer.Begin();
213 for( ; iter != end; ++iter )
215 GlResourceOwner* renderer = *iter;
216 renderer->GlContextDestroyed(); // Clear up vertex buffers
220 void RenderManager::SetShaderSaver( ShaderSaver& upstream )
222 mImpl->programController.SetShaderSaver( upstream );
225 RenderInstructionContainer& RenderManager::GetRenderInstructionContainer()
227 return mImpl->instructions;
230 void RenderManager::SetBackgroundColor( const Vector4& color )
232 mImpl->backgroundColor = color;
235 void RenderManager::SetDefaultSurfaceRect(const Rect<int>& rect)
237 mImpl->defaultSurfaceRect = rect;
240 void RenderManager::AddRenderer( Render::Renderer* renderer )
242 // Initialize the renderer as we are now in render thread
243 renderer->Initialize( mImpl->context );
245 mImpl->rendererContainer.PushBack( renderer );
247 if( !mImpl->renderersAdded )
249 mImpl->renderersAdded = true;
253 void RenderManager::RemoveRenderer( Render::Renderer* renderer )
255 DALI_ASSERT_DEBUG( NULL != renderer );
257 RendererOwnerContainer& renderers = mImpl->rendererContainer;
260 for ( RendererOwnerIter iter = renderers.Begin(); iter != renderers.End(); ++iter )
262 if ( *iter == renderer )
264 renderers.Erase( iter ); // Renderer found; now destroy it
270 void RenderManager::AddSampler( Render::Sampler* sampler )
272 mImpl->samplerContainer.PushBack( sampler );
275 void RenderManager::RemoveSampler( Render::Sampler* sampler )
277 DALI_ASSERT_DEBUG( NULL != sampler );
279 SamplerOwnerContainer& samplers = mImpl->samplerContainer;
282 for ( SamplerOwnerIter iter = samplers.Begin(); iter != samplers.End(); ++iter )
284 if ( *iter == sampler )
286 samplers.Erase( iter ); // Sampler found; now destroy it
292 void RenderManager::AddTexture( Render::Texture* texture )
294 mImpl->textureContainer.PushBack( texture );
295 texture->Initialize(mImpl->context);
298 void RenderManager::RemoveTexture( Render::Texture* texture )
300 DALI_ASSERT_DEBUG( NULL != texture );
302 TextureOwnerContainer& textures = mImpl->textureContainer;
305 for ( TextureOwnerIter iter = textures.Begin(); iter != textures.End(); ++iter )
307 if ( *iter == texture )
309 texture->Destroy( mImpl->context );
310 textures.Erase( iter ); // Texture found; now destroy it
316 void RenderManager::UploadTexture( Render::Texture* texture, PixelDataPtr pixelData, const Texture::UploadParams& params )
318 texture->Upload( mImpl->context, pixelData, params );
321 void RenderManager::GenerateMipmaps( Render::Texture* texture )
323 texture->GenerateMipmaps( mImpl->context );
326 void RenderManager::SetFilterMode( Render::Sampler* sampler, unsigned int minFilterMode, unsigned int magFilterMode )
328 sampler->mMinificationFilter = static_cast<Dali::FilterMode::Type>(minFilterMode);
329 sampler->mMagnificationFilter = static_cast<Dali::FilterMode::Type>(magFilterMode );
332 void RenderManager::SetWrapMode( Render::Sampler* sampler, unsigned int rWrapMode, unsigned int sWrapMode, unsigned int tWrapMode )
334 sampler->mRWrapMode = static_cast<Dali::WrapMode::Type>(rWrapMode);
335 sampler->mSWrapMode = static_cast<Dali::WrapMode::Type>(sWrapMode);
336 sampler->mTWrapMode = static_cast<Dali::WrapMode::Type>(tWrapMode);
339 void RenderManager::AddFrameBuffer( Render::FrameBuffer* frameBuffer )
341 mImpl->frameBufferContainer.PushBack( frameBuffer );
342 frameBuffer->Initialize(mImpl->context);
345 void RenderManager::RemoveFrameBuffer( Render::FrameBuffer* frameBuffer )
347 DALI_ASSERT_DEBUG( NULL != frameBuffer );
349 FrameBufferOwnerContainer& framebuffers = mImpl->frameBufferContainer;
352 for ( FrameBufferOwnerIter iter = framebuffers.Begin(); iter != framebuffers.End(); ++iter )
354 if ( *iter == frameBuffer )
356 frameBuffer->Destroy( mImpl->context );
357 framebuffers.Erase( iter ); // frameBuffer found; now destroy it
363 void RenderManager::AttachColorTextureToFrameBuffer( Render::FrameBuffer* frameBuffer, Render::Texture* texture, unsigned int mipmapLevel, unsigned int layer )
365 frameBuffer->AttachColorTexture( mImpl->context, texture, mipmapLevel, layer );
368 void RenderManager::AddPropertyBuffer( Render::PropertyBuffer* propertyBuffer )
370 mImpl->propertyBufferContainer.PushBack( propertyBuffer );
373 void RenderManager::RemovePropertyBuffer( Render::PropertyBuffer* propertyBuffer )
375 DALI_ASSERT_DEBUG( NULL != propertyBuffer );
377 PropertyBufferOwnerContainer& propertyBuffers = mImpl->propertyBufferContainer;
380 for ( PropertyBufferOwnerIter iter = propertyBuffers.Begin(); iter != propertyBuffers.End(); ++iter )
382 if ( *iter == propertyBuffer )
384 propertyBuffers.Erase( iter ); // Property buffer found; now destroy it
390 void RenderManager::SetPropertyBufferFormat(Render::PropertyBuffer* propertyBuffer, Render::PropertyBuffer::Format* format )
392 propertyBuffer->SetFormat( format );
395 void RenderManager::SetPropertyBufferData( Render::PropertyBuffer* propertyBuffer, Dali::Vector<char>* data, size_t size )
397 propertyBuffer->SetData( data, size );
400 void RenderManager::SetIndexBuffer( Render::Geometry* geometry, Dali::Vector<unsigned short>& indices )
402 geometry->SetIndexBuffer( indices );
405 void RenderManager::AddGeometry( Render::Geometry* geometry )
407 mImpl->geometryContainer.PushBack( geometry );
410 void RenderManager::RemoveGeometry( Render::Geometry* geometry )
412 DALI_ASSERT_DEBUG( NULL != geometry );
414 GeometryOwnerContainer& geometries = mImpl->geometryContainer;
417 for ( GeometryOwnerIter iter = geometries.Begin(); iter != geometries.End(); ++iter )
419 if ( *iter == geometry )
421 geometries.Erase( iter ); // Geometry found; now destroy it
427 void RenderManager::AddVertexBuffer( Render::Geometry* geometry, Render::PropertyBuffer* propertyBuffer )
429 DALI_ASSERT_DEBUG( NULL != geometry );
431 GeometryOwnerContainer& geometries = mImpl->geometryContainer;
434 for ( GeometryOwnerIter iter = geometries.Begin(); iter != geometries.End(); ++iter )
436 if ( *iter == geometry )
438 (*iter)->AddPropertyBuffer( propertyBuffer );
444 void RenderManager::RemoveVertexBuffer( Render::Geometry* geometry, Render::PropertyBuffer* propertyBuffer )
446 DALI_ASSERT_DEBUG( NULL != geometry );
448 GeometryOwnerContainer& geometries = mImpl->geometryContainer;
451 for ( GeometryOwnerIter iter = geometries.Begin(); iter != geometries.End(); ++iter )
453 if ( *iter == geometry )
455 (*iter)->RemovePropertyBuffer( propertyBuffer );
461 void RenderManager::SetGeometryType( Render::Geometry* geometry, unsigned int geometryType )
463 geometry->SetType( Render::Geometry::Type(geometryType) );
466 void RenderManager::AddRenderTracker( Render::RenderTracker* renderTracker )
468 mImpl->AddRenderTracker(renderTracker);
471 void RenderManager::RemoveRenderTracker( Render::RenderTracker* renderTracker )
473 mImpl->RemoveRenderTracker(renderTracker);
476 ProgramCache* RenderManager::GetProgramCache()
478 return &(mImpl->programController);
481 void RenderManager::Render( Integration::RenderStatus& status )
483 DALI_PRINT_RENDER_START( mImpl->renderBufferIndex );
485 // Core::Render documents that GL context must be current before calling Render
486 DALI_ASSERT_DEBUG( mImpl->context.IsGlContextCreated() );
488 // Increment the frame count at the beginning of each frame
489 ++(mImpl->frameCount);
491 // Process messages queued during previous update
492 mImpl->renderQueue.ProcessMessages( mImpl->renderBufferIndex );
494 // switch rendering to adaptor provided (default) buffer
495 mImpl->context.BindFramebuffer( GL_FRAMEBUFFER, 0 );
497 mImpl->context.Viewport( mImpl->defaultSurfaceRect.x,
498 mImpl->defaultSurfaceRect.y,
499 mImpl->defaultSurfaceRect.width,
500 mImpl->defaultSurfaceRect.height );
502 mImpl->context.ClearColor( mImpl->backgroundColor.r,
503 mImpl->backgroundColor.g,
504 mImpl->backgroundColor.b,
505 mImpl->backgroundColor.a );
507 mImpl->context.ClearStencil( 0 );
509 // Clear the entire color, depth and stencil buffers for the default framebuffer.
510 // It is important to clear all 3 buffers, for performance on deferred renderers like Mali
511 // e.g. previously when the depth & stencil buffers were NOT cleared, it caused the DDK to exceed a "vertex count limit",
512 // and then stall. That problem is only noticeable when rendering a large number of vertices per frame.
513 mImpl->context.SetScissorTest( false );
514 mImpl->context.ColorMask( true );
515 mImpl->context.DepthMask( true );
516 mImpl->context.StencilMask( 0xFF ); // 8 bit stencil mask, all 1's
517 mImpl->context.Clear( GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT | GL_STENCIL_BUFFER_BIT, Context::FORCE_CLEAR );
519 // reset the program matrices for all programs once per frame
520 // this ensures we will set view and projection matrix once per program per camera
521 mImpl->programController.ResetProgramMatrices();
523 size_t count = mImpl->instructions.Count( mImpl->renderBufferIndex );
524 for ( size_t i = 0; i < count; ++i )
526 RenderInstruction& instruction = mImpl->instructions.At( mImpl->renderBufferIndex, i );
528 DoRender( instruction );
530 GLenum attachments[] = { GL_DEPTH, GL_STENCIL };
531 mImpl->context.InvalidateFramebuffer(GL_FRAMEBUFFER, 2, attachments);
533 mImpl->UpdateTrackers();
535 //Notify RenderGeometries that rendering has finished
536 for ( GeometryOwnerIter iter = mImpl->geometryContainer.Begin(); iter != mImpl->geometryContainer.End(); ++iter )
538 (*iter)->OnRenderFinished();
542 * The rendering has finished; swap to the next buffer.
543 * Ideally the update has just finished using this buffer; otherwise the render thread
544 * should block until the update has finished.
546 mImpl->renderBufferIndex = (0 != mImpl->renderBufferIndex) ? 0 : 1;
548 DALI_PRINT_RENDER_END();
551 void RenderManager::DoRender( RenderInstruction& instruction )
553 Rect<int> viewportRect;
556 if ( instruction.mIsClearColorSet )
558 clearColor = instruction.mClearColor;
562 clearColor = Dali::RenderTask::DEFAULT_CLEAR_COLOR;
565 if( instruction.mFrameBuffer != 0 )
567 instruction.mFrameBuffer->Bind( mImpl->context );
568 if ( instruction.mIsViewportSet )
570 // For glViewport the lower-left corner is (0,0)
571 const int y = ( instruction.mFrameBuffer->GetHeight() - instruction.mViewport.height ) - instruction.mViewport.y;
572 viewportRect.Set( instruction.mViewport.x, y, instruction.mViewport.width, instruction.mViewport.height );
576 viewportRect.Set( 0, 0, instruction.mFrameBuffer->GetWidth(), instruction.mFrameBuffer->GetHeight() );
579 else // !(instruction.mOffscreenTexture)
581 // switch rendering to adaptor provided (default) buffer
582 mImpl->context.BindFramebuffer( GL_FRAMEBUFFER, 0 );
584 // Check whether a viewport is specified, otherwise the full surface size is used
585 if ( instruction.mIsViewportSet )
587 // For glViewport the lower-left corner is (0,0)
588 const int y = ( mImpl->defaultSurfaceRect.height - instruction.mViewport.height ) - instruction.mViewport.y;
589 viewportRect.Set( instruction.mViewport.x, y, instruction.mViewport.width, instruction.mViewport.height );
593 viewportRect = mImpl->defaultSurfaceRect;
597 mImpl->context.Viewport(viewportRect.x, viewportRect.y, viewportRect.width, viewportRect.height);
599 if ( instruction.mIsClearColorSet )
601 mImpl->context.ClearColor( clearColor.r,
606 // Clear the viewport area only
607 mImpl->context.SetScissorTest( true );
608 mImpl->context.Scissor( viewportRect.x, viewportRect.y, viewportRect.width, viewportRect.height );
609 mImpl->context.ColorMask( true );
610 mImpl->context.Clear( GL_COLOR_BUFFER_BIT , Context::CHECK_CACHED_VALUES );
611 mImpl->context.SetScissorTest( false );
614 Render::ProcessRenderInstruction( instruction,
616 mImpl->renderBufferIndex );
618 if( instruction.mRenderTracker && ( instruction.mFrameBuffer != NULL ) )
620 // This will create a sync object every frame this render tracker
621 // is alive (though it should be now be created only for
622 // render-once render tasks)
623 instruction.mRenderTracker->CreateSyncObject( mImpl->glSyncAbstraction );
624 instruction.mRenderTracker = NULL; // Only create once.
628 } // namespace SceneGraph
630 } // namespace Internal