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"
24 #include "test-graphics-program.h"
25 #include "test-graphics-reflection.h"
29 std::ostream& operator<<(std::ostream& o, const Graphics::BufferCreateInfo& bufferCreateInfo);
30 std::ostream& operator<<(std::ostream& o, const Graphics::CommandBufferCreateInfo& commandBufferCreateInfo);
31 std::ostream& operator<<(std::ostream& o, const Graphics::TextureType& textureType);
32 std::ostream& operator<<(std::ostream& o, const Graphics::Extent2D extent);
33 std::ostream& operator<<(std::ostream& o, const Graphics::TextureCreateInfo& createInfo);
34 std::ostream& operator<<(std::ostream& o, Graphics::SamplerAddressMode addressMode);
35 std::ostream& operator<<(std::ostream& o, Graphics::SamplerFilter filterMode);
36 std::ostream& operator<<(std::ostream& o, Graphics::SamplerMipmapMode mipmapMode);
37 std::ostream& operator<<(std::ostream& o, const Graphics::SamplerCreateInfo& createInfo);
39 class TestGraphicsController : public Dali::Graphics::Controller
42 TestGraphicsController();
44 virtual ~TestGraphicsController() = default;
51 Integration::GlAbstraction& GetGlAbstraction() override
56 Integration::GlSyncAbstraction& GetGlSyncAbstraction() override
58 return mGlSyncAbstraction;
61 Integration::GlContextHelperAbstraction& GetGlContextHelperAbstraction() override
63 return mGlContextHelperAbstraction;
66 void SubmitCommandBuffers(const Graphics::SubmitInfo& submitInfo) override;
69 * @brief Presents render target
70 * @param renderTarget render target to present
72 void PresentRenderTarget(Graphics::RenderTarget* renderTarget) override;
75 * @brief Waits until the GPU is idle
77 void WaitIdle() override;
80 * @brief Lifecycle pause event
82 void Pause() override;
85 * @brief Lifecycle resume event
87 void Resume() override;
90 * @brief Executes batch update of textures
92 * This function may perform full or partial update of many textures.
93 * The data source may come from:
94 * - CPU memory (client side)
95 * - GPU memory (another Texture or Buffer)
97 * UpdateTextures() is the only way to update unmappable Texture objects.
98 * It is recommended to batch updates as it may help with optimizing
99 * memory transfers based on dependencies.
102 void UpdateTextures(const std::vector<Graphics::TextureUpdateInfo>& updateInfoList,
103 const std::vector<Graphics::TextureUpdateSourceInfo>& sourceList) override;
106 * TBD: do we need those functions in the new implementation?
108 bool EnableDepthStencilBuffer(bool enableDepth, bool enableStencil) override;
110 void RunGarbageCollector(size_t numberOfDiscardedRenderers) override;
112 void DiscardUnusedResources() override;
114 bool IsDiscardQueueEmpty() override;
117 * @brief Test if the graphics subsystem has resumed & should force a draw
119 * @return true if the graphics subsystem requires a re-draw
121 bool IsDrawOnResumeRequired() override;
124 * @brief Creates new Buffer object
126 * The Buffer object is created with underlying memory. The Buffer
127 * specification is immutable. Based on the BufferCreateInfo::usage,
128 * the memory may be client-side mappable or not.
130 * The old buffer may be passed as BufferCreateInfo::oldbuffer, however,
131 * it's up to the implementation whether the object will be reused or
132 * discarded and replaced by the new one.
134 * @param[in] bufferCreateInfo The valid BufferCreateInfo structure
135 * @return pointer to the Buffer object
137 Graphics::UniquePtr<Graphics::Buffer> CreateBuffer(const Graphics::BufferCreateInfo& bufferCreateInfo, Graphics::UniquePtr<Graphics::Buffer>&& oldBuffer) override;
140 * @brief Creates new CommandBuffer object
142 * @param[in] bufferCreateInfo The valid BufferCreateInfo structure
143 * @return pointer to the CommandBuffer object
145 Graphics::UniquePtr<Graphics::CommandBuffer> CreateCommandBuffer(const Graphics::CommandBufferCreateInfo& commandBufferCreateInfo, Graphics::UniquePtr<Graphics::CommandBuffer>&& oldCommandBuffer) override;
148 * @brief Creates new RenderPass object
150 * @param[in] renderPassCreateInfo The valid RenderPassCreateInfo structure
151 * @return pointer to the RenderPass object
153 Graphics::UniquePtr<Graphics::RenderPass> CreateRenderPass(const Graphics::RenderPassCreateInfo& renderPassCreateInfo, Graphics::UniquePtr<Graphics::RenderPass>&& oldRenderPass) override;
156 * @brief Creates new Texture object
158 * @param[in] textureCreateInfo The valid TextureCreateInfo structure
159 * @return pointer to the TextureCreateInfo object
161 Graphics::UniquePtr<Graphics::Texture> CreateTexture(const Graphics::TextureCreateInfo& textureCreateInfo, Graphics::UniquePtr<Graphics::Texture>&& oldTexture) override;
164 * @brief Creates new Framebuffer object
166 * @param[in] framebufferCreateInfo The valid FramebufferCreateInfo structure
167 * @return pointer to the Framebuffer object
169 Graphics::UniquePtr<Graphics::Framebuffer> CreateFramebuffer(const Graphics::FramebufferCreateInfo& framebufferCreateInfo, Graphics::UniquePtr<Graphics::Framebuffer>&& oldFramebuffer) override;
172 * @brief Creates new Pipeline object
174 * @param[in] pipelineCreateInfo The valid PipelineCreateInfo structure
175 * @return pointer to the Pipeline object
177 Graphics::UniquePtr<Graphics::Pipeline> CreatePipeline(const Graphics::PipelineCreateInfo& pipelineCreateInfo, Graphics::UniquePtr<Graphics::Pipeline>&& oldPipeline) override;
180 * @brief Creates new Program object
182 * @param[in] programCreateInfo The valid ProgramCreateInfo structure
183 * @return pointer to the Program object
185 Graphics::UniquePtr<Graphics::Program> CreateProgram(const Graphics::ProgramCreateInfo& programCreateInfo, Graphics::UniquePtr<Graphics::Program>&& oldProgram) override;
188 * @brief Creates new Shader object
190 * @param[in] shaderCreateInfo The valid ShaderCreateInfo structure
191 * @return pointer to the Shader object
193 Graphics::UniquePtr<Graphics::Shader> CreateShader(const Graphics::ShaderCreateInfo& shaderCreateInfo, Graphics::UniquePtr<Graphics::Shader>&& oldShader) override;
196 * @brief Creates new Sampler object
198 * @param[in] samplerCreateInfo The valid SamplerCreateInfo structure
199 * @return pointer to the Sampler object
201 Graphics::UniquePtr<Graphics::Sampler> CreateSampler(const Graphics::SamplerCreateInfo& samplerCreateInfo, Graphics::UniquePtr<Graphics::Sampler>&& oldSampler) override;
204 * @brief Creates new RenderTarget object
206 * @param[in] renderTargetCreateInfo The valid RenderTargetCreateInfo structure
207 * @return pointer to the RenderTarget object
209 Graphics::UniquePtr<Graphics::RenderTarget> CreateRenderTarget(const Graphics::RenderTargetCreateInfo& renderTargetCreateInfo, Graphics::UniquePtr<Graphics::RenderTarget>&& oldRenderTarget) override;
212 * @brief Maps memory associated with Buffer object
214 * @param[in] mapInfo Filled details of mapped resource
216 * @return Returns pointer to Memory object or Graphicsnullptr on error
218 Graphics::UniquePtr<Graphics::Memory> MapBufferRange(const Graphics::MapBufferInfo& mapInfo) override;
221 * @brief Maps memory associated with the texture.
223 * Only Texture objects that are backed with linear memory (staging memory) can be mapped.
225 * 1) GLES implementation may create PBO object as staging memory and couple it
226 * with the texture. Texture can be mapped and the memory can be read/write on demand.
228 * 2) Vulkan implementation may allocate DeviceMemory and use linear layout.
230 * @param[in] mapInfo Filled details of mapped resource
232 * @return Valid Memory object or nullptr on error
234 Graphics::UniquePtr<Graphics::Memory> MapTextureRange(const Graphics::MapTextureInfo& mapInfo) override;
237 * @brief Unmaps memory and discards Memory object
239 * This function automatically removes lock if Memory has been
242 * @param[in] memory Valid and previously mapped Memory object
244 void UnmapMemory(Graphics::UniquePtr<Graphics::Memory> memory) override;
247 * @brief Returns memory requirements of the Texture object.
249 * Call this function whenever it's necessary to know how much memory
250 * is needed to store all the texture data and what memory alignment
251 * the data should follow.
253 * @return Returns memory requirements of Texture
255 Graphics::MemoryRequirements GetTextureMemoryRequirements(Graphics::Texture& texture) const override;
258 * @brief Returns memory requirements of the Buffer object.
260 * Call this function whenever it's necessary to know how much memory
261 * is needed to store all the buffer data and what memory alignment
262 * the data should follow.
264 * @return Returns memory requirements of Buffer
266 Graphics::MemoryRequirements GetBufferMemoryRequirements(Graphics::Buffer& buffer) const override;
269 * @brief Returns specification of the Texture object
271 * Function obtains specification of the Texture object. It may retrieve
272 * implementation dependent details like ie. whether the texture is
273 * emulated (for example, RGB emulated on RGBA), compressed etc.
275 * @return Returns the TextureProperties object
277 const Graphics::TextureProperties& GetTextureProperties(const Graphics::Texture& texture) override;
280 * @brief Returns the reflection of the given program
282 * @param[in] program The program
283 * @return The reflection of the program
285 const Graphics::Reflection& GetProgramReflection(const Graphics::Program& program) override;
288 * @brief Tests whether two Pipelines are the same.
290 * On the higher level, this function may help wit creating pipeline cache.
292 * @return true if pipeline objects match
294 bool PipelineEquals(const Graphics::Pipeline& pipeline0, const Graphics::Pipeline& pipeline1) const override;
296 public: // Test Functions
297 void SetVertexFormats(Property::Array& vfs)
299 mVertexFormats = vfs;
302 void AddCustomUniforms(std::vector<UniformData>& customUniforms)
304 mCustomUniforms = customUniforms;
307 void ClearSubmitStack()
309 mSubmitStack.clear();
313 * @brief Retrieves program parameters
315 * This function can be used to retrieve data from internal implementation
317 * @param[in] program Valid program object
318 * @param[in] parameterId Integer parameter id
319 * @param[out] outData Pointer to output memory
320 * @return True on success
322 bool GetProgramParameter(Graphics::Program& program, uint32_t parameterId, void* outData) override;
325 mutable TraceCallStack mCallStack;
326 mutable TraceCallStack mCommandBufferCallStack;
327 mutable std::vector<Graphics::SubmitInfo> mSubmitStack;
329 TestGlAbstraction mGl;
330 TestGlSyncAbstraction mGlSyncAbstraction;
331 TestGlContextHelperAbstraction mGlContextHelperAbstraction;
333 bool isDiscardQueueEmptyResult{true};
334 bool isDrawOnResumeRequiredResult{true};
336 Property::Array mVertexFormats;
340 std::map<Graphics::PipelineStage, std::vector<uint8_t>> shaders;
341 TestGraphicsProgramImpl* programImpl;
343 std::vector<ProgramCache> mProgramCache;
345 std::vector<UniformData> mCustomUniforms;
350 #endif //TEST_GRAPHICS_CONTROLLER_H