1 #ifndef TEST_GRAPHICS_CONTROLLER_H
2 #define TEST_GRAPHICS_CONTROLLER_H
5 * Copyright (c) 2024 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 <unordered_map>
22 #include "test-gl-abstraction.h"
23 #include "test-graphics-command-buffer.h"
24 #include "test-graphics-program.h"
25 #include "test-graphics-reflection.h"
26 #include "test-graphics-sync-impl.h"
30 std::ostream& operator<<(std::ostream& o, const Graphics::BufferCreateInfo& bufferCreateInfo);
31 std::ostream& operator<<(std::ostream& o, const Graphics::CommandBufferCreateInfo& commandBufferCreateInfo);
32 std::ostream& operator<<(std::ostream& o, const Graphics::TextureType& textureType);
33 std::ostream& operator<<(std::ostream& o, const Graphics::Extent2D extent);
34 std::ostream& operator<<(std::ostream& o, const Graphics::TextureCreateInfo& createInfo);
35 std::ostream& operator<<(std::ostream& o, Graphics::SamplerAddressMode addressMode);
36 std::ostream& operator<<(std::ostream& o, Graphics::SamplerFilter filterMode);
37 std::ostream& operator<<(std::ostream& o, Graphics::SamplerMipmapMode mipmapMode);
38 std::ostream& operator<<(std::ostream& o, const Graphics::SamplerCreateInfo& createInfo);
41 T* Uncast(const Graphics::CommandBuffer* object)
43 return const_cast<T*>(static_cast<const T*>(object));
47 T* Uncast(const Graphics::Texture* object)
49 return const_cast<T*>(static_cast<const T*>(object));
53 T* Uncast(const Graphics::Sampler* object)
55 return const_cast<T*>(static_cast<const T*>(object));
59 T* Uncast(const Graphics::Buffer* object)
61 return const_cast<T*>(static_cast<const T*>(object));
65 T* Uncast(const Graphics::Shader* object)
67 return const_cast<T*>(static_cast<const T*>(object));
71 T* Uncast(const Graphics::Framebuffer* object)
73 return const_cast<T*>(static_cast<const T*>(object));
77 T* Uncast(const Graphics::Pipeline* object)
79 return const_cast<T*>(static_cast<const T*>(object));
83 T* Uncast(const Graphics::RenderTarget* object)
85 return const_cast<T*>(static_cast<const T*>(object));
89 T* Uncast(const Graphics::SyncObject* object)
91 return const_cast<T*>(static_cast<const T*>(object));
94 class TestGraphicsController : public Dali::Graphics::Controller
97 TestGraphicsController();
99 virtual ~TestGraphicsController() = default;
106 Integration::GlAbstraction& GetGlAbstraction()
111 Integration::GraphicsConfig& GetGraphicsConfig()
116 TestGraphicsSyncImplementation& GetGraphicsSyncImpl()
118 return mGraphicsSyncImpl;
121 void SubmitCommandBuffers(const Graphics::SubmitInfo& submitInfo) override;
124 * @brief Presents render target
125 * @param renderTarget render target to present
127 void PresentRenderTarget(Graphics::RenderTarget* renderTarget) override;
130 * @brief Waits until the GPU is idle
132 void WaitIdle() override;
135 * @brief Lifecycle pause event
137 void Pause() override;
140 * @brief Lifecycle resume event
142 void Resume() override;
145 * @brief Lifecycle shutdown event
147 void Shutdown() override;
150 * @brief Lifecycle destroy event
152 void Destroy() override;
155 * @brief Executes batch update of textures
157 * This function may perform full or partial update of many textures.
158 * The data source may come from:
159 * - CPU memory (client side)
160 * - GPU memory (another Texture or Buffer)
162 * UpdateTextures() is the only way to update unmappable Texture objects.
163 * It is recommended to batch updates as it may help with optimizing
164 * memory transfers based on dependencies.
167 void UpdateTextures(const std::vector<Graphics::TextureUpdateInfo>& updateInfoList,
168 const std::vector<Graphics::TextureUpdateSourceInfo>& sourceList) override;
171 * Auto generates mipmaps for the texture
172 * @param[in] texture The texture
174 void GenerateTextureMipmaps(const Graphics::Texture& texture) override;
177 * TBD: do we need those functions in the new implementation?
179 bool EnableDepthStencilBuffer(bool enableDepth, bool enableStencil) override;
181 void RunGarbageCollector(size_t numberOfDiscardedRenderers) override;
183 void DiscardUnusedResources() override;
185 bool IsDiscardQueueEmpty() override;
188 * @brief Test if the graphics subsystem has resumed & should force a draw
190 * @return true if the graphics subsystem requires a re-draw
192 bool IsDrawOnResumeRequired() override;
195 * @brief Creates new Buffer object
197 * The Buffer object is created with underlying memory. The Buffer
198 * specification is immutable. Based on the BufferCreateInfo::usage,
199 * the memory may be client-side mappable or not.
201 * The old buffer may be passed as BufferCreateInfo::oldbuffer, however,
202 * it's up to the implementation whether the object will be reused or
203 * discarded and replaced by the new one.
205 * @param[in] bufferCreateInfo The valid BufferCreateInfo structure
206 * @return pointer to the Buffer object
208 Graphics::UniquePtr<Graphics::Buffer> CreateBuffer(const Graphics::BufferCreateInfo& bufferCreateInfo, Graphics::UniquePtr<Graphics::Buffer>&& oldBuffer) override;
210 void DiscardBuffer(TestGraphicsBuffer* buffer);
213 * @brief Creates new CommandBuffer object
215 * @param[in] bufferCreateInfo The valid BufferCreateInfo structure
216 * @return pointer to the CommandBuffer object
218 Graphics::UniquePtr<Graphics::CommandBuffer> CreateCommandBuffer(const Graphics::CommandBufferCreateInfo& commandBufferCreateInfo, Graphics::UniquePtr<Graphics::CommandBuffer>&& oldCommandBuffer) override;
221 * @brief Creates new RenderPass object
223 * @param[in] renderPassCreateInfo The valid RenderPassCreateInfo structure
224 * @return pointer to the RenderPass object
226 Graphics::UniquePtr<Graphics::RenderPass> CreateRenderPass(const Graphics::RenderPassCreateInfo& renderPassCreateInfo, Graphics::UniquePtr<Graphics::RenderPass>&& oldRenderPass) override;
229 * @brief Creates new Texture object
231 * @param[in] textureCreateInfo The valid TextureCreateInfo structure
232 * @return pointer to the TextureCreateInfo object
234 Graphics::UniquePtr<Graphics::Texture> CreateTexture(const Graphics::TextureCreateInfo& textureCreateInfo, Graphics::UniquePtr<Graphics::Texture>&& oldTexture) override;
237 * @brief Creates new Framebuffer object
239 * @param[in] framebufferCreateInfo The valid FramebufferCreateInfo structure
240 * @return pointer to the Framebuffer object
242 Graphics::UniquePtr<Graphics::Framebuffer> CreateFramebuffer(const Graphics::FramebufferCreateInfo& framebufferCreateInfo, Graphics::UniquePtr<Graphics::Framebuffer>&& oldFramebuffer) override;
245 * @brief Creates new Pipeline object
247 * @param[in] pipelineCreateInfo The valid PipelineCreateInfo structure
248 * @return pointer to the Pipeline object
250 Graphics::UniquePtr<Graphics::Pipeline> CreatePipeline(const Graphics::PipelineCreateInfo& pipelineCreateInfo, Graphics::UniquePtr<Graphics::Pipeline>&& oldPipeline) override;
253 * @brief Creates new Program object
255 * @param[in] programCreateInfo The valid ProgramCreateInfo structure
256 * @return pointer to the Program object
258 Graphics::UniquePtr<Graphics::Program> CreateProgram(const Graphics::ProgramCreateInfo& programCreateInfo, Graphics::UniquePtr<Graphics::Program>&& oldProgram) override;
261 * @brief Creates new Shader object
263 * @param[in] shaderCreateInfo The valid ShaderCreateInfo structure
264 * @return pointer to the Shader object
266 Graphics::UniquePtr<Graphics::Shader> CreateShader(const Graphics::ShaderCreateInfo& shaderCreateInfo, Graphics::UniquePtr<Graphics::Shader>&& oldShader) override;
269 * @brief Creates new Sampler object
271 * @param[in] samplerCreateInfo The valid SamplerCreateInfo structure
272 * @return pointer to the Sampler object
274 Graphics::UniquePtr<Graphics::Sampler> CreateSampler(const Graphics::SamplerCreateInfo& samplerCreateInfo, Graphics::UniquePtr<Graphics::Sampler>&& oldSampler) override;
277 * @brief Creates new RenderTarget object
279 * @param[in] renderTargetCreateInfo The valid RenderTargetCreateInfo structure
280 * @return pointer to the RenderTarget object
282 Graphics::UniquePtr<Graphics::RenderTarget> CreateRenderTarget(const Graphics::RenderTargetCreateInfo& renderTargetCreateInfo, Graphics::UniquePtr<Graphics::RenderTarget>&& oldRenderTarget) override;
285 * @brief Creates new sync object
286 * Could add timeout etc to createinfo... but nah.
288 * @return pointer to the SyncObject
290 Graphics::UniquePtr<Graphics::SyncObject> CreateSyncObject(const Graphics::SyncObjectCreateInfo& syncObjectCreateInfo,
291 Graphics::UniquePtr<Graphics::SyncObject>&& oldSyncObject) override;
294 * @brief Maps memory associated with Buffer object
296 * @param[in] mapInfo Filled details of mapped resource
298 * @return Returns pointer to Memory object or nullptr on error
300 Graphics::UniquePtr<Graphics::Memory> MapBufferRange(const Graphics::MapBufferInfo& mapInfo) override;
303 * @brief Maps memory associated with the texture.
305 * Only Texture objects that are backed with linear memory (staging memory) can be mapped.
307 * 1) GLES implementation may create PBO object as staging memory and couple it
308 * with the texture. Texture can be mapped and the memory can be read/write on demand.
310 * 2) Vulkan implementation may allocate DeviceMemory and use linear layout.
312 * @param[in] mapInfo Filled details of mapped resource
314 * @return Valid Memory object or nullptr on error
316 Graphics::UniquePtr<Graphics::Memory> MapTextureRange(const Graphics::MapTextureInfo& mapInfo) override;
319 * @brief Unmaps memory and discards Memory object
321 * This function automatically removes lock if Memory has been
324 * @param[in] memory Valid and previously mapped Memory object
326 void UnmapMemory(Graphics::UniquePtr<Graphics::Memory> memory) override;
329 * @brief Returns memory requirements of the Texture object.
331 * Call this function whenever it's necessary to know how much memory
332 * is needed to store all the texture data and what memory alignment
333 * the data should follow.
335 * @return Returns memory requirements of Texture
337 Graphics::MemoryRequirements GetTextureMemoryRequirements(Graphics::Texture& texture) const override;
340 * @brief Returns memory requirements of the Buffer object.
342 * Call this function whenever it's necessary to know how much memory
343 * is needed to store all the buffer data and what memory alignment
344 * the data should follow.
346 * @return Returns memory requirements of Buffer
348 Graphics::MemoryRequirements GetBufferMemoryRequirements(Graphics::Buffer& buffer) const override;
351 * @brief Returns specification of the Texture object
353 * Function obtains specification of the Texture object. It may retrieve
354 * implementation dependent details like ie. whether the texture is
355 * emulated (for example, RGB emulated on RGBA), compressed etc.
357 * @return Returns the TextureProperties object
359 Graphics::TextureProperties GetTextureProperties(const Graphics::Texture& texture) override;
362 * @brief Returns the reflection of the given program
364 * @param[in] program The program
365 * @return The reflection of the program
367 const Graphics::Reflection& GetProgramReflection(const Graphics::Program& program) override;
370 * @brief Tests whether two Pipelines are the same.
372 * On the higher level, this function may help wit creating pipeline cache.
374 * @return true if pipeline objects match
376 bool PipelineEquals(const Graphics::Pipeline& pipeline0, const Graphics::Pipeline& pipeline1) const override;
379 * @brief Retrieves program parameters
381 * This function can be used to retrieve data from internal implementation
383 * @param[in] program Valid program object
384 * @param[in] parameterId Integer parameter id
385 * @param[out] outData Pointer to output memory
386 * @return True on success
388 bool GetProgramParameter(Graphics::Program& program, uint32_t parameterId, void* outData) override;
390 public: // ResourceId relative API.
392 * @brief Create Graphics::Texture as resourceId.
393 * The ownership of Graphics::Texture will be hold on this controller.
394 * @note If some Graphics::Texture already created before, assert.
395 * @post DiscardTextureFromResourceId() or ReleaseTextureFromResourceId() should be called when we don't use resourceId texture anymore.
397 * @param[in] resourceId The unique id of resouces.
398 * @return Pointer of Graphics::Texture, or nullptr if we fail to create.
400 Graphics::Texture* CreateTextureByResourceId(uint32_t resourceId, const Graphics::TextureCreateInfo& createInfo) override;
403 * @brief Discard Graphics::Texture as resourceId.
405 * @param[in] resourceId The unique id of resouces.
407 void DiscardTextureFromResourceId(uint32_t resourceId) override;
410 * @brief Get the Graphics::Texture as resourceId.
412 * @param[in] resourceId The unique id of resouces.
413 * @return Pointer of Graphics::Texture, or nullptr if there is no valid objects.
415 Graphics::Texture* GetTextureFromResourceId(uint32_t resourceId) override;
418 * @brief Get the ownership of Graphics::Texture as resourceId.
420 * @param[in] resourceId The unique id of resouces.
421 * @return Pointer of Graphics::Texture.
423 Graphics::UniquePtr<Graphics::Texture> ReleaseTextureFromResourceId(uint32_t resourceId) override;
425 public: // Test Functions
426 void SetAutoAttrCreation(bool v)
428 mAutoAttrCreation = v;
430 bool AutoAttrCreation()
432 return mAutoAttrCreation;
435 void SetVertexFormats(Property::Array& vfs)
437 mVertexFormats = vfs;
440 void AddCustomUniforms(std::vector<UniformData>& customUniforms)
442 mCustomUniforms = customUniforms;
445 void AddCustomUniformBlock(const TestGraphicsReflection::TestUniformBlockInfo& blockInfo)
447 mCustomUniformBlocks.push_back(blockInfo);
450 void ClearSubmitStack()
452 mSubmitStack.clear();
455 void ProcessCommandBuffer(TestGraphicsCommandBuffer& commandBuffer);
457 void BindPipeline(TestGraphicsPipeline* pipeline);
460 mutable TraceCallStack mCallStack;
461 mutable TraceCallStack mCommandBufferCallStack;
462 mutable TraceCallStack mFrameBufferCallStack;
463 mutable std::vector<Graphics::SubmitInfo> mSubmitStack;
465 TestGlAbstraction mGl;
466 TestGraphicsSyncImplementation mGraphicsSyncImpl;
468 bool isDiscardQueueEmptyResult{true};
469 bool isDrawOnResumeRequiredResult{true};
470 bool mAutoAttrCreation{true};
471 Property::Array mVertexFormats;
475 std::map<Graphics::PipelineStage, std::vector<uint8_t>> shaders;
476 TestGraphicsProgramImpl* programImpl;
478 std::vector<ProgramCache> mProgramCache;
480 std::vector<TestGraphicsBuffer*> mAllocatedBuffers;
482 std::unordered_map<uint32_t, Graphics::UniquePtr<Graphics::Texture>> mTextureUploadBindMapper;
488 std::vector<UniformData> mCustomUniforms;
489 std::vector<TestGraphicsReflection::TestUniformBlockInfo> mCustomUniformBlocks;
494 #endif //TEST_GRAPHICS_CONTROLLER_H