dali/graphics-api/graphics-command-buffer.h

   1 #ifndef DALI_GRAPHICS_COMMAND_BUFFER_H
   2 #define DALI_GRAPHICS_COMMAND_BUFFER_H
   3
   4 /*
   5  * Copyright (c) 2022 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 // INTERNAL INCLUDES
  22 #include "graphics-types.h"
  23
  24 namespace Dali::Graphics
  25 {
  26 class Buffer;
  27 class Pipeline;
  28 class RenderTarget;
  29 class RenderPass;
  30 class Sampler;
  31 class SyncObject;
  32 class Texture;
  33
  34 /**
  35  * @brief Uniform buffer bindings.
  36  */
  37 struct UniformBufferBinding
  38 {
  39   Buffer* buffer; // Buffer
  40   union
  41   {
  42     void*    offsetPtr; // pointer to the client-side memory
  43     uint32_t offset;    // Offset within buffer
  44   };
  45   uint32_t dataSize; // Size of data to bind
  46   uint32_t binding;  // Binding index
  47 };
  48
  49 /**
  50  * @brief Texture bindings
  51  *
  52  * Additionally, sampler may be used in case of having combined
  53  * image and sampler.
  54  *
  55  */
  56 struct TextureBinding
  57 {
  58   const Texture* texture; // texture to be bound
  59   const Sampler* sampler; // sampler to be bound
  60   uint32_t       binding; // binding index
  61 };
  62
  63 /**
  64  * @brief Sampler binding
  65  */
  66 struct SamplerBinding
  67 {
  68   Sampler* sampler; // sampler to be bound
  69   uint32_t binding; // binding index
  70 };
  71
  72 /**
  73  * @brief ClearValue contains an union of RGBA and depthStencil values.
  74  */
  75 struct ClearValue
  76 {
  77   union
  78   {
  79     struct
  80     {
  81       float r, g, b, a;
  82     } color;
  83     struct
  84     {
  85       float    depth;   // glClearDepthf
  86       uint32_t stencil; // glClearStencil
  87     } depthStencil;
  88   };
  89 };
  90
  91 // Native rendering (using native APIs)
  92
  93 enum class DrawNativeAPI
  94 {
  95   GLES,
  96   UNDEFINED
  97 };
  98
  99 struct DrawNativeInfo
 100 {
 101   DrawNativeAPI       api;      ///< API used by the callback
 102   Dali::CallbackBase* callback; ///< Callback pointer
 103
 104   /**
 105    * The call allows binding the resource so they can be passed into the callback
 106    * Each resource will pass API specific data (for example GL texture and buffer ids)
 107    */
 108   Graphics::Texture** textureList;  ///< Textures to be used by the call
 109   uint32_t            textureCount; ///< Number of texture used by the callback
 110   Graphics::Buffer**  bufferList;   ///< Buffers to be used by the call
 111   uint32_t            bufferCount;  ///< Number of buffers used by the callback
 112
 113   /**
 114    * The GLES api specific structure that stores pointers to objects to be filled when requested
 115    * by caller. The structure cointains void* to avoid creating any complex constructors and keep
 116    * the class trivial.
 117    */
 118   struct GLESNativeInfo
 119   {
 120     void* eglSharedContextStoragePointer; ///< Indicates the storage object to pass the shared context, must be null if not in use
 121   } glesNativeInfo;
 122
 123   void* userData; ///< Data passed into the callback (unspecified type, callback should decode it)
 124   void* reserved; ///< Reserved for internal use
 125 };
 126
 127 /**
 128  * @brief CommandBuffer contains a stream of commands to be executed
 129  * by the controller.
 130  */
 131 class CommandBuffer
 132 {
 133 public:
 134   CommandBuffer()          = default;
 135   virtual ~CommandBuffer() = default;
 136
 137   // not copyable
 138   CommandBuffer(const CommandBuffer&) = delete;
 139   CommandBuffer& operator=(const CommandBuffer&) = delete;
 140
 141   /**
 142    * @brief Binds vertex buffers
 143    *
 144    * The buffers and offsets arrays must be same length
 145    *
 146    * @param[in] firstBinding First binding index
 147    * @param[in] buffers List of buffers to bind
 148    * @param[in] offsets List of offsets for each buffer
 149    */
 150   virtual void BindVertexBuffers(uint32_t                          firstBinding,
 151                                  const std::vector<const Buffer*>& buffers,
 152                                  const std::vector<uint32_t>&      offsets) = 0;
 153
 154   /**
 155    * @brief Binds uniform buffers
 156    *
 157    * @param[in] bindings List of uniform buffer bindings
 158    */
 159   virtual void BindUniformBuffers(const std::vector<UniformBufferBinding>& bindings) = 0;
 160
 161   /**
 162    * @brief Binds pipeline
 163    *
 164    * @param[in] pipeline valid pipeline
 165    */
 166   virtual void BindPipeline(const Pipeline& pipeline) = 0;
 167
 168   /**
 169    * @brief Binds textures
 170    *
 171    * @param[in] textureBindings List of texture bindings
 172    */
 173   virtual void BindTextures(const std::vector<TextureBinding>& textureBindings) = 0;
 174
 175   /**
 176    * @brief Binds samplers
 177    *
 178    * @param[in] samplerBindings List of sampler bindings
 179    */
 180   virtual void BindSamplers(const std::vector<SamplerBinding>& samplerBindings) = 0;
 181
 182   /**
 183    * @brief Binds buffer containing push constants
 184    *
 185    * @param[in] data pointer to the buffer
 186    * @param[in] size size of data in bytes
 187    * @param[in] binding push constants binding index
 188    */
 189   virtual void BindPushConstants(void*    data,
 190                                  uint32_t size,
 191                                  uint32_t binding) = 0;
 192
 193   /**
 194    * @brief Binds index buffer
 195    *
 196    * Most commonly used formats:
 197    * R32_UINT,
 198    * R16_UINT
 199    *
 200    * @param[in] buffer Valid buffer
 201    * @param[in] offset offset within buffer
 202    * @param[in] format Format of index buffer
 203    */
 204   virtual void BindIndexBuffer(const Buffer& buffer,
 205                                uint32_t      offset,
 206                                Format        format) = 0;
 207   /**
 208    * @brief Begins render pass
 209    *
 210    * The function initialises rendering for specified RenderPass object
 211    * onto renderTarget. renderArea defines the scissor rect. Depends on the
 212    * renderPass spec, the clearValues may be used.
 213    *
 214    * Calling EndRenderPass() is necessary to finalize the render pass.
 215    *
 216    * @param[in] renderPass valid render pass object
 217    * @param[in] renderTarget valid render target, must not be used when framebuffer set
 218    * @param[in] renderArea area to draw (clear operation is affected)
 219    * @param[in] clearValues clear values (compatible with renderpass spec)
 220    */
 221   virtual void BeginRenderPass(
 222     RenderPass*                    renderPass,
 223     RenderTarget*                  renderTarget,
 224     Rect2D                         renderArea,
 225     const std::vector<ClearValue>& clearValues) = 0;
 226
 227   /**
 228    * @brief Ends current render pass
 229    *
 230    * This command must be issued in order to finalize the render pass.
 231    * It's up to the implementation whether anything has to be done but
 232    * the Controller may use end RP marker in order to resolve resource
 233    * dependencies (for example, to know when target texture is ready
 234    * before passing it to another render pass).
 235    *
 236    * The caller may query the sync object to determine when this render
 237    * pass has actually finished on the GPU.
 238    *
 239    * @param[in] syncObject If non-null, this object will ensure an
 240    * appropriate fence sync object is created after the render pass is
 241    * executed.
 242    */
 243   virtual void EndRenderPass(Graphics::SyncObject* syncObject) = 0;
 244
 245   /**
 246    * @brief Executes a list of secondary command buffers
 247    *
 248    * The secondary command buffers will be executed as a part of a primary
 249    * command buffer that calls this function.
 250    *
 251    * @param[in] commandBuffers List of buffers to execute
 252    */
 253   virtual void ExecuteCommandBuffers(std::vector<const CommandBuffer*>&& commandBuffers) = 0;
 254
 255   /**
 256    * @brief Draw primitives
 257    *
 258    * @param[in] vertexCount number of vertices
 259    * @param[in] instanceCount number of instances
 260    * @param[in] firstVertex index of first vertex
 261    * @param[in] firstInstance index of first instance
 262    */
 263   virtual void Draw(
 264     uint32_t vertexCount,
 265     uint32_t instanceCount,
 266     uint32_t firstVertex,
 267     uint32_t firstInstance) = 0;
 268
 269   /**
 270    * @brief Draws indexed primitives
 271    *
 272    * @param[in] indexCount Number of indices
 273    * @param[in] instanceCount Number of instances
 274    * @param[in] firstIndex first index
 275    * @param[in] vertexOffset offset of first vertex
 276    * @param[in] firstInstance first instance
 277    */
 278   virtual void DrawIndexed(
 279     uint32_t indexCount,
 280     uint32_t instanceCount,
 281     uint32_t firstIndex,
 282     int32_t  vertexOffset,
 283     uint32_t firstInstance) = 0;
 284
 285   /**
 286    * @brief Draws indexed primitives indirectly
 287    *
 288    * Indirect draw uses additional buffer that holds render data.
 289    *
 290    * Indirect draw support depends on the hardware (most of modern hardware
 291    * supports this drawing technique).
 292    *
 293    * @param[in] buffer Buffer containing draw parameters
 294    * @param[in] offset Offset in bytes where parameters begin
 295    * @param[in] drawCount number of draws to execute
 296    * @param[in] stride stride between draw parameters
 297    */
 298   virtual void DrawIndexedIndirect(
 299     Buffer&  buffer,
 300     uint32_t offset,
 301     uint32_t drawCount,
 302     uint32_t stride) = 0;
 303
 304   /**
 305    * @brief Draws using native API (via callback)
 306    *
 307    * DrawNative should be use in order to acquire direct access to the
 308    * graphics API like GL. Upon command execution, the backend will
 309    * invoke given callback and pass API-specific arguments (for example,
 310    * the GL callback will receive EGL context used for rendering).
 311    *
 312    * The client side must make sure the callback is valid for the
 313    * time of execution.
 314    *
 315    * @param[in] drawInfo NativeDrawInfo structure
 316    */
 317   virtual void DrawNative(const DrawNativeInfo* drawInfo) = 0;
 318
 319   /**
 320    * @brief Resets CommandBuffer
 321    *
 322    * This function resets the command buffer and discards all previously
 323    * recorded commands.
 324    *
 325    * Since the allocation may use internal memory pool of the CommandBuffer,
 326    * resetting doesn't have to discard all the resources (for example, it doesn't
 327    * need to destroy command but only move the pointer to the beginning of
 328    * the command buffer).
 329    *
 330    * It is useful if the command buffer has to be re-recorded frequently, for example,
 331    * every frame.
 332    */
 333   virtual void Reset() = 0;
 334
 335   /**
 336    * @brief Changes scissor rect
 337    *
 338    * @param[in] value 2D scissor rectangle
 339    */
 340   virtual void SetScissor(Rect2D value) = 0;
 341
 342   /**
 343    * @brief Enables/disables scissor test
 344    *
 345    * @param[in] value State of scissor test
 346    */
 347   virtual void SetScissorTestEnable(bool value) = 0;
 348
 349   /**
 350    * @brief Sets viewport
 351    *
 352    * @param[in] value 2D viewport area
 353    */
 354   virtual void SetViewport(Viewport value) = 0;
 355
 356   /**
 357    * @brief Sets whether the viewport should be changed
 358    * @param[in] value state of viewport
 359    */
 360   virtual void SetViewportEnable(bool value) = 0;
 361
 362   /**
 363    * @brief Sets the color mask for all channels.
 364    */
 365   virtual void SetColorMask(bool enabled) = 0;
 366
 367   /**
 368    * @brief Clears the stencil buffer (outside of BeginRenderPass) to the current stencil mask
 369    */
 370   virtual void ClearStencilBuffer() = 0;
 371
 372   /**
 373    * @brief Clears the depth buffer (outside of BeginRenderPass) to the current depth mask
 374    */
 375   virtual void ClearDepthBuffer() = 0;
 376
 377   /**
 378    * @brief Enable or disable the stencil test
 379    *
 380    * @param[in] stencilEnable whether stencil test should be enabled
 381    */
 382   virtual void SetStencilTestEnable(bool stencilEnable) = 0;
 383
 384   /**
 385    * @brief The mask used for writing to the stencil buffer.
 386    *
 387    * It should be as wide as necessary for the stencil texture format.
 388    * @param[in] writeMask The mask for wriing to / clearing the stencil buffer
 389    */
 390   virtual void SetStencilWriteMask(uint32_t writeMask) = 0;
 391
 392   /**
 393    * @brief Setup the stencil function
 394    *
 395    * @param[in] compareOp How the stencil buffer, reference and compareMask are combined to determine whether to draw a pixel or not.
 396    * @param[in] reference A reference value that is ANDed with the mask in the compare op.
 397    * @param[in] compareMask The bitplanes from the stencil buffer that are active.
 398    */
 399   virtual void SetStencilFunc(Graphics::CompareOp compareOp,
 400                               uint32_t            reference,
 401                               uint32_t            compareMask) = 0;
 402
 403   /**
 404    * @brief Set how subsequent draws will affect the stencil buffer.
 405    * @param[in] failOp What happens to stencil buffer if drawing a pixel fails the stencil test
 406    * @param[in] passOp What happens to stencil buffer if drawing a pixel passes stencil & depth test
 407    * @param[in] depthFailOp What happens to stencil buffer if drawing a pixel passes stencil but fails depth test.
 408    */
 409   virtual void SetStencilOp(Graphics::StencilOp failOp,
 410                             Graphics::StencilOp passOp,
 411                             Graphics::StencilOp depthFailOp) = 0;
 412
 413   /**
 414    * @brief Defines the comparison operator for passing the depth test.
 415    *
 416    * @param[in] compareOp The comparison operator
 417    */
 418   virtual void SetDepthCompareOp(Graphics::CompareOp compareOp) = 0;
 419
 420   /**
 421    * @brief Enables depth testing
 422    *
 423    * @param[in] depthTestEnable True if depth testing will be enabled.
 424    */
 425   virtual void SetDepthTestEnable(bool depthTestEnable) = 0;
 426
 427   /**
 428    * @brief Enables depth writing / clearing
 429    *
 430    * @param[in] depthWriteEnabled True if the depth buffer can be updated or cleared.
 431    */
 432   virtual void SetDepthWriteEnable(bool depthWriteEnable) = 0;
 433
 434 protected:
 435   CommandBuffer(CommandBuffer&&) = default;
 436   CommandBuffer& operator=(CommandBuffer&&) = default;
 437 };
 438 } // namespace Dali::Graphics
 439
 440 #endif