[Vulkan] Graphics API cleanup

[platform/core/uifw/dali-core.git] / dali / graphics-api / graphics-api-render-command.h

diff --git a/dali/graphics-api/graphics-api-render-command.h b/dali/graphics-api/graphics-api-render-command.h
index ab81c21..60382d4 100644 (file)
--- a/dali/graphics-api/graphics-api-render-command.h
+++ b/dali/graphics-api/graphics-api-render-command.h
@@ -24,9 +24,6 @@
 #include <vector>
 
 // INTERNAL INCLUDES
-#include <dali/graphics-api/graphics-api-generic-buffer.h>
-#include <dali/graphics-api/utility/utility-builder.h>
-#include <dali/graphics-api/utility/utility-strong-type.h>
 #include <dali/graphics-api/graphics-api-shader-details.h>
 #include <dali/graphics-api/graphics-api-accessor.h>
 #include <dali/graphics-api/graphics-api-framebuffer.h>
@@ -42,6 +39,8 @@ class Shader;
 class Texture;
 class Buffer;
 class Sampler;
+class Pipeline;
+
 
 /**
  * @brief Interface class for RenderCommand types in the graphics API.
@@ -347,15 +346,28 @@ public:
    */
   struct RenderState
   {
+    struct BlendState
+    {
+      bool blendingEnabled { false };
+    };
+
     RenderState() = default;
 
     Accessor<Shader> shader { nullptr };
+    BlendState blendState {};
 
     RenderState& SetShader( Accessor<Shader> value )
     {
       shader = value;
       return *this;
     }
+
+    RenderState& SetBlendState( BlendState value )
+    {
+      blendState = value;
+      return *this;
+    }
+
     void*    pNext{ nullptr };
   };
 
@@ -367,7 +379,8 @@ public:
     mRenderTargetBinding(),
     mDrawCommand(),
     mPushConstantsBindings(),
-    mRenderState()
+    mRenderState(),
+    mPipeline( nullptr )
   {
   }
 
@@ -414,18 +427,36 @@ public:
     return *this;
   }
 
-  RenderCommand& BindRenderState( RenderState&& renderState )
+  RenderCommand& BindRenderState( RenderState& renderState )
   {
     mRenderState = renderState;
     return *this;
   }
 
+  RenderCommand& BindRenderTarget( const RenderTargetBinding& binding )
+  {
+    mRenderTargetBinding = binding;
+    return *this;
+  }
+
+  RenderCommand& BindRenderTarget( RenderTargetBinding&& binding )
+  {
+    mRenderTargetBinding = std::move(binding);
+    return *this;
+  }
+
   RenderCommand& Draw( DrawCommand&& drawCommand )
   {
     mDrawCommand = drawCommand;
     return *this;
   }
 
+  RenderCommand& BindPipeline( const Accessor<Pipeline>& pipeline )
+  {
+    mPipeline = pipeline;
+    return *this;
+  }
+
   static std::vector<VertexAttributeBufferBinding> NewVertexAttributeBufferBindings()
   {
     return std::vector<VertexAttributeBufferBinding>{};
@@ -499,6 +530,11 @@ public:
     return mRenderState;
   }
 
+  Accessor<Pipeline> GetPipeline() const
+  {
+    return mPipeline;
+  }
+
 protected:
 
   std::vector<VertexAttributeBufferBinding> mVertexBufferBindings;
@@ -510,13 +546,154 @@ protected:
   DrawCommand                               mDrawCommand;
   std::vector<PushConstantsBinding>         mPushConstantsBindings;
   RenderState                               mRenderState;
+  Accessor<Pipeline>                        mPipeline;
 
 };
 
-using RenderCommandBuilder = Utility::Builder<RenderCommand>;
-
 } // namespace API
 } // namespace Graphics
 } // namespace Dali
 
 #endif // DALI_GRAPHICS_API_RENDER_COMMAND_H
+
+
+/**
+ * @brief Interface class for RenderCommand types in the graphics API.
+ *
+ * @startuml
+ *
+ * skinparam defaultFontName Ubuntu Mono
+ * class RenderCommand {
+ *  -- protected --
+ *  #VertexAttributeBufferBinding[]  mVertexBufferBindings
+ *  #UniformBufferBinding[]          mUniformBufferBindings
+ *  #TextureBinding[]                mTextureBindings
+ *  #SamplerBinding[]                mSamplerBindings
+ *  #IndexBufferBinding              mIndexBufferBinding
+ *  #RenderTargetBinding             mRenderTargetBinding
+ *  #DrawCommand                     mDrawCommand
+ *  #PushConstantsBinding[]          mPushConstantsBindings
+ *  #RenderState                     mRenderState
+ *
+ * -- public API --
+ *  +RenderCommand& BindVertextBuffers()
+ *  +RenderCommand& BindUniformBuffers()
+ *  +RenderCommand& BindTextures()
+ *  +RenderCommand& BindSamplers()
+ *  +RenderCommand& PushConstants()
+ *  +RenderCommand& BindRenderState()
+ *  +RenderCommand& Draw()
+ *  -- static API ( helper functions )--
+ *  {static} NewVertexAttributeBufferBindings()
+ *  {static} NewVertexAttributeBufferBindings()
+ *  {static} NewVertexAttributeBufferBindings()
+ *  {static} NewTextureBindings()
+ *  {static} NewPushConstantsBindings()
+ * }
+ *
+ * class VertexAttributeBufferBinding {
+ * Accessor<Buffer>   buffer
+ * uint32_t           location
+ * uint32_t           offset
+ * uint32_t           stride
+ * InputAttributeRate rate
+ * void*              pNext
+ * }
+ *
+ * class UniformBufferBinding {
+ *   #Accessor<Buffer> buffer
+ *   #uint32_t         offset
+ *   #uint32_t         dataSize
+ *   #uint32_t         binding
+ *   #void*            pNext
+ * }
+ *
+  class IndexBufferBinding {
+    #Accessor<Buffer> buffer
+    #uint32_t         offset
+    #IndexType        type
+    #void*            pNext
+  }
+
+  class RenderTargetBinding {
+    #Accessor<Framebuffer>                 framebuffer
+    #std::vector<Framebuffer::ClearColor>  clearColors
+    #Framebuffer::DepthStencilClearColor   dsClearColor
+    #void*                                 pNext
+  }
+
+  class DrawCommand {
+      #DrawType drawType;
+      #uint32_t firstVertex
+      #uint32_t firstIndex
+      #uint32_t vertexCount
+      #uint32_t indicesCount
+      #uint32_t firstInstance
+      #uint32_t instanceCount
+      #void*    pNext
+  }
+
+  class PushConstantsBinding {
+    #void*     data
+    #uint32_t  size
+    #uint32_t  binding
+    #void*    pNext
+  }
+
+  class RenderState {
+    #Accessor<Shader> shader
+    #void*    pNext
+  }
+
+  class TextureBinding {
+    #Accessor<Texture> texture
+    #Accessor<Sampler> sampler
+    #uint32_t          binding
+    #void*             pNext
+  }
+
+  class SamplerBinding {
+    #Accessor<Sampler> sampler
+    #uint32_t binding
+    #void*    pNext
+  }
+
+ note as RenderStateWIP
+ Other render states like
+ blending etc. should be added
+ as public fields of this structure.
+ end note
+
+ RenderStateWIP .. RenderState
+
+ * note as N1
+ * Each state is described as POD
+ * structure which is a Vulkan
+ * approach.
+ * end note
+ *
+ * note as N2
+ * Field pNext may be used by the
+ * implementation to pass additional
+ * data.
+ * end note
+ *
+ * N2 .. VertexAttributeBufferBinding::pNext
+ * N1 .. VertexAttributeBufferBinding
+ * N1 .. UniformBufferBinding
+ * N1 .. IndexBufferBinding
+ * N1 .. RenderTargetBinding
+ *
+
+ *
+ * RenderCommand *-right- VertexAttributeBufferBinding
+ * RenderCommand *-right- UniformBufferBinding
+ * RenderCommand *-left- IndexBufferBinding
+ * RenderCommand *-left- RenderTargetBinding
+ * RenderCommand *-up- RenderState
+ * RenderCommand *-up- DrawCommand
+ * RenderCommand *-down- PushConstantsBinding
+ * RenderCommand *-down- SamplerBinding
+ * RenderCommand *-down- TextureBinding
+ * @enduml
+ */
\ No newline at end of file