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);
40 T* Uncast(const Graphics::CommandBuffer* object)
42 return const_cast<T*>(static_cast<const T*>(object));
46 T* Uncast(const Graphics::Texture* object)
48 return const_cast<T*>(static_cast<const T*>(object));
52 T* Uncast(const Graphics::Sampler* object)
54 return const_cast<T*>(static_cast<const T*>(object));
58 T* Uncast(const Graphics::Buffer* object)
60 return const_cast<T*>(static_cast<const T*>(object));
64 T* Uncast(const Graphics::Shader* object)
66 return const_cast<T*>(static_cast<const T*>(object));
70 T* Uncast(const Graphics::Framebuffer* object)
72 return const_cast<T*>(static_cast<const T*>(object));
75 class TestGraphicsController : public Dali::Graphics::Controller
78 TestGraphicsController();
80 virtual ~TestGraphicsController() = default;
87 Integration::GlAbstraction& GetGlAbstraction() override
92 Integration::GlSyncAbstraction& GetGlSyncAbstraction() override
94 return mGlSyncAbstraction;
97 Integration::GlContextHelperAbstraction& GetGlContextHelperAbstraction() override
99 return mGlContextHelperAbstraction;
102 void SubmitCommandBuffers(const Graphics::SubmitInfo& submitInfo) override;
105 * @brief Presents render target
106 * @param renderTarget render target to present
108 void PresentRenderTarget(Graphics::RenderTarget* renderTarget) override;
111 * @brief Waits until the GPU is idle
113 void WaitIdle() override;
116 * @brief Lifecycle pause event
118 void Pause() override;
121 * @brief Lifecycle resume event
123 void Resume() override;
126 * @brief Lifecycle shutdown event
128 void Shutdown() override;
131 * @brief Lifecycle destroy event
133 void Destroy() override;
136 * @brief Executes batch update of textures
138 * This function may perform full or partial update of many textures.
139 * The data source may come from:
140 * - CPU memory (client side)
141 * - GPU memory (another Texture or Buffer)
143 * UpdateTextures() is the only way to update unmappable Texture objects.
144 * It is recommended to batch updates as it may help with optimizing
145 * memory transfers based on dependencies.
148 void UpdateTextures(const std::vector<Graphics::TextureUpdateInfo>& updateInfoList,
149 const std::vector<Graphics::TextureUpdateSourceInfo>& sourceList) override;
152 * TBD: do we need those functions in the new implementation?
154 bool EnableDepthStencilBuffer(bool enableDepth, bool enableStencil) override;
156 void RunGarbageCollector(size_t numberOfDiscardedRenderers) override;
158 void DiscardUnusedResources() override;
160 bool IsDiscardQueueEmpty() override;
163 * @brief Test if the graphics subsystem has resumed & should force a draw
165 * @return true if the graphics subsystem requires a re-draw
167 bool IsDrawOnResumeRequired() override;
170 * @brief Creates new Buffer object
172 * The Buffer object is created with underlying memory. The Buffer
173 * specification is immutable. Based on the BufferCreateInfo::usage,
174 * the memory may be client-side mappable or not.
176 * The old buffer may be passed as BufferCreateInfo::oldbuffer, however,
177 * it's up to the implementation whether the object will be reused or
178 * discarded and replaced by the new one.
180 * @param[in] bufferCreateInfo The valid BufferCreateInfo structure
181 * @return pointer to the Buffer object
183 Graphics::UniquePtr<Graphics::Buffer> CreateBuffer(const Graphics::BufferCreateInfo& bufferCreateInfo, Graphics::UniquePtr<Graphics::Buffer>&& oldBuffer) override;
186 * @brief Creates new CommandBuffer object
188 * @param[in] bufferCreateInfo The valid BufferCreateInfo structure
189 * @return pointer to the CommandBuffer object
191 Graphics::UniquePtr<Graphics::CommandBuffer> CreateCommandBuffer(const Graphics::CommandBufferCreateInfo& commandBufferCreateInfo, Graphics::UniquePtr<Graphics::CommandBuffer>&& oldCommandBuffer) override;
194 * @brief Creates new RenderPass object
196 * @param[in] renderPassCreateInfo The valid RenderPassCreateInfo structure
197 * @return pointer to the RenderPass object
199 Graphics::UniquePtr<Graphics::RenderPass> CreateRenderPass(const Graphics::RenderPassCreateInfo& renderPassCreateInfo, Graphics::UniquePtr<Graphics::RenderPass>&& oldRenderPass) override;
202 * @brief Creates new Texture object
204 * @param[in] textureCreateInfo The valid TextureCreateInfo structure
205 * @return pointer to the TextureCreateInfo object
207 Graphics::UniquePtr<Graphics::Texture> CreateTexture(const Graphics::TextureCreateInfo& textureCreateInfo, Graphics::UniquePtr<Graphics::Texture>&& oldTexture) override;
210 * @brief Creates new Framebuffer object
212 * @param[in] framebufferCreateInfo The valid FramebufferCreateInfo structure
213 * @return pointer to the Framebuffer object
215 Graphics::UniquePtr<Graphics::Framebuffer> CreateFramebuffer(const Graphics::FramebufferCreateInfo& framebufferCreateInfo, Graphics::UniquePtr<Graphics::Framebuffer>&& oldFramebuffer) override;
218 * @brief Creates new Pipeline object
220 * @param[in] pipelineCreateInfo The valid PipelineCreateInfo structure
221 * @return pointer to the Pipeline object
223 Graphics::UniquePtr<Graphics::Pipeline> CreatePipeline(const Graphics::PipelineCreateInfo& pipelineCreateInfo, Graphics::UniquePtr<Graphics::Pipeline>&& oldPipeline) override;
226 * @brief Creates new Program object
228 * @param[in] programCreateInfo The valid ProgramCreateInfo structure
229 * @return pointer to the Program object
231 Graphics::UniquePtr<Graphics::Program> CreateProgram(const Graphics::ProgramCreateInfo& programCreateInfo, Graphics::UniquePtr<Graphics::Program>&& oldProgram) override;
234 * @brief Creates new Shader object
236 * @param[in] shaderCreateInfo The valid ShaderCreateInfo structure
237 * @return pointer to the Shader object
239 Graphics::UniquePtr<Graphics::Shader> CreateShader(const Graphics::ShaderCreateInfo& shaderCreateInfo, Graphics::UniquePtr<Graphics::Shader>&& oldShader) override;
242 * @brief Creates new Sampler object
244 * @param[in] samplerCreateInfo The valid SamplerCreateInfo structure
245 * @return pointer to the Sampler object
247 Graphics::UniquePtr<Graphics::Sampler> CreateSampler(const Graphics::SamplerCreateInfo& samplerCreateInfo, Graphics::UniquePtr<Graphics::Sampler>&& oldSampler) override;
250 * @brief Creates new RenderTarget object
252 * @param[in] renderTargetCreateInfo The valid RenderTargetCreateInfo structure
253 * @return pointer to the RenderTarget object
255 Graphics::UniquePtr<Graphics::RenderTarget> CreateRenderTarget(const Graphics::RenderTargetCreateInfo& renderTargetCreateInfo, Graphics::UniquePtr<Graphics::RenderTarget>&& oldRenderTarget) override;
258 * @brief Maps memory associated with Buffer object
260 * @param[in] mapInfo Filled details of mapped resource
262 * @return Returns pointer to Memory object or Graphicsnullptr on error
264 Graphics::UniquePtr<Graphics::Memory> MapBufferRange(const Graphics::MapBufferInfo& mapInfo) override;
267 * @brief Maps memory associated with the texture.
269 * Only Texture objects that are backed with linear memory (staging memory) can be mapped.
271 * 1) GLES implementation may create PBO object as staging memory and couple it
272 * with the texture. Texture can be mapped and the memory can be read/write on demand.
274 * 2) Vulkan implementation may allocate DeviceMemory and use linear layout.
276 * @param[in] mapInfo Filled details of mapped resource
278 * @return Valid Memory object or nullptr on error
280 Graphics::UniquePtr<Graphics::Memory> MapTextureRange(const Graphics::MapTextureInfo& mapInfo) override;
283 * @brief Unmaps memory and discards Memory object
285 * This function automatically removes lock if Memory has been
288 * @param[in] memory Valid and previously mapped Memory object
290 void UnmapMemory(Graphics::UniquePtr<Graphics::Memory> memory) override;
293 * @brief Returns memory requirements of the Texture object.
295 * Call this function whenever it's necessary to know how much memory
296 * is needed to store all the texture data and what memory alignment
297 * the data should follow.
299 * @return Returns memory requirements of Texture
301 Graphics::MemoryRequirements GetTextureMemoryRequirements(Graphics::Texture& texture) const override;
304 * @brief Returns memory requirements of the Buffer object.
306 * Call this function whenever it's necessary to know how much memory
307 * is needed to store all the buffer data and what memory alignment
308 * the data should follow.
310 * @return Returns memory requirements of Buffer
312 Graphics::MemoryRequirements GetBufferMemoryRequirements(Graphics::Buffer& buffer) const override;
315 * @brief Returns specification of the Texture object
317 * Function obtains specification of the Texture object. It may retrieve
318 * implementation dependent details like ie. whether the texture is
319 * emulated (for example, RGB emulated on RGBA), compressed etc.
321 * @return Returns the TextureProperties object
323 const Graphics::TextureProperties& GetTextureProperties(const Graphics::Texture& texture) override;
326 * @brief Returns the reflection of the given program
328 * @param[in] program The program
329 * @return The reflection of the program
331 const Graphics::Reflection& GetProgramReflection(const Graphics::Program& program) override;
334 * @brief Tests whether two Pipelines are the same.
336 * On the higher level, this function may help wit creating pipeline cache.
338 * @return true if pipeline objects match
340 bool PipelineEquals(const Graphics::Pipeline& pipeline0, const Graphics::Pipeline& pipeline1) const override;
342 public: // Test Functions
343 void SetVertexFormats(Property::Array& vfs)
345 mVertexFormats = vfs;
348 void AddCustomUniforms(std::vector<UniformData>& customUniforms)
350 mCustomUniforms = customUniforms;
353 void ClearSubmitStack()
355 mSubmitStack.clear();
359 * @brief Retrieves program parameters
361 * This function can be used to retrieve data from internal implementation
363 * @param[in] program Valid program object
364 * @param[in] parameterId Integer parameter id
365 * @param[out] outData Pointer to output memory
366 * @return True on success
368 bool GetProgramParameter(Graphics::Program& program, uint32_t parameterId, void* outData) override;
371 mutable TraceCallStack mCallStack;
372 mutable TraceCallStack mCommandBufferCallStack;
373 mutable TraceCallStack mFrameBufferCallStack;
374 mutable std::vector<Graphics::SubmitInfo> mSubmitStack;
376 TestGlAbstraction mGl;
377 TestGlSyncAbstraction mGlSyncAbstraction;
378 TestGlContextHelperAbstraction mGlContextHelperAbstraction;
380 bool isDiscardQueueEmptyResult{true};
381 bool isDrawOnResumeRequiredResult{true};
383 Property::Array mVertexFormats;
387 std::map<Graphics::PipelineStage, std::vector<uint8_t>> shaders;
388 TestGraphicsProgramImpl* programImpl;
390 std::vector<ProgramCache> mProgramCache;
392 std::vector<UniformData> mCustomUniforms;
397 #endif //TEST_GRAPHICS_CONTROLLER_H