2 * Copyright (c) 2017 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>
52 * Structure to contain internal data
54 struct RenderManager::Impl
56 Impl( Integration::GlAbstraction& glAbstraction,
57 Integration::GlSyncAbstraction& glSyncAbstraction )
58 : context( glAbstraction ),
59 glSyncAbstraction( glSyncAbstraction ),
63 backgroundColor( Dali::Stage::DEFAULT_BACKGROUND_COLOR ),
65 renderBufferIndex( SceneGraphBuffers::INITIAL_UPDATE_BUFFER_INDEX ),
70 frameBufferContainer(),
71 lastFrameWasRendered( false ),
72 programController( glAbstraction )
80 void AddRenderTracker( Render::RenderTracker* renderTracker )
82 DALI_ASSERT_DEBUG( renderTracker != NULL );
83 mRenderTrackers.PushBack( renderTracker );
86 void RemoveRenderTracker( Render::RenderTracker* renderTracker )
88 mRenderTrackers.EraseObject( renderTracker );
93 for( auto&& iter : mRenderTrackers )
95 iter->PollSyncObject();
99 // the order is important for destruction,
100 // programs are owned by context at the moment.
101 Context context; ///< holds the GL state
102 Integration::GlSyncAbstraction& glSyncAbstraction; ///< GL sync abstraction
103 RenderQueue renderQueue; ///< A message queue for receiving messages from the update-thread.
105 // Render instructions describe what should be rendered during RenderManager::Render()
106 // Owned by RenderManager. Update manager updates instructions for the next frame while we render the current one
107 RenderInstructionContainer instructions;
108 Render::RenderAlgorithms renderAlgorithms; ///< The RenderAlgorithms object is used to action the renders required by a RenderInstruction
110 Vector4 backgroundColor; ///< The glClear color used at the beginning of each frame.
112 unsigned int frameCount; ///< The current frame count
113 BufferIndex renderBufferIndex; ///< The index of the buffer to read from; this is opposite of the "update" buffer
115 Rect<int> defaultSurfaceRect; ///< Rectangle for the default surface we are rendering to
117 OwnerContainer< Render::Renderer* > rendererContainer; ///< List of owned renderers
118 OwnerContainer< Render::Sampler* > samplerContainer; ///< List of owned samplers
119 OwnerContainer< Render::Texture* > textureContainer; ///< List of owned textures
120 OwnerContainer< Render::FrameBuffer* > frameBufferContainer; ///< List of owned framebuffers
121 OwnerContainer< Render::PropertyBuffer* > propertyBufferContainer; ///< List of owned property buffers
122 OwnerContainer< Render::Geometry* > geometryContainer; ///< List of owned Geometries
124 bool lastFrameWasRendered; ///< Keeps track of the last frame being rendered due to having render instructions
126 OwnerContainer< Render::RenderTracker* > mRenderTrackers; ///< List of render trackers
128 ProgramController programController; ///< Owner of the GL programs
132 RenderManager* RenderManager::New( Integration::GlAbstraction& glAbstraction,
133 Integration::GlSyncAbstraction& glSyncAbstraction )
135 RenderManager* manager = new RenderManager;
136 manager->mImpl = new Impl( glAbstraction,
141 RenderManager::RenderManager()
146 RenderManager::~RenderManager()
151 RenderQueue& RenderManager::GetRenderQueue()
153 return mImpl->renderQueue;
156 void RenderManager::ContextCreated()
158 mImpl->context.GlContextCreated();
159 mImpl->programController.GlContextCreated();
161 // renderers, textures and gpu buffers cannot reinitialize themselves
162 // so they rely on someone reloading the data for them
165 void RenderManager::ContextDestroyed()
167 mImpl->context.GlContextDestroyed();
168 mImpl->programController.GlContextDestroyed();
171 for( auto&& texture : mImpl->textureContainer )
173 texture->GlContextDestroyed();
176 //Inform framebuffers
177 for( auto&& framebuffer : mImpl->frameBufferContainer )
179 framebuffer->GlContextDestroyed();
183 for( auto&& renderer : mImpl->rendererContainer )
185 renderer->GlContextDestroyed();
189 void RenderManager::SetShaderSaver( ShaderSaver& upstream )
191 mImpl->programController.SetShaderSaver( upstream );
194 RenderInstructionContainer& RenderManager::GetRenderInstructionContainer()
196 return mImpl->instructions;
199 void RenderManager::SetBackgroundColor( const Vector4& color )
201 mImpl->backgroundColor = color;
204 void RenderManager::SetDefaultSurfaceRect(const Rect<int>& rect)
206 mImpl->defaultSurfaceRect = rect;
209 void RenderManager::AddRenderer( OwnerPointer< Render::Renderer >& renderer )
211 // Initialize the renderer as we are now in render thread
212 renderer->Initialize( mImpl->context );
214 mImpl->rendererContainer.PushBack( renderer.Release() );
217 void RenderManager::RemoveRenderer( Render::Renderer* renderer )
219 mImpl->rendererContainer.EraseObject( renderer );
222 void RenderManager::AddSampler( OwnerPointer< Render::Sampler >& sampler )
224 mImpl->samplerContainer.PushBack( sampler.Release() );
227 void RenderManager::RemoveSampler( Render::Sampler* sampler )
229 mImpl->samplerContainer.EraseObject( sampler );
232 void RenderManager::AddTexture( OwnerPointer< Render::Texture >& texture )
234 texture->Initialize( mImpl->context );
235 mImpl->textureContainer.PushBack( texture.Release() );
238 void RenderManager::RemoveTexture( Render::Texture* texture )
240 DALI_ASSERT_DEBUG( NULL != texture );
242 // Find the texture, use reference to pointer so we can do the erase safely
243 for ( auto&& iter : mImpl->textureContainer )
245 if ( iter == texture )
247 texture->Destroy( mImpl->context );
248 mImpl->textureContainer.Erase( &iter ); // Texture found; now destroy it
254 void RenderManager::UploadTexture( Render::Texture* texture, PixelDataPtr pixelData, const Texture::UploadParams& params )
256 texture->Upload( mImpl->context, pixelData, params );
259 void RenderManager::GenerateMipmaps( Render::Texture* texture )
261 texture->GenerateMipmaps( mImpl->context );
264 void RenderManager::SetFilterMode( Render::Sampler* sampler, unsigned int minFilterMode, unsigned int magFilterMode )
266 sampler->mMinificationFilter = static_cast<Dali::FilterMode::Type>(minFilterMode);
267 sampler->mMagnificationFilter = static_cast<Dali::FilterMode::Type>(magFilterMode );
270 void RenderManager::SetWrapMode( Render::Sampler* sampler, unsigned int rWrapMode, unsigned int sWrapMode, unsigned int tWrapMode )
272 sampler->mRWrapMode = static_cast<Dali::WrapMode::Type>(rWrapMode);
273 sampler->mSWrapMode = static_cast<Dali::WrapMode::Type>(sWrapMode);
274 sampler->mTWrapMode = static_cast<Dali::WrapMode::Type>(tWrapMode);
277 void RenderManager::AddFrameBuffer( Render::FrameBuffer* frameBuffer )
279 mImpl->frameBufferContainer.PushBack( frameBuffer );
280 frameBuffer->Initialize(mImpl->context);
283 void RenderManager::RemoveFrameBuffer( Render::FrameBuffer* frameBuffer )
285 DALI_ASSERT_DEBUG( NULL != frameBuffer );
287 // Find the sampler, use reference so we can safely do the erase
288 for ( auto&& iter : mImpl->frameBufferContainer )
290 if ( iter == frameBuffer )
292 frameBuffer->Destroy( mImpl->context );
293 mImpl->frameBufferContainer.Erase( &iter ); // frameBuffer found; now destroy it
299 void RenderManager::AttachColorTextureToFrameBuffer( Render::FrameBuffer* frameBuffer, Render::Texture* texture, unsigned int mipmapLevel, unsigned int layer )
301 frameBuffer->AttachColorTexture( mImpl->context, texture, mipmapLevel, layer );
304 void RenderManager::AddPropertyBuffer( OwnerPointer< Render::PropertyBuffer >& propertyBuffer )
306 mImpl->propertyBufferContainer.PushBack( propertyBuffer.Release() );
309 void RenderManager::RemovePropertyBuffer( Render::PropertyBuffer* propertyBuffer )
311 mImpl->propertyBufferContainer.EraseObject( propertyBuffer );
314 void RenderManager::SetPropertyBufferFormat( Render::PropertyBuffer* propertyBuffer, OwnerPointer< Render::PropertyBuffer::Format>& format )
316 propertyBuffer->SetFormat( format.Release() );
319 void RenderManager::SetPropertyBufferData( Render::PropertyBuffer* propertyBuffer, OwnerPointer< Vector<char> >& data, size_t size )
321 propertyBuffer->SetData( data.Release(), size );
324 void RenderManager::SetIndexBuffer( Render::Geometry* geometry, Dali::Vector<unsigned short>& indices )
326 geometry->SetIndexBuffer( indices );
329 void RenderManager::AddGeometry( OwnerPointer< Render::Geometry >& geometry )
331 mImpl->geometryContainer.PushBack( geometry.Release() );
334 void RenderManager::RemoveGeometry( Render::Geometry* geometry )
336 mImpl->geometryContainer.EraseObject( geometry );
339 void RenderManager::AttachVertexBuffer( Render::Geometry* geometry, Render::PropertyBuffer* propertyBuffer )
341 DALI_ASSERT_DEBUG( NULL != geometry );
344 for ( auto&& iter : mImpl->geometryContainer )
346 if ( iter == geometry )
348 iter->AddPropertyBuffer( propertyBuffer );
354 void RenderManager::RemoveVertexBuffer( Render::Geometry* geometry, Render::PropertyBuffer* propertyBuffer )
356 DALI_ASSERT_DEBUG( NULL != geometry );
359 for ( auto&& iter : mImpl->geometryContainer )
361 if ( iter == geometry )
363 iter->RemovePropertyBuffer( propertyBuffer );
369 void RenderManager::SetGeometryType( Render::Geometry* geometry, unsigned int geometryType )
371 geometry->SetType( Render::Geometry::Type(geometryType) );
374 void RenderManager::AddRenderTracker( Render::RenderTracker* renderTracker )
376 mImpl->AddRenderTracker(renderTracker);
379 void RenderManager::RemoveRenderTracker( Render::RenderTracker* renderTracker )
381 mImpl->RemoveRenderTracker(renderTracker);
384 ProgramCache* RenderManager::GetProgramCache()
386 return &(mImpl->programController);
389 void RenderManager::Render( Integration::RenderStatus& status )
391 DALI_PRINT_RENDER_START( mImpl->renderBufferIndex );
393 // Core::Render documents that GL context must be current before calling Render
394 DALI_ASSERT_DEBUG( mImpl->context.IsGlContextCreated() );
396 // Increment the frame count at the beginning of each frame
397 ++(mImpl->frameCount);
399 // Process messages queued during previous update
400 mImpl->renderQueue.ProcessMessages( mImpl->renderBufferIndex );
402 const size_t count = mImpl->instructions.Count( mImpl->renderBufferIndex );
403 const bool haveInstructions = count > 0u;
405 // Only render if we have instructions to render, or the last frame was rendered (and therefore a clear is required).
406 if( haveInstructions || mImpl->lastFrameWasRendered )
408 // Mark that we will require a post-render step to be performed (includes swap-buffers).
409 status.SetNeedsPostRender( true );
411 // switch rendering to adaptor provided (default) buffer
412 mImpl->context.BindFramebuffer( GL_FRAMEBUFFER, 0 );
414 mImpl->context.Viewport( mImpl->defaultSurfaceRect.x,
415 mImpl->defaultSurfaceRect.y,
416 mImpl->defaultSurfaceRect.width,
417 mImpl->defaultSurfaceRect.height );
419 mImpl->context.ClearColor( mImpl->backgroundColor.r,
420 mImpl->backgroundColor.g,
421 mImpl->backgroundColor.b,
422 mImpl->backgroundColor.a );
424 mImpl->context.ClearStencil( 0 );
426 // Clear the entire color, depth and stencil buffers for the default framebuffer.
427 // It is important to clear all 3 buffers, for performance on deferred renderers like Mali
428 // e.g. previously when the depth & stencil buffers were NOT cleared, it caused the DDK to exceed a "vertex count limit",
429 // and then stall. That problem is only noticeable when rendering a large number of vertices per frame.
430 mImpl->context.SetScissorTest( false );
431 mImpl->context.ColorMask( true );
432 mImpl->context.DepthMask( true );
433 mImpl->context.StencilMask( 0xFF ); // 8 bit stencil mask, all 1's
434 mImpl->context.Clear( GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT | GL_STENCIL_BUFFER_BIT, Context::FORCE_CLEAR );
436 // reset the program matrices for all programs once per frame
437 // this ensures we will set view and projection matrix once per program per camera
438 mImpl->programController.ResetProgramMatrices();
440 for( size_t i = 0; i < count; ++i )
442 RenderInstruction& instruction = mImpl->instructions.At( mImpl->renderBufferIndex, i );
444 DoRender( instruction );
447 GLenum attachments[] = { GL_DEPTH, GL_STENCIL };
448 mImpl->context.InvalidateFramebuffer(GL_FRAMEBUFFER, 2, attachments);
450 mImpl->UpdateTrackers();
452 //Notify RenderGeometries that rendering has finished
453 for ( auto&& iter : mImpl->geometryContainer )
455 iter->OnRenderFinished();
459 // If this frame was rendered due to instructions existing, we mark this so we know to clear the next frame.
460 mImpl->lastFrameWasRendered = haveInstructions;
463 * The rendering has finished; swap to the next buffer.
464 * Ideally the update has just finished using this buffer; otherwise the render thread
465 * should block until the update has finished.
467 mImpl->renderBufferIndex = (0 != mImpl->renderBufferIndex) ? 0 : 1;
469 DALI_PRINT_RENDER_END();
472 void RenderManager::DoRender( RenderInstruction& instruction )
474 Rect<int> viewportRect;
477 if ( instruction.mIsClearColorSet )
479 clearColor = instruction.mClearColor;
483 clearColor = Dali::RenderTask::DEFAULT_CLEAR_COLOR;
486 if( instruction.mFrameBuffer != 0 )
488 instruction.mFrameBuffer->Bind( mImpl->context );
489 if ( instruction.mIsViewportSet )
491 // For glViewport the lower-left corner is (0,0)
492 const int y = ( instruction.mFrameBuffer->GetHeight() - instruction.mViewport.height ) - instruction.mViewport.y;
493 viewportRect.Set( instruction.mViewport.x, y, instruction.mViewport.width, instruction.mViewport.height );
497 viewportRect.Set( 0, 0, instruction.mFrameBuffer->GetWidth(), instruction.mFrameBuffer->GetHeight() );
500 else // !(instruction.mOffscreenTexture)
502 // switch rendering to adaptor provided (default) buffer
503 mImpl->context.BindFramebuffer( GL_FRAMEBUFFER, 0 );
505 // Check whether a viewport is specified, otherwise the full surface size is used
506 if ( instruction.mIsViewportSet )
508 // For glViewport the lower-left corner is (0,0)
509 const int y = ( mImpl->defaultSurfaceRect.height - instruction.mViewport.height ) - instruction.mViewport.y;
510 viewportRect.Set( instruction.mViewport.x, y, instruction.mViewport.width, instruction.mViewport.height );
514 viewportRect = mImpl->defaultSurfaceRect;
518 mImpl->context.Viewport(viewportRect.x, viewportRect.y, viewportRect.width, viewportRect.height);
520 if ( instruction.mIsClearColorSet )
522 mImpl->context.ClearColor( clearColor.r,
527 // Clear the viewport area only
528 mImpl->context.SetScissorTest( true );
529 mImpl->context.Scissor( viewportRect.x, viewportRect.y, viewportRect.width, viewportRect.height );
530 mImpl->context.ColorMask( true );
531 mImpl->context.Clear( GL_COLOR_BUFFER_BIT , Context::CHECK_CACHED_VALUES );
532 mImpl->context.SetScissorTest( false );
535 mImpl->renderAlgorithms.ProcessRenderInstruction( instruction, mImpl->context, mImpl->renderBufferIndex );
537 if( instruction.mRenderTracker && ( instruction.mFrameBuffer != NULL ) )
539 // This will create a sync object every frame this render tracker
540 // is alive (though it should be now be created only for
541 // render-once render tasks)
542 instruction.mRenderTracker->CreateSyncObject( mImpl->glSyncAbstraction );
543 instruction.mRenderTracker = NULL; // Only create once.
547 } // namespace SceneGraph
549 } // namespace Internal