1 #ifndef DALI_EGL_GRAPHICS_CONTROLLER_H
2 #define DALI_EGL_GRAPHICS_CONTROLLER_H
5 * Copyright (c) 2021 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
21 #include <dali/graphics-api/graphics-controller.h>
25 #include <dali/integration-api/graphics-sync-abstraction.h>
26 #include <dali/internal/graphics/common/graphics-interface.h>
27 #include <dali/internal/graphics/gles-impl/gles-context.h>
28 #include <dali/internal/graphics/gles-impl/gles-graphics-buffer.h>
29 #include <dali/internal/graphics/gles-impl/gles-graphics-command-buffer.h>
30 #include <dali/internal/graphics/gles-impl/gles-graphics-framebuffer.h>
31 #include <dali/internal/graphics/gles-impl/gles-graphics-pipeline-cache.h>
32 #include <dali/internal/graphics/gles-impl/gles-graphics-pipeline.h>
33 #include <dali/internal/graphics/gles-impl/gles-graphics-reflection.h>
34 #include <dali/internal/graphics/gles-impl/gles-graphics-sampler.h>
35 #include <dali/internal/graphics/gles-impl/gles-graphics-shader.h>
36 #include <dali/internal/graphics/gles-impl/gles-graphics-texture.h>
37 #include <dali/internal/graphics/gles-impl/gles-graphics-types.h>
38 #include <dali/internal/graphics/gles-impl/gles2-graphics-memory.h>
45 class GlContextHelperAbstraction;
46 } // namespace Integration
57 * EGL Implementation of the graphics controller.
59 * Temporarily holds the old GL abstractions whilst dali-core is migrated to the new API.
61 class EglGraphicsController : public Graphics::Controller
65 * @brief Deault constructor
67 EglGraphicsController() = default;
72 ~EglGraphicsController() override;
75 * Initialize the GLES abstraction. This can be called from the main thread.
77 void InitializeGLES(Integration::GlAbstraction& glAbstraction);
80 * Initialize with a reference to the GL abstractions.
82 * Note, this is now executed in the render thread, after core initialization
84 void Initialize(Integration::GraphicsSyncAbstraction& syncImplementation,
85 Integration::GlContextHelperAbstraction& glContextHelperAbstraction,
86 Internal::Adaptor::GraphicsInterface& graphicsInterface);
88 Integration::GlAbstraction& GetGlAbstraction() override;
89 Integration::GlContextHelperAbstraction& GetGlContextHelperAbstraction() override;
90 Internal::Adaptor::EglSyncImplementation& GetEglSyncImplementation();
93 * @copydoc Dali::Graphics::SubmitCommandBuffers()
95 void SubmitCommandBuffers(const SubmitInfo& submitInfo) override;
98 * @copydoc Dali::Graphics::PresentRenderTarget()
100 void PresentRenderTarget(RenderTarget* renderTarget) override;
103 * @copydoc Dali::Graphics::WaitIdle()
105 void WaitIdle() override
110 * @copydoc Dali::Graphics::Pause()
112 void Pause() override
117 * @copydoc Dali::Graphics::Resume()
119 void Resume() override
124 * @copydoc Dali::Graphics::Shutdown()
126 void Shutdown() override
128 mIsShuttingDown = true;
132 * @copydoc Dali::Graphics::Destroy()
134 void Destroy() override
141 mContext->GlContextDestroyed();
144 for(auto&& context : mSurfaceContexts)
148 context.second->GlContextDestroyed();
154 * @copydoc Dali::Graphics::UpdateTextures()
156 void UpdateTextures(const std::vector<TextureUpdateInfo>& updateInfoList,
157 const std::vector<TextureUpdateSourceInfo>& sourceList) override;
160 * @copydoc Dali::Graphics::GenerateTextureMipmaps()
162 void GenerateTextureMipmaps(const Texture& texture) override;
165 * @copydoc Dali::Graphics::EnableDepthStencilBuffer()
167 bool EnableDepthStencilBuffer(bool enableDepth, bool enableStencil) override
173 * @copydoc Dali::Graphics::RunGarbageCollector()
175 void RunGarbageCollector(size_t numberOfDiscardedRenderers) override
180 * @copydoc Dali::Graphics::DiscardUnusedResources()
182 void DiscardUnusedResources() override
187 * @copydoc Dali::Graphics::IsDiscardQueueEmpty()
189 bool IsDiscardQueueEmpty() override
195 * @copydoc Dali::Graphics::IsDrawOnResumeRequired()
197 bool IsDrawOnResumeRequired() override
203 * @copydoc Dali::Graphics::CreateBuffer()
205 Graphics::UniquePtr<Buffer> CreateBuffer(const BufferCreateInfo& bufferCreateInfo, Graphics::UniquePtr<Buffer>&& oldBuffer) override;
208 * @copydoc Dali::Graphics::CreateCommandBuffer()
210 Graphics::UniquePtr<CommandBuffer> CreateCommandBuffer(const CommandBufferCreateInfo& commandBufferCreateInfo, Graphics::UniquePtr<CommandBuffer>&& oldCommandBuffer) override;
213 * @copydoc Dali::Graphics::CreateRenderPass()
215 Graphics::UniquePtr<RenderPass> CreateRenderPass(const RenderPassCreateInfo& renderPassCreateInfo, Graphics::UniquePtr<RenderPass>&& oldRenderPass) override;
218 * @copydoc Dali::Graphics::CreateTexture()
220 Graphics::UniquePtr<Texture> CreateTexture(const TextureCreateInfo& textureCreateInfo, Graphics::UniquePtr<Texture>&& oldTexture) override;
223 * @copydoc Dali::Graphics::CreateFramebuffer()
225 Graphics::UniquePtr<Framebuffer> CreateFramebuffer(const FramebufferCreateInfo& framebufferCreateInfo, Graphics::UniquePtr<Framebuffer>&& oldFramebuffer) override;
228 * @copydoc Dali::Graphics::CreatePipeline()
230 Graphics::UniquePtr<Pipeline> CreatePipeline(const PipelineCreateInfo& pipelineCreateInfo, Graphics::UniquePtr<Pipeline>&& oldPipeline) override;
233 * @copydoc Dali::Graphics::CreateProgram()
235 Graphics::UniquePtr<Program> CreateProgram(const ProgramCreateInfo& programCreateInfo, UniquePtr<Program>&& oldProgram) override;
238 * @copydoc Dali::Graphics::CreateShader()
240 Graphics::UniquePtr<Shader> CreateShader(const ShaderCreateInfo& shaderCreateInfo, Graphics::UniquePtr<Shader>&& oldShader) override;
243 * @copydoc Dali::Graphics::CreateSampler()
245 Graphics::UniquePtr<Sampler> CreateSampler(const SamplerCreateInfo& samplerCreateInfo, Graphics::UniquePtr<Sampler>&& oldSampler) override;
248 * @copydoc Dali::Graphics::CreateRenderTarget()
250 Graphics::UniquePtr<RenderTarget> CreateRenderTarget(const RenderTargetCreateInfo& renderTargetCreateInfo, Graphics::UniquePtr<RenderTarget>&& oldRenderTarget) override;
253 * @copydoc Dali::Graphics::CreateSyncObject()
255 Graphics::UniquePtr<SyncObject> CreateSyncObject(const SyncObjectCreateInfo& syncObjectCreateInfo,
256 Graphics::UniquePtr<SyncObject>&& oldSyncObject) override;
259 * @copydoc Dali::Graphics::MapBufferRange()
261 Graphics::UniquePtr<Memory> MapBufferRange(const MapBufferInfo& mapInfo) override;
264 * @copydoc Dali::Graphics::MapTextureRange()
266 Graphics::UniquePtr<Memory> MapTextureRange(const MapTextureInfo& mapInfo) override
272 * @copydoc Dali::Graphics::UnmapMemory()
274 void UnmapMemory(Graphics::UniquePtr<Memory> memory) override
278 * @copydoc Dali::Graphics::GetTextureMemoryRequirements()
280 MemoryRequirements GetTextureMemoryRequirements(Texture& texture) const override
286 * @copydoc Dali::Graphics::GetBufferMemoryRequirements()
288 MemoryRequirements GetBufferMemoryRequirements(Buffer& buffer) const override
294 * @copydoc Dali::Graphics::GetTextureProperties()
296 const TextureProperties& GetTextureProperties(const Texture& texture) override
298 // for compiler not to moan
299 static TextureProperties dummy{};
304 * @copydoc Dali::Graphics::Controller::GetPipelineReflection()
307 [[nodiscard]] const Reflection& GetProgramReflection(const Graphics::Program& program) override;
310 * @copydoc Dali::Graphics::PipelineEquals()
312 [[nodiscard]] bool PipelineEquals(const Pipeline& pipeline0, const Pipeline& pipeline1) const override
317 [[nodiscard]] Integration::GlAbstraction* GetGL() const
323 return mGlAbstraction;
326 [[nodiscard]] Internal::Adaptor::GraphicsInterface* GetGraphicsInterface() const
332 void AddTexture(GLES::Texture& texture);
335 * @brief Adds buffer to the creation queue
338 void AddBuffer(GLES::Buffer& buffer);
341 * @brief Adds framebuffer to the creation queue
344 void AddFramebuffer(GLES::Framebuffer& framebuffer);
347 * @brief Pushes Bufer to the discard queue
349 * Function is called from the UniquePtr custom deleter.
351 * @param[in] texture Pointer to the texture
353 void DiscardResource(GLES::Texture* texture)
355 mDiscardTextureQueue.push(texture);
359 * @brief Pushes Buffer to the discard queue
361 * Function is called from the UniquePtr custom deleter.
363 * @param[in] buffer Pointer to the buffer object
365 void DiscardResource(GLES::Buffer* buffer)
367 mDiscardBufferQueue.push(buffer);
371 * @brief Pushes framebuffer to the discard queue
373 * Function is called from the UniquePtr custom deleter.
375 * @param[in] framebuffer Pointer to the framebuffer object
377 void DiscardResource(GLES::Framebuffer* framebuffer)
379 mDiscardFramebufferQueue.push(framebuffer);
383 * @brief Pushes Program to the discard queue
385 * Function is called from the UniquePtr custom deleter.
387 * @param[in] program Pointer to the program
389 void DiscardResource(GLES::Program* program)
391 mDiscardProgramQueue.push(program);
395 * @brief Pushes RenderPass to the discard queue
397 * Function is called from the UniquePtr custom deleter.
399 * @param[in] program Pointer to the RenderPass
401 void DiscardResource(GLES::RenderPass* renderPass)
403 mDiscardRenderPassQueue.push(renderPass);
407 * @brief Pushes RenderTarget to the discard queue
409 * Function is called from the UniquePtr custom deleter.
411 * @param[in] program Pointer to the RenderTarget
413 void DiscardResource(GLES::RenderTarget* renderTarget)
415 mDiscardRenderTargetQueue.push(renderTarget);
419 * @brief Pushes Shader to the discard queue
421 * Function is called from the UniquePtr custom deleter.
423 * @param[in] program Pointer to the Shader
425 void DiscardResource(GLES::Shader* shader)
427 mDiscardShaderQueue.push(shader);
431 * @brief Pushes CommandBuffer to the discard queue
433 * Function is called from the UniquePtr custom deleter.
435 * @param[in] program Pointer to the CommandBuffer
437 void DiscardResource(GLES::CommandBuffer* commandBuffer)
439 mDiscardCommandBufferQueue.push(commandBuffer);
443 * @brief Pushes Sampler to the discard queue
445 * Function is called from the UniquePtr custom deleter.
447 * @param[in] program Pointer to the Sampler
449 void DiscardResource(GLES::Sampler* sampler)
451 mDiscardSamplerQueue.push(sampler);
455 * @brief Pushes Pipeline to the discard queue
457 * Function is called from the UniquePtr custom deleter.
459 * @param[in] program Pointer to the pipeline
461 void DiscardResource(GLES::Pipeline* pipeline)
463 mDiscardPipelineQueue.push(pipeline);
467 * @brief Flushes all pending updates
469 * Function flushes all pending resource constructions,
470 * executes command buffers and empties discard queues.
474 if(!mCreateTextureQueue.empty() ||
475 !mCreateBufferQueue.empty() ||
476 !mCreateFramebufferQueue.empty() ||
477 !mTextureUpdateRequests.empty() ||
478 !mTextureMipmapGenerationRequests.empty())
480 mGraphics->ActivateResourceContext();
484 ProcessCreateQueues();
487 ProcessTextureUpdateQueue();
489 // Process texture mipmap generation requests
490 ProcessTextureMipmapGenerationQueue();
492 // Process main command queue
493 ProcessCommandQueues();
495 // Reset texture cache in the contexts while destroying textures
498 // Reset buffer cache in the contexts while destroying buffers
502 ProcessDiscardQueues();
504 // Flush pipeline cache to remove unused pipelines
507 mPipelineCache->FlushCache();
511 // Test update to tick controller, usually it will run own thread
512 void ProcessDiscardQueues();
515 * @brief Processes a create queue for type specified
517 * @param[in,out] queue Reference to the create queue
520 void ProcessCreateQueue(T& queue)
522 while(!queue.empty())
524 auto* object = queue.front();
527 // Initialize texture
528 if(!object->InitializeResource())
530 // TODO: handle error
536 * @brief Processes a discard queue for type specified
538 * @param[in,out] queue Reference to the discard queue
540 template<class U, class T>
541 void ProcessDiscardQueue(T& queue)
543 while(!queue.empty())
545 auto* object = const_cast<U*>(queue.front());
548 object->DestroyResource();
551 auto* clbk = object->GetCreateInfo().allocationCallbacks;
558 clbk->freeCallback(object, clbk->userData);
569 * @brief Processes a discard queue for pipeline
571 * @param[in,out] queue Reference to the create queue
573 void ProcessDiscardQueue(std::queue<GLES::Pipeline*>& queue)
575 while(!queue.empty())
577 auto* object = const_cast<GLES::Pipeline*>(queue.front());
579 // Inform the contexts to invalidate the pipeline if cached
582 mContext->InvalidateCachedPipeline(object);
585 for(auto&& context : mSurfaceContexts)
589 context.second->InvalidateCachedPipeline(object);
594 object->DestroyResource();
597 auto* clbk = object->GetCreateInfo().allocationCallbacks;
601 using GLESPipeline = GLES::Pipeline;
602 object->~GLESPipeline();
605 clbk->freeCallback(object, clbk->userData);
616 * @brief Processes all resource create queues
618 void ProcessCreateQueues();
621 * @brief Process command queues and buffers
623 void ProcessCommandQueues();
626 * @brief Executes all pending texture updates
628 void ProcessTextureUpdateQueue();
631 * @brief Executes all pending texture mipmap generation
633 void ProcessTextureMipmapGenerationQueue();
636 * @brief Returns program custom parameter
638 * This function can be used as a backdoor in order to retrieve
639 * certain data out of implementation
641 * @param[in] program Valid Program object
642 * @param parameterId Integer id of parameter
643 * @param outData Output data
644 * @return True if parameter retrieved
646 bool GetProgramParameter(Graphics::Program& program, uint32_t parameterId, void* outData) override;
649 * @brief Returns pipeline cache object
651 * @return Valid pipeline cache object
653 [[nodiscard]] GLES::PipelineCache& GetPipelineCache() const;
656 * @brief Returns runtime supported GLES version
658 * @return GLES version enum
660 GLES::GLESVersion GetGLESVersion() const
666 * @brief Sets runtime supported GLES version
668 * @param[in] glesVersion The runtime supported GLES version
670 void SetGLESVersion(GLES::GLESVersion glesVersion)
672 mGLESVersion = glesVersion;
675 bool IsShuttingDown() const
677 return mIsShuttingDown;
681 * @brief Reset texture cache in the contexts
683 void ResetTextureCache()
687 mContext->GetGLStateCache().ResetTextureCache();
690 for(auto& context : mSurfaceContexts)
694 context.second->GetGLStateCache().ResetTextureCache();
700 * @brief Reset buffer cache in the contexts
702 void ResetBufferCache()
706 mContext->GetGLStateCache().ResetBufferCache();
709 for(auto& context : mSurfaceContexts)
713 context.second->GetGLStateCache().ResetBufferCache();
718 void ProcessCommandBuffer(const GLES::CommandBuffer& commandBuffer);
720 // Resolves presentation
721 void ResolvePresentRenderTarget(GLES::RenderTarget* renderTarget);
724 * Creates a GLES context for the given render surface
726 * @param[in] surface The surface whose GLES context to be created.
728 void CreateSurfaceContext(Dali::RenderSurfaceInterface* surface);
731 * Deletes a GLES context
733 * @param[in] surface The surface whose GLES context to be deleted.
735 void DeleteSurfaceContext(Dali::RenderSurfaceInterface* surface);
738 * Activate the resource context (shared surfaceless context)
740 void ActivateResourceContext();
743 * Activate the surface context
745 * @param[in] surface The surface whose context to be switched to.
747 void ActivateSurfaceContext(Dali::RenderSurfaceInterface* surface);
750 * @brief Returns the current context
752 * @return the current context
754 GLES::Context* GetCurrentContext() const
756 return mCurrentContext;
760 Integration::GlAbstraction* mGlAbstraction{nullptr};
761 Integration::GlContextHelperAbstraction* mGlContextHelperAbstraction{nullptr};
763 Internal::Adaptor::EglSyncImplementation* mEglSyncImplementation{nullptr};
764 Internal::Adaptor::GraphicsInterface* mGraphics{nullptr}; // Pointer to owning structure via interface.
766 std::queue<GLES::Texture*> mCreateTextureQueue; ///< Create queue for texture resource
767 std::queue<GLES::Texture*> mDiscardTextureQueue; ///< Discard queue for texture resource
769 std::queue<GLES::Buffer*> mCreateBufferQueue; ///< Create queue for buffer resource
770 std::queue<GLES::Buffer*> mDiscardBufferQueue; ///< Discard queue for buffer resource
772 std::queue<GLES::Program*> mDiscardProgramQueue; ///< Discard queue for program resource
773 std::queue<GLES::Pipeline*> mDiscardPipelineQueue; ///< Discard queue of pipelines
774 std::queue<GLES::RenderPass*> mDiscardRenderPassQueue; ///< Discard queue for renderpass resource
775 std::queue<GLES::RenderTarget*> mDiscardRenderTargetQueue; ///< Discard queue for rendertarget resource
776 std::queue<GLES::Shader*> mDiscardShaderQueue; ///< Discard queue of shaders
777 std::queue<GLES::Sampler*> mDiscardSamplerQueue; ///< Discard queue of samplers
778 std::queue<const GLES::CommandBuffer*> mDiscardCommandBufferQueue; ///< Discard queue of command buffers
779 std::queue<GLES::Framebuffer*> mCreateFramebufferQueue; ///< Create queue for framebuffer resource
780 std::queue<GLES::Framebuffer*> mDiscardFramebufferQueue; ///< Discard queue for framebuffer resource
782 std::queue<GLES::CommandBuffer*> mCommandQueue; ///< we may have more in the future
784 using TextureUpdateRequest = std::pair<TextureUpdateInfo, TextureUpdateSourceInfo>;
785 std::queue<TextureUpdateRequest> mTextureUpdateRequests;
787 std::queue<const GLES::Texture*> mTextureMipmapGenerationRequests; ///< Queue for texture mipmap generation requests
789 GLES::Context* mCurrentContext{nullptr}; ///< The current context
790 std::unique_ptr<GLES::Context> mContext{nullptr}; ///< Context object handling command buffers execution
791 using SurfaceContextPair = std::pair<Dali::RenderSurfaceInterface*, std::unique_ptr<GLES::Context>>;
792 std::vector<SurfaceContextPair> mSurfaceContexts; ///< Vector of surface context objects handling command buffers execution
794 std::unique_ptr<GLES::PipelineCache> mPipelineCache{nullptr}; ///< Internal pipeline cache
796 GLES::GLESVersion mGLESVersion{GLES::GLESVersion::GLES_20}; ///< Runtime supported GLES version
797 uint32_t mTextureUploadTotalCPUMemoryUsed{0u};
799 bool mIsShuttingDown{false}; ///< Indicates whether the controller is shutting down
801 std::queue<const GLES::CommandBuffer*> mPresentationCommandBuffers{}; ///< Queue of reusable command buffers used by presentation engine
804 } // namespace Graphics
808 #endif //DALI_EGL_GRAPHICS_CONTROLLER_H