dali/graphics-api/graphics-controller.h

   1 #ifndef DALI_GRAPHICS_CONTROLLER_H
   2 #define DALI_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
  21 // EXTERNAL INCLUDES
  22 #include <memory>
  23 #include <vector>
  24
  25 // INTERNAL INCLUDES
  26 #include "graphics-buffer-create-info.h"
  27 #include "graphics-command-buffer-create-info.h"
  28 #include "graphics-framebuffer-create-info.h"
  29 #include "graphics-memory.h"
  30 #include "graphics-pipeline-create-info.h"
  31 #include "graphics-program-create-info.h"
  32 #include "graphics-reflection.h"
  33 #include "graphics-render-pass-create-info.h"
  34 #include "graphics-render-target-create-info.h"
  35 #include "graphics-sampler-create-info.h"
  36 #include "graphics-shader-create-info.h"
  37 #include "graphics-texture-create-info.h"
  38
  39 namespace Dali
  40 {
  41 namespace Integration
  42 {
  43 class GlAbstraction;
  44 class GlSyncAbstraction;
  45 class GlContextHelperAbstraction;
  46 } // namespace Integration
  47
  48 namespace Graphics
  49 {
  50 class CommandBuffer;
  51 class Command;
  52 class RenderTarget;
  53 class RenderPass;
  54 class Buffer;
  55 class Texture;
  56 class Shader;
  57 class Framebuffer;
  58 class Pipeline;
  59 class Sampler;
  60 class Memory;
  61
  62 /**
  63  * @brief Controller class controls render loop
  64  *
  65  * Controller class is responsible for executing render calls
  66  * and controlling pipeline state.
  67  */
  68 class Controller
  69 {
  70 public:
  71   // Temporary until graphics api is complete
  72   virtual Integration::GlAbstraction&              GetGlAbstraction()              = 0;
  73   virtual Integration::GlSyncAbstraction&          GetGlSyncAbstraction()          = 0;
  74   virtual Integration::GlContextHelperAbstraction& GetGlContextHelperAbstraction() = 0;
  75
  76   /**
  77    * @brief Destroys controller
  78    */
  79   virtual ~Controller() = default;
  80
  81   /**
  82    * @brief Submits array of command buffers
  83    *
  84    * Submits command buffers to the graphics pipeline. Submitted commands
  85    * may be executed instantly or postponed.
  86    *
  87    * @param[in] submitInfo Valid SubmitInfo structure
  88    */
  89   virtual void SubmitCommandBuffers(const SubmitInfo& submitInfo) = 0;
  90
  91   /**
  92    * @brief Presents render target
  93    * @param renderTarget render target to present
  94    */
  95   virtual void PresentRenderTarget(RenderTarget* renderTarget) = 0;
  96
  97   /**
  98    * @brief Waits until the GPU is idle
  99    */
 100   virtual void WaitIdle() = 0;
 101
 102   /**
 103    * @brief Lifecycle pause event
 104    */
 105   virtual void Pause() = 0;
 106
 107   /**
 108    * @brief Lifecycle resume event
 109    */
 110   virtual void Resume() = 0;
 111
 112   /**
 113    * @brief Lifecycle shutdown event
 114    */
 115   virtual void Shutdown() = 0;
 116
 117   /**
 118    * @brief Lifecycle destroy event
 119    */
 120   virtual void Destroy() = 0;
 121
 122   /**
 123    * @brief Executes batch update of textures
 124    *
 125    * This function may perform full or partial update of many textures.
 126    * The data source may come from:
 127    * - CPU memory (client side)
 128    * - GPU memory (another Texture or Buffer)
 129    *
 130    * UpdateTextures() is the only way to update unmappable Texture objects.
 131    * It is recommended to batch updates as it may help with optimizing
 132    * memory transfers based on dependencies.
 133    *
 134    */
 135   virtual void UpdateTextures(const std::vector<TextureUpdateInfo>&       updateInfoList,
 136                               const std::vector<TextureUpdateSourceInfo>& sourceList) = 0;
 137
 138   /**
 139    * @brief Enables depth/stencil buffer
 140    *
 141    * @param[in] enableDepth True to enable depth
 142    * @param[in] enableStencil True to enable stencil
 143    * @return True on success
 144    */
 145   virtual bool EnableDepthStencilBuffer(bool enableDepth, bool enableStencil) = 0;
 146
 147   /**
 148    * @brief Runs garbage collector (if supported)
 149    *
 150    * @param[in] numberOfDiscardedRenderers number of discarded renderers
 151    */
 152   virtual void RunGarbageCollector(size_t numberOfDiscardedRenderers) = 0;
 153
 154   /**
 155    * @brief Discards unused resources
 156    */
 157   virtual void DiscardUnusedResources() = 0;
 158
 159   /**
 160    * @brief Tests whether discard queue is empty
 161    *
 162    * @return True if empty
 163    */
 164   virtual bool IsDiscardQueueEmpty() = 0;
 165
 166   /**
 167    * @brief Test if the graphics subsystem has resumed & should force a draw
 168    *
 169    * @return true if the graphics subsystem requires a re-draw
 170    */
 171   virtual bool IsDrawOnResumeRequired() = 0;
 172
 173   /**
 174    * @brief Creates new Buffer object
 175    *
 176    * The Buffer object is created with underlying memory. The Buffer
 177    * specification is immutable. Based on the BufferCreateInfo::usage,
 178    * the memory may be client-side mappable or not.
 179    *
 180    * The old buffer may be passed as BufferCreateInfo::oldbuffer, however,
 181    * it's up to the implementation whether the object will be reused or
 182    * discarded and replaced by the new one.
 183    *
 184    * @param[in] bufferCreateInfo The valid BufferCreateInfo structure
 185    * @param[in] oldBuffer The valid pointer to the old object or nullptr. The object will be reused or destroyed.
 186    * @return pointer to the Buffer object
 187    */
 188   virtual UniquePtr<Buffer> CreateBuffer(const BufferCreateInfo& bufferCreateInfo, UniquePtr<Buffer>&& oldBuffer) = 0;
 189
 190   /**
 191    * @brief Creates new CommandBuffer object
 192    *
 193    * @param[in] bufferCreateInfo The valid BufferCreateInfo structure
 194    * @param[in] oldCommandBuffer The valid pointer to the old object or nullptr. The object will be reused or destroyed.
 195    * @return pointer to the CommandBuffer object
 196    */
 197   virtual UniquePtr<CommandBuffer> CreateCommandBuffer(const CommandBufferCreateInfo& commandBufferCreateInfo, UniquePtr<CommandBuffer>&& oldCommandBuffer) = 0;
 198
 199   /**
 200    * @brief Creates new RenderPass object
 201    *
 202    * @param[in] renderPassCreateInfo The valid RenderPassCreateInfo structure
 203    * @param[in] oldRenderPass The valid pointer to the old object or nullptr. The object will be reused or destroyed.
 204    * @return pointer to the RenderPass object
 205    */
 206   virtual UniquePtr<RenderPass> CreateRenderPass(const RenderPassCreateInfo& renderPassCreateInfo, UniquePtr<RenderPass>&& oldRenderPass) = 0;
 207
 208   /**
 209    * @brief Creates new Texture object
 210    *
 211    * @param[in] textureCreateInfo The valid TextureCreateInfo structure
 212    * @param[in] oldTexture The valid pointer to the old object or nullptr. The object will be reused or destroyed.
 213    * @return pointer to the TextureCreateInfo object
 214    */
 215   virtual UniquePtr<Texture> CreateTexture(const TextureCreateInfo& textureCreateInfo, UniquePtr<Texture>&& oldTexture) = 0;
 216
 217   /**
 218    * @brief Creates new Framebuffer object
 219    *
 220    * @param[in] framebufferCreateInfo The valid FramebufferCreateInfo structure
 221    * @param[in] oldFramebuffer The valid pointer to the old object or nullptr. The object will be reused or destroyed.
 222    * @return pointer to the Framebuffer object
 223    */
 224   virtual UniquePtr<Framebuffer> CreateFramebuffer(const FramebufferCreateInfo& framebufferCreateInfo, UniquePtr<Framebuffer>&& oldFramebuffer) = 0;
 225
 226   /**
 227    * @brief Creates new Pipeline object
 228    *
 229    * @param[in] pipelineCreateInfo The valid PipelineCreateInfo structure
 230    * @param[in] oldPipeline The valid pointer to the old object or nullptr. The object will be reused or destroyed.
 231    * @return pointer to the Pipeline object
 232    */
 233   virtual UniquePtr<Pipeline> CreatePipeline(const PipelineCreateInfo& pipelineCreateInfo, UniquePtr<Pipeline>&& oldPipeline) = 0;
 234
 235   /**
 236    * @brief Creates new Program object
 237    *
 238    * @param[in] ProgramCreateInfo The valid ProgramCreateInfo structure
 239    * @param[in] oldProgram The valid pointer to the old object or nullptr. The object will be reused or destroyed.
 240    * @return pointer to the Program object
 241    */
 242   virtual UniquePtr<Program> CreateProgram(const ProgramCreateInfo& programCreateInfo, UniquePtr<Program>&& oldProgram) = 0;
 243
 244   /**
 245    * @brief Creates new Shader object
 246    *
 247    * @param[in] shaderCreateInfo The valid ShaderCreateInfo structure
 248    * @param[in] oldShader The valid pointer to the old object or nullptr. The object will be reused or destroyed.
 249    * @return pointer to the Shader object
 250    */
 251   virtual UniquePtr<Shader> CreateShader(const ShaderCreateInfo& shaderCreateInfo, UniquePtr<Shader>&& oldShader) = 0;
 252
 253   /**
 254    * @brief Creates new Sampler object
 255    *
 256    * @param[in] samplerCreateInfo The valid SamplerCreateInfo structure
 257    * @param[in] oldSampler The valid pointer to the old object or nullptr. The object will be reused or destroyed.
 258    * @return pointer to the Sampler object
 259    */
 260   virtual UniquePtr<Sampler> CreateSampler(const SamplerCreateInfo& samplerCreateInfo, UniquePtr<Sampler>&& oldSampler) = 0;
 261
 262   /**
 263    * @brief Creates new RenderTarget object
 264    *
 265    * @param[in] renderTargetCreateInfo The valid RenderTargetCreateInfo structure
 266    * @param[in] oldRenderTarget The valid pointer to the old object or nullptr. The object will be reused or destroyed.
 267    * @return pointer to the RenderTarget object
 268    */
 269   virtual UniquePtr<RenderTarget> CreateRenderTarget(const RenderTargetCreateInfo& renderTargetCreateInfo, UniquePtr<RenderTarget>&& oldRenderTarget) = 0;
 270
 271   /**
 272    * @brief Maps memory associated with Buffer object
 273    *
 274    * @param[in] mapInfo Filled details of mapped resource
 275    * @return Returns pointer to Memory object or nullptr on error
 276    */
 277   virtual UniquePtr<Memory> MapBufferRange(const MapBufferInfo& mapInfo) = 0;
 278
 279   /**
 280    * @brief Maps memory associated with the texture.
 281    *
 282    * Only Texture objects that are backed with linear memory (staging memory) can be mapped.
 283    * Example:
 284    * 1) GLES implementation may create PBO object as staging memory and couple it
 285    * with the texture. Texture can be mapped and the memory can be read/write on demand.
 286    *
 287    * 2) Vulkan implementation may allocate DeviceMemory and use linear layout.
 288    *
 289    * @param[in] mapInfo Filled details of mapped resource
 290    *
 291    * @return Valid Memory object or nullptr on error
 292    */
 293   virtual UniquePtr<Memory> MapTextureRange(const MapTextureInfo& mapInfo) = 0;
 294
 295   /**
 296    * @brief Unmaps memory and discards Memory object
 297    *
 298    * This function automatically removes lock if Memory has been
 299    * previously locked.
 300    *
 301    * @param[in] memory Valid and previously mapped Memory object
 302    */
 303   virtual void UnmapMemory(UniquePtr<Memory> memory) = 0;
 304
 305   /**
 306    * @brief Returns memory requirements of the Texture object.
 307    *
 308    * Call this function whenever it's necessary to know how much memory
 309    * is needed to store all the texture data and what memory alignment
 310    * the data should follow.
 311    *
 312    * @return Returns memory requirements of Texture
 313    */
 314   virtual MemoryRequirements GetTextureMemoryRequirements(Texture& texture) const = 0;
 315
 316   /**
 317    * @brief Returns memory requirements of the Buffer object.
 318    *
 319    * Call this function whenever it's necessary to know how much memory
 320    * is needed to store all the buffer data and what memory alignment
 321    * the data should follow.
 322    *
 323    * @return Returns memory requirements of Buffer
 324    */
 325   virtual MemoryRequirements GetBufferMemoryRequirements(Buffer& buffer) const = 0;
 326
 327   /**
 328    * @brief Returns specification of the Texture object
 329    *
 330    * Function obtains specification of the Texture object. It may retrieve
 331    * implementation dependent details like ie. whether the texture is
 332    * emulated (for example, RGB emulated on RGBA), compressed etc.
 333    *
 334    * @return Returns the TextureProperties object
 335    */
 336   virtual const TextureProperties& GetTextureProperties(const Texture& texture) = 0;
 337
 338   /**
 339    * @brief Returns the reflection of the given program
 340    *
 341    * @param[in] program The program
 342    * @return The reflection of the program
 343    */
 344   virtual const Reflection& GetProgramReflection(const Program& program) = 0;
 345
 346   /**
 347    * @brief Tests whether two Pipelines are the same.
 348    *
 349    * On the higher level, this function may help wit creating pipeline cache.
 350    *
 351    * @return true if pipeline objects match
 352    */
 353   virtual bool PipelineEquals(const Pipeline& pipeline0, const Pipeline& pipeline1) const = 0;
 354
 355   /**
 356    * @brief Retrieves program parameters
 357    *
 358    * This function can be used to retrieve data from internal implementation
 359    *
 360    * @param[in] program Valid program object
 361    * @param[in] parameterId Integer parameter id
 362    * @param[out] outData Pointer to output memory
 363    * @return True on success
 364    */
 365   virtual bool GetProgramParameter(Graphics::Program& program, uint32_t parameterId, void* outData ) = 0;
 366
 367 protected:
 368   /**
 369    * Creates controller
 370    */
 371   Controller() = default;
 372 };
 373 } // namespace Graphics
 374 } // namespace Dali
 375
 376 #endif