automated-tests/src/dali-toolkit/dali-toolkit-test-utils/test-graphics-controller.h

   1 #ifndef TEST_GRAPHICS_CONTROLLER_H
   2 #define TEST_GRAPHICS_CONTROLLER_H
   3
   4 /*
   5  * Copyright (c) 2021 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  */
  19
  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"
  26
  27 namespace Dali
  28 {
  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);
  38
  39 class TestGraphicsController : public Dali::Graphics::Controller
  40 {
  41 public:
  42   TestGraphicsController();
  43
  44   virtual ~TestGraphicsController() = default;
  45
  46   void Initialize()
  47   {
  48     mGl.Initialize();
  49   }
  50
  51   Integration::GlAbstraction& GetGlAbstraction() override
  52   {
  53     return mGl;
  54   }
  55
  56   Integration::GlSyncAbstraction& GetGlSyncAbstraction() override
  57   {
  58     return mGlSyncAbstraction;
  59   }
  60
  61   Integration::GlContextHelperAbstraction& GetGlContextHelperAbstraction() override
  62   {
  63     return mGlContextHelperAbstraction;
  64   }
  65
  66   void SubmitCommandBuffers(const Graphics::SubmitInfo& submitInfo) override;
  67
  68   /**
  69    * @brief Presents render target
  70    * @param renderTarget render target to present
  71    */
  72   void PresentRenderTarget(Graphics::RenderTarget* renderTarget) override;
  73
  74   /**
  75    * @brief Waits until the GPU is idle
  76    */
  77   void WaitIdle() override;
  78
  79   /**
  80    * @brief Lifecycle pause event
  81    */
  82   void Pause() override;
  83
  84   /**
  85    * @brief Lifecycle resume event
  86    */
  87   void Resume() override;
  88
  89   /**
  90    * @brief Executes batch update of textures
  91    *
  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)
  96    *
  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.
 100    *
 101    */
 102   void UpdateTextures(const std::vector<Graphics::TextureUpdateInfo>&       updateInfoList,
 103                       const std::vector<Graphics::TextureUpdateSourceInfo>& sourceList) override;
 104
 105   /**
 106    * TBD: do we need those functions in the new implementation?
 107    */
 108   bool EnableDepthStencilBuffer(bool enableDepth, bool enableStencil) override;
 109
 110   void RunGarbageCollector(size_t numberOfDiscardedRenderers) override;
 111
 112   void DiscardUnusedResources() override;
 113
 114   bool IsDiscardQueueEmpty() override;
 115
 116   /**
 117    * @brief Test if the graphics subsystem has resumed & should force a draw
 118    *
 119    * @return true if the graphics subsystem requires a re-draw
 120    */
 121   bool IsDrawOnResumeRequired() override;
 122
 123   /**
 124    * @brief Creates new Buffer object
 125    *
 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.
 129    *
 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.
 133    *
 134    * @param[in] bufferCreateInfo The valid BufferCreateInfo structure
 135    * @return pointer to the Buffer object
 136    */
 137   Graphics::UniquePtr<Graphics::Buffer> CreateBuffer(const Graphics::BufferCreateInfo& bufferCreateInfo, Graphics::UniquePtr<Graphics::Buffer>&& oldBuffer) override;
 138
 139   /**
 140    * @brief Creates new CommandBuffer object
 141    *
 142    * @param[in] bufferCreateInfo The valid BufferCreateInfo structure
 143    * @return pointer to the CommandBuffer object
 144    */
 145   Graphics::UniquePtr<Graphics::CommandBuffer> CreateCommandBuffer(const Graphics::CommandBufferCreateInfo& commandBufferCreateInfo, Graphics::UniquePtr<Graphics::CommandBuffer>&& oldCommandBuffer) override;
 146
 147   /**
 148    * @brief Creates new RenderPass object
 149    *
 150    * @param[in] renderPassCreateInfo The valid RenderPassCreateInfo structure
 151    * @return pointer to the RenderPass object
 152    */
 153   Graphics::UniquePtr<Graphics::RenderPass> CreateRenderPass(const Graphics::RenderPassCreateInfo& renderPassCreateInfo, Graphics::UniquePtr<Graphics::RenderPass>&& oldRenderPass) override;
 154
 155   /**
 156    * @brief Creates new Texture object
 157    *
 158    * @param[in] textureCreateInfo The valid TextureCreateInfo structure
 159    * @return pointer to the TextureCreateInfo object
 160    */
 161   Graphics::UniquePtr<Graphics::Texture> CreateTexture(const Graphics::TextureCreateInfo& textureCreateInfo, Graphics::UniquePtr<Graphics::Texture>&& oldTexture) override;
 162
 163   /**
 164    * @brief Creates new Framebuffer object
 165    *
 166    * @param[in] framebufferCreateInfo The valid FramebufferCreateInfo structure
 167    * @return pointer to the Framebuffer object
 168    */
 169   Graphics::UniquePtr<Graphics::Framebuffer> CreateFramebuffer(const Graphics::FramebufferCreateInfo& framebufferCreateInfo, Graphics::UniquePtr<Graphics::Framebuffer>&& oldFramebuffer) override;
 170
 171   /**
 172    * @brief Creates new Pipeline object
 173    *
 174    * @param[in] pipelineCreateInfo The valid PipelineCreateInfo structure
 175    * @return pointer to the Pipeline object
 176    */
 177   Graphics::UniquePtr<Graphics::Pipeline> CreatePipeline(const Graphics::PipelineCreateInfo& pipelineCreateInfo, Graphics::UniquePtr<Graphics::Pipeline>&& oldPipeline) override;
 178
 179   /**
 180    * @brief Creates new Program object
 181    *
 182    * @param[in] programCreateInfo The valid ProgramCreateInfo structure
 183    * @return pointer to the Program object
 184    */
 185   Graphics::UniquePtr<Graphics::Program> CreateProgram(const Graphics::ProgramCreateInfo& programCreateInfo, Graphics::UniquePtr<Graphics::Program>&& oldProgram) override;
 186
 187   /**
 188    * @brief Creates new Shader object
 189    *
 190    * @param[in] shaderCreateInfo The valid ShaderCreateInfo structure
 191    * @return pointer to the Shader object
 192    */
 193   Graphics::UniquePtr<Graphics::Shader> CreateShader(const Graphics::ShaderCreateInfo& shaderCreateInfo, Graphics::UniquePtr<Graphics::Shader>&& oldShader) override;
 194
 195   /**
 196    * @brief Creates new Sampler object
 197    *
 198    * @param[in] samplerCreateInfo The valid SamplerCreateInfo structure
 199    * @return pointer to the Sampler object
 200    */
 201   Graphics::UniquePtr<Graphics::Sampler> CreateSampler(const Graphics::SamplerCreateInfo& samplerCreateInfo, Graphics::UniquePtr<Graphics::Sampler>&& oldSampler) override;
 202
 203   /**
 204    * @brief Creates new RenderTarget object
 205    *
 206    * @param[in] renderTargetCreateInfo The valid RenderTargetCreateInfo structure
 207    * @return pointer to the RenderTarget object
 208    */
 209   Graphics::UniquePtr<Graphics::RenderTarget> CreateRenderTarget(const Graphics::RenderTargetCreateInfo& renderTargetCreateInfo, Graphics::UniquePtr<Graphics::RenderTarget>&& oldRenderTarget) override;
 210
 211   /**
 212    * @brief Maps memory associated with Buffer object
 213    *
 214    * @param[in] mapInfo Filled details of mapped resource
 215    *
 216    * @return Returns pointer to Memory object or Graphicsnullptr on error
 217    */
 218   Graphics::UniquePtr<Graphics::Memory> MapBufferRange(const Graphics::MapBufferInfo& mapInfo) override;
 219
 220   /**
 221    * @brief Maps memory associated with the texture.
 222    *
 223    * Only Texture objects that are backed with linear memory (staging memory) can be mapped.
 224    * Example:
 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.
 227    *
 228    * 2) Vulkan implementation may allocate DeviceMemory and use linear layout.
 229    *
 230    * @param[in] mapInfo Filled details of mapped resource
 231    *
 232    * @return Valid Memory object or nullptr on error
 233    */
 234   Graphics::UniquePtr<Graphics::Memory> MapTextureRange(const Graphics::MapTextureInfo& mapInfo) override;
 235
 236   /**
 237    * @brief Unmaps memory and discards Memory object
 238    *
 239    * This function automatically removes lock if Memory has been
 240    * previously locked.
 241    *
 242    * @param[in] memory Valid and previously mapped Memory object
 243    */
 244   void UnmapMemory(Graphics::UniquePtr<Graphics::Memory> memory) override;
 245
 246   /**
 247    * @brief Returns memory requirements of the Texture object.
 248    *
 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.
 252    *
 253    * @return Returns memory requirements of Texture
 254    */
 255   Graphics::MemoryRequirements GetTextureMemoryRequirements(Graphics::Texture& texture) const override;
 256
 257   /**
 258    * @brief Returns memory requirements of the Buffer object.
 259    *
 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.
 263    *
 264    * @return Returns memory requirements of Buffer
 265    */
 266   Graphics::MemoryRequirements GetBufferMemoryRequirements(Graphics::Buffer& buffer) const override;
 267
 268   /**
 269    * @brief Returns specification of the Texture object
 270    *
 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.
 274    *
 275    * @return Returns the TextureProperties object
 276    */
 277   const Graphics::TextureProperties& GetTextureProperties(const Graphics::Texture& texture) override;
 278
 279   /**
 280    * @brief Returns the reflection of the given program
 281    *
 282    * @param[in] program The program
 283    * @return The reflection of the program
 284    */
 285   const Graphics::Reflection& GetProgramReflection(const Graphics::Program& program) override;
 286
 287   /**
 288    * @brief Tests whether two Pipelines are the same.
 289    *
 290    * On the higher level, this function may help wit creating pipeline cache.
 291    *
 292    * @return true if pipeline objects match
 293    */
 294   bool PipelineEquals(const Graphics::Pipeline& pipeline0, const Graphics::Pipeline& pipeline1) const override;
 295
 296 public: // Test Functions
 297   void SetVertexFormats(Property::Array& vfs)
 298   {
 299     mVertexFormats = vfs;
 300   }
 301
 302   void AddCustomUniforms(std::vector<UniformData>& customUniforms)
 303   {
 304     mCustomUniforms = customUniforms;
 305   }
 306
 307   void ClearSubmitStack()
 308   {
 309     mSubmitStack.clear();
 310   }
 311
 312   /**
 313    * @brief Retrieves program parameters
 314    *
 315    * This function can be used to retrieve data from internal implementation
 316    *
 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
 321    */
 322   bool GetProgramParameter(Graphics::Program& program, uint32_t parameterId, void* outData) override;
 323
 324 public:
 325   mutable TraceCallStack                    mCallStack;
 326   mutable TraceCallStack                    mCommandBufferCallStack;
 327   mutable std::vector<Graphics::SubmitInfo> mSubmitStack;
 328
 329   TestGlAbstraction              mGl;
 330   TestGlSyncAbstraction          mGlSyncAbstraction;
 331   TestGlContextHelperAbstraction mGlContextHelperAbstraction;
 332
 333   bool isDiscardQueueEmptyResult{true};
 334   bool isDrawOnResumeRequiredResult{true};
 335
 336   Property::Array mVertexFormats;
 337
 338   struct ProgramCache
 339   {
 340     std::map<Graphics::PipelineStage, std::vector<uint8_t>> shaders;
 341     TestGraphicsProgramImpl*                                programImpl;
 342   };
 343   std::vector<ProgramCache> mProgramCache;
 344
 345   std::vector<UniformData> mCustomUniforms;
 346 };
 347
 348 } // namespace Dali
 349
 350 #endif //TEST_GRAPHICS_CONTROLLER_H