1 #ifndef TEST_GRAPHICS_CONTROLLER_H
2 #define TEST_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.
20 #include <dali/graphics-api/graphics-controller.h>
21 #include "test-gl-abstraction.h"
22 #include "test-gl-context-helper-abstraction.h"
23 #include "test-gl-sync-abstraction.h"
27 std::ostream& operator<<(std::ostream& o, const Graphics::BufferCreateInfo& bufferCreateInfo);
28 std::ostream& operator<<(std::ostream& o, const Graphics::CommandBufferCreateInfo& commandBufferCreateInfo);
29 std::ostream& operator<<(std::ostream& o, const Graphics::TextureType& textureType);
30 std::ostream& operator<<(std::ostream& o, const Graphics::Extent2D extent);
31 std::ostream& operator<<(std::ostream& o, const Graphics::TextureCreateInfo& createInfo);
32 std::ostream& operator<<(std::ostream& o, Graphics::SamplerAddressMode addressMode);
33 std::ostream& operator<<(std::ostream& o, Graphics::SamplerFilter filterMode);
34 std::ostream& operator<<(std::ostream& o, Graphics::SamplerMipmapMode mipmapMode);
35 std::ostream& operator<<(std::ostream& o, const Graphics::SamplerCreateInfo& createInfo);
37 class TestGraphicsController : public Dali::Graphics::Controller
40 TestGraphicsController()
44 virtual ~TestGraphicsController() = default;
48 mGlAbstraction.Initialize();
51 Integration::GlAbstraction& GetGlAbstraction() override
53 return mGlAbstraction;
56 Integration::GlSyncAbstraction& GetGlSyncAbstraction() override
58 return mGlSyncAbstraction;
61 Integration::GlContextHelperAbstraction& GetGlContextHelperAbstraction() override
63 return mGlContextHelperAbstraction;
66 void SubmitCommandBuffers(const Graphics::SubmitInfo& submitInfo) override
71 * @brief Presents render target
72 * @param renderTarget render target to present
74 void PresentRenderTarget(Graphics::RenderTarget* renderTarget) override
79 * @brief Waits until the GPU is idle
81 void WaitIdle() override
86 * @brief Lifecycle pause event
93 * @brief Lifecycle resume event
95 void Resume() override
100 * @brief Executes batch update of textures
102 * This function may perform full or partial update of many textures.
103 * The data source may come from:
104 * - CPU memory (client side)
105 * - GPU memory (another Texture or Buffer)
107 * UpdateTextures() is the only way to update unmappable Texture objects.
108 * It is recommended to batch updates as it may help with optimizing
109 * memory transfers based on dependencies.
112 void UpdateTextures(const std::vector<Graphics::TextureUpdateInfo>& updateInfoList,
113 const std::vector<Graphics::TextureUpdateSourceInfo>& sourceList) override
118 * TBD: do we need those functions in the new implementation?
120 bool EnableDepthStencilBuffer(bool enableDepth, bool enableStencil) override
125 void RunGarbageCollector(size_t numberOfDiscardedRenderers) override
129 void DiscardUnusedResources() override
133 bool IsDiscardQueueEmpty() override
139 * @brief Test if the graphics subsystem has resumed & should force a draw
141 * @return true if the graphics subsystem requires a re-draw
143 bool IsDrawOnResumeRequired() override
149 * @brief Creates new Buffer object
151 * The Buffer object is created with underlying memory. The Buffer
152 * specification is immutable. Based on the BufferCreateInfo::usage,
153 * the memory may be client-side mappable or not.
155 * The old buffer may be passed as BufferCreateInfo::oldbuffer, however,
156 * it's up to the implementation whether the object will be reused or
157 * discarded and replaced by the new one.
159 * @param[in] bufferCreateInfo The valid BufferCreateInfo structure
160 * @return pointer to the Buffer object
162 std::unique_ptr<Graphics::Buffer> CreateBuffer(const Graphics::BufferCreateInfo& bufferCreateInfo, std::unique_ptr<Graphics::Buffer>&& oldBuffer) override
168 * @brief Creates new CommandBuffer object
170 * @param[in] bufferCreateInfo The valid BufferCreateInfo structure
171 * @return pointer to the CommandBuffer object
173 std::unique_ptr<Graphics::CommandBuffer> CreateCommandBuffer(const Graphics::CommandBufferCreateInfo& commandBufferCreateInfo, std::unique_ptr<Graphics::CommandBuffer>&& oldCommandBuffer) override
179 * @brief Creates new RenderPass object
181 * @param[in] renderPassCreateInfo The valid RenderPassCreateInfo structure
182 * @return pointer to the RenderPass object
184 std::unique_ptr<Graphics::RenderPass> CreateRenderPass(const Graphics::RenderPassCreateInfo& renderPassCreateInfo, std::unique_ptr<Graphics::RenderPass>&& oldRenderPass) override
190 * @brief Creates new Texture object
192 * @param[in] textureCreateInfo The valid TextureCreateInfo structure
193 * @return pointer to the TextureCreateInfo object
195 std::unique_ptr<Graphics::Texture> CreateTexture(const Graphics::TextureCreateInfo& textureCreateInfo, std::unique_ptr<Graphics::Texture>&& oldTexture) override
201 * @brief Creates new Framebuffer object
203 * @param[in] framebufferCreateInfo The valid FramebufferCreateInfo structure
204 * @return pointer to the Framebuffer object
206 std::unique_ptr<Graphics::Framebuffer> CreateFramebuffer(const Graphics::FramebufferCreateInfo& framebufferCreateInfo, std::unique_ptr<Graphics::Framebuffer>&& oldFramebuffer) override
212 * @brief Creates new Pipeline object
214 * @param[in] pipelineCreateInfo The valid PipelineCreateInfo structure
215 * @return pointer to the Pipeline object
217 std::unique_ptr<Graphics::Pipeline> CreatePipeline(const Graphics::PipelineCreateInfo& pipelineCreateInfo, std::unique_ptr<Graphics::Pipeline>&& oldPipeline) override
223 * @brief Creates new Shader object
225 * @param[in] shaderCreateInfo The valid ShaderCreateInfo structure
226 * @return pointer to the Shader object
228 std::unique_ptr<Graphics::Shader> CreateShader(const Graphics::ShaderCreateInfo& shaderCreateInfo, std::unique_ptr<Graphics::Shader>&& oldShader) override
234 * @brief Creates new Sampler object
236 * @param[in] samplerCreateInfo The valid SamplerCreateInfo structure
237 * @return pointer to the Sampler object
239 std::unique_ptr<Graphics::Sampler> CreateSampler(const Graphics::SamplerCreateInfo& samplerCreateInfo, std::unique_ptr<Graphics::Sampler>&& oldSampler) override
245 * @brief Creates new RenderTarget object
247 * @param[in] renderTargetCreateInfo The valid RenderTargetCreateInfo structure
248 * @return pointer to the RenderTarget object
250 std::unique_ptr<Graphics::RenderTarget> CreateRenderTarget(const Graphics::RenderTargetCreateInfo& renderTargetCreateInfo, std::unique_ptr<Graphics::RenderTarget>&& oldRenderTarget) override
256 * @brief Maps memory associated with Buffer object
258 * @param[in] mapInfo Filled details of mapped resource
260 * @return Returns pointer to Memory object or Graphicsnullptr on error
262 std::unique_ptr<Graphics::Memory> MapBufferRange(const Graphics::MapBufferInfo& mapInfo) override
268 * @brief Maps memory associated with the texture.
270 * Only Texture objects that are backed with linear memory (staging memory) can be mapped.
272 * 1) GLES implementation may create PBO object as staging memory and couple it
273 * with the texture. Texture can be mapped and the memory can be read/write on demand.
275 * 2) Vulkan implementation may allocate DeviceMemory and use linear layout.
277 * @param[in] mapInfo Filled details of mapped resource
279 * @return Valid Memory object or nullptr on error
281 std::unique_ptr<Graphics::Memory> MapTextureRange(const Graphics::MapTextureInfo& mapInfo) override
287 * @brief Unmaps memory and discards Memory object
289 * This function automatically removes lock if Memory has been
292 * @param[in] memory Valid and previously mapped Memory object
294 void UnmapMemory(std::unique_ptr<Graphics::Memory> memory) override
299 * @brief Returns memory requirements of the Texture object.
301 * Call this function whenever it's necessary to know how much memory
302 * is needed to store all the texture data and what memory alignment
303 * the data should follow.
305 * @return Returns memory requirements of Texture
307 Graphics::MemoryRequirements GetTextureMemoryRequirements(Graphics::Texture& texture) const override
313 * @brief Returns memory requirements of the Buffer object.
315 * Call this function whenever it's necessary to know how much memory
316 * is needed to store all the buffer data and what memory alignment
317 * the data should follow.
319 * @return Returns memory requirements of Buffer
321 Graphics::MemoryRequirements GetBufferMemoryRequirements(Graphics::Buffer& buffer) const override
327 * @brief Returns specification of the Texture object
329 * Function obtains specification of the Texture object. It may retrieve
330 * implementation dependent details like ie. whether the texture is
331 * emulated (for example, RGB emulated on RGBA), compressed etc.
333 * @return Returns the TextureProperties object
335 const Graphics::TextureProperties& GetTextureProperties(const Graphics::Texture& texture) override
337 static Graphics::TextureProperties properties{};
342 * @brief Tests whether two Pipelines are the same.
344 * On the higher level, this function may help wit creating pipeline cache.
346 * @return true if pipeline objects match
348 bool PipelineEquals(const Graphics::Pipeline& pipeline0, const Graphics::Pipeline& pipeline1) const override
355 TestGlAbstraction mGlAbstraction;
356 TestGlSyncAbstraction mGlSyncAbstraction;
357 TestGlContextHelperAbstraction mGlContextHelperAbstraction;
359 bool isDiscardQueueEmptyResult{true};
360 bool isDrawOnResumeRequiredResult{true};
365 #endif //TEST_GRAPHICS_CONTROLLER_H