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    * Auto generates mipmaps for the texture
 140    * @param[in] texture The texture
 141    */
 142   virtual void GenerateTextureMipmaps(const Texture& texture) = 0;
 143
 144   /**
 145    * @brief Enables depth/stencil buffer
 146    *
 147    * @param[in] enableDepth True to enable depth
 148    * @param[in] enableStencil True to enable stencil
 149    * @return True on success
 150    */
 151   virtual bool EnableDepthStencilBuffer(bool enableDepth, bool enableStencil) = 0;
 152
 153   /**
 154    * @brief Runs garbage collector (if supported)
 155    *
 156    * @param[in] numberOfDiscardedRenderers number of discarded renderers
 157    */
 158   virtual void RunGarbageCollector(size_t numberOfDiscardedRenderers) = 0;
 159
 160   /**
 161    * @brief Discards unused resources
 162    */
 163   virtual void DiscardUnusedResources() = 0;
 164
 165   /**
 166    * @brief Tests whether discard queue is empty
 167    *
 168    * @return True if empty
 169    */
 170   virtual bool IsDiscardQueueEmpty() = 0;
 171
 172   /**
 173    * @brief Test if the graphics subsystem has resumed & should force a draw
 174    *
 175    * @return true if the graphics subsystem requires a re-draw
 176    */
 177   virtual bool IsDrawOnResumeRequired() = 0;
 178
 179   /**
 180    * @brief Creates new Buffer object
 181    *
 182    * The Buffer object is created with underlying memory. The Buffer
 183    * specification is immutable. Based on the BufferCreateInfo::usage,
 184    * the memory may be client-side mappable or not.
 185    *
 186    * The old buffer may be passed as BufferCreateInfo::oldbuffer, however,
 187    * it's up to the implementation whether the object will be reused or
 188    * discarded and replaced by the new one.
 189    *
 190    * @param[in] bufferCreateInfo The valid BufferCreateInfo structure
 191    * @param[in] oldBuffer The valid pointer to the old object or nullptr. The object will be reused or destroyed.
 192    * @return pointer to the Buffer object
 193    */
 194   virtual UniquePtr<Buffer> CreateBuffer(const BufferCreateInfo& bufferCreateInfo, UniquePtr<Buffer>&& oldBuffer) = 0;
 195
 196   /**
 197    * @brief Creates new CommandBuffer object
 198    *
 199    * @param[in] bufferCreateInfo The valid BufferCreateInfo structure
 200    * @param[in] oldCommandBuffer The valid pointer to the old object or nullptr. The object will be reused or destroyed.
 201    * @return pointer to the CommandBuffer object
 202    */
 203   virtual UniquePtr<CommandBuffer> CreateCommandBuffer(const CommandBufferCreateInfo& commandBufferCreateInfo, UniquePtr<CommandBuffer>&& oldCommandBuffer) = 0;
 204
 205   /**
 206    * @brief Creates new RenderPass object
 207    *
 208    * @param[in] renderPassCreateInfo The valid RenderPassCreateInfo structure
 209    * @param[in] oldRenderPass The valid pointer to the old object or nullptr. The object will be reused or destroyed.
 210    * @return pointer to the RenderPass object
 211    */
 212   virtual UniquePtr<RenderPass> CreateRenderPass(const RenderPassCreateInfo& renderPassCreateInfo, UniquePtr<RenderPass>&& oldRenderPass) = 0;
 213
 214   /**
 215    * @brief Creates new Texture object
 216    *
 217    * @param[in] textureCreateInfo The valid TextureCreateInfo structure
 218    * @param[in] oldTexture The valid pointer to the old object or nullptr. The object will be reused or destroyed.
 219    * @return pointer to the TextureCreateInfo object
 220    */
 221   virtual UniquePtr<Texture> CreateTexture(const TextureCreateInfo& textureCreateInfo, UniquePtr<Texture>&& oldTexture) = 0;
 222
 223   /**
 224    * @brief Creates new Framebuffer object
 225    *
 226    * @param[in] framebufferCreateInfo The valid FramebufferCreateInfo structure
 227    * @param[in] oldFramebuffer The valid pointer to the old object or nullptr. The object will be reused or destroyed.
 228    * @return pointer to the Framebuffer object
 229    */
 230   virtual UniquePtr<Framebuffer> CreateFramebuffer(const FramebufferCreateInfo& framebufferCreateInfo, UniquePtr<Framebuffer>&& oldFramebuffer) = 0;
 231
 232   /**
 233    * @brief Creates new Pipeline object
 234    *
 235    * @param[in] pipelineCreateInfo The valid PipelineCreateInfo structure
 236    * @param[in] oldPipeline The valid pointer to the old object or nullptr. The object will be reused or destroyed.
 237    * @return pointer to the Pipeline object
 238    */
 239   virtual UniquePtr<Pipeline> CreatePipeline(const PipelineCreateInfo& pipelineCreateInfo, UniquePtr<Pipeline>&& oldPipeline) = 0;
 240
 241   /**
 242    * @brief Creates new Program object
 243    *
 244    * @param[in] ProgramCreateInfo The valid ProgramCreateInfo structure
 245    * @param[in] oldProgram The valid pointer to the old object or nullptr. The object will be reused or destroyed.
 246    * @return pointer to the Program object
 247    */
 248   virtual UniquePtr<Program> CreateProgram(const ProgramCreateInfo& programCreateInfo, UniquePtr<Program>&& oldProgram) = 0;
 249
 250   /**
 251    * @brief Creates new Shader object
 252    *
 253    * @param[in] shaderCreateInfo The valid ShaderCreateInfo structure
 254    * @param[in] oldShader The valid pointer to the old object or nullptr. The object will be reused or destroyed.
 255    * @return pointer to the Shader object
 256    */
 257   virtual UniquePtr<Shader> CreateShader(const ShaderCreateInfo& shaderCreateInfo, UniquePtr<Shader>&& oldShader) = 0;
 258
 259   /**
 260    * @brief Creates new Sampler object
 261    *
 262    * @param[in] samplerCreateInfo The valid SamplerCreateInfo structure
 263    * @param[in] oldSampler The valid pointer to the old object or nullptr. The object will be reused or destroyed.
 264    * @return pointer to the Sampler object
 265    */
 266   virtual UniquePtr<Sampler> CreateSampler(const SamplerCreateInfo& samplerCreateInfo, UniquePtr<Sampler>&& oldSampler) = 0;
 267
 268   /**
 269    * @brief Creates new RenderTarget object
 270    *
 271    * @param[in] renderTargetCreateInfo The valid RenderTargetCreateInfo structure
 272    * @param[in] oldRenderTarget The valid pointer to the old object or nullptr. The object will be reused or destroyed.
 273    * @return pointer to the RenderTarget object
 274    */
 275   virtual UniquePtr<RenderTarget> CreateRenderTarget(const RenderTargetCreateInfo& renderTargetCreateInfo, UniquePtr<RenderTarget>&& oldRenderTarget) = 0;
 276
 277   /**
 278    * @brief Maps memory associated with Buffer object
 279    *
 280    * @param[in] mapInfo Filled details of mapped resource
 281    * @return Returns pointer to Memory object or nullptr on error
 282    */
 283   virtual UniquePtr<Memory> MapBufferRange(const MapBufferInfo& mapInfo) = 0;
 284
 285   /**
 286    * @brief Maps memory associated with the texture.
 287    *
 288    * Only Texture objects that are backed with linear memory (staging memory) can be mapped.
 289    * Example:
 290    * 1) GLES implementation may create PBO object as staging memory and couple it
 291    * with the texture. Texture can be mapped and the memory can be read/write on demand.
 292    *
 293    * 2) Vulkan implementation may allocate DeviceMemory and use linear layout.
 294    *
 295    * @param[in] mapInfo Filled details of mapped resource
 296    *
 297    * @return Valid Memory object or nullptr on error
 298    */
 299   virtual UniquePtr<Memory> MapTextureRange(const MapTextureInfo& mapInfo) = 0;
 300
 301   /**
 302    * @brief Unmaps memory and discards Memory object
 303    *
 304    * This function automatically removes lock if Memory has been
 305    * previously locked.
 306    *
 307    * @param[in] memory Valid and previously mapped Memory object
 308    */
 309   virtual void UnmapMemory(UniquePtr<Memory> memory) = 0;
 310
 311   /**
 312    * @brief Returns memory requirements of the Texture object.
 313    *
 314    * Call this function whenever it's necessary to know how much memory
 315    * is needed to store all the texture data and what memory alignment
 316    * the data should follow.
 317    *
 318    * @return Returns memory requirements of Texture
 319    */
 320   virtual MemoryRequirements GetTextureMemoryRequirements(Texture& texture) const = 0;
 321
 322   /**
 323    * @brief Returns memory requirements of the Buffer object.
 324    *
 325    * Call this function whenever it's necessary to know how much memory
 326    * is needed to store all the buffer data and what memory alignment
 327    * the data should follow.
 328    *
 329    * @return Returns memory requirements of Buffer
 330    */
 331   virtual MemoryRequirements GetBufferMemoryRequirements(Buffer& buffer) const = 0;
 332
 333   /**
 334    * @brief Returns specification of the Texture object
 335    *
 336    * Function obtains specification of the Texture object. It may retrieve
 337    * implementation dependent details like ie. whether the texture is
 338    * emulated (for example, RGB emulated on RGBA), compressed etc.
 339    *
 340    * @return Returns the TextureProperties object
 341    */
 342   virtual const TextureProperties& GetTextureProperties(const Texture& texture) = 0;
 343
 344   /**
 345    * @brief Returns the reflection of the given program
 346    *
 347    * @param[in] program The program
 348    * @return The reflection of the program
 349    */
 350   virtual const Reflection& GetProgramReflection(const Program& program) = 0;
 351
 352   /**
 353    * @brief Tests whether two Pipelines are the same.
 354    *
 355    * On the higher level, this function may help wit creating pipeline cache.
 356    *
 357    * @return true if pipeline objects match
 358    */
 359   virtual bool PipelineEquals(const Pipeline& pipeline0, const Pipeline& pipeline1) const = 0;
 360
 361   /**
 362    * @brief Retrieves program parameters
 363    *
 364    * This function can be used to retrieve data from internal implementation
 365    *
 366    * @param[in] program Valid program object
 367    * @param[in] parameterId Integer parameter id
 368    * @param[out] outData Pointer to output memory
 369    * @return True on success
 370    */
 371   virtual bool GetProgramParameter(Graphics::Program& program, uint32_t parameterId, void* outData) = 0;
 372
 373 protected:
 374   /**
 375    * Creates controller
 376    */
 377   Controller() = default;
 378 };
 379 } // namespace Graphics
 380 } // namespace Dali
 381
 382 #endif