dali/graphics-api/graphics-types.h

   1 #ifndef DALI_GRAPHICS_API_TYPES
   2 #define DALI_GRAPHICS_API_TYPES
   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 <string>
  24 #include <utility>
  25 #include <vector>
  26
  27 namespace Dali
  28 {
  29 namespace Graphics
  30 {
  31 class Buffer;
  32 class CommandBuffer;
  33 class Framebuffer;
  34 class Program;
  35 class Shader;
  36 class Texture;
  37
  38 /**
  39  * @brief Structure describes 2D offset
  40  */
  41 struct Offset2D
  42 {
  43   int32_t x = 0;
  44   int32_t y = 0;
  45 };
  46
  47 /**
  48  * @brief Structure describes 2D dimensions
  49  */
  50 struct Extent2D
  51 {
  52   uint32_t width;
  53   uint32_t height;
  54 };
  55
  56 /**
  57  * @brief Structure describes 2D rectangle (offset, extent)
  58  */
  59 struct Rect2D
  60 {
  61   int32_t  x      = 0;
  62   int32_t  y      = 0;
  63   uint32_t width  = 0;
  64   uint32_t height = 0;
  65 };
  66
  67 /**
  68  * @brief Structure represents area of viewport
  69  */
  70 struct Viewport
  71 {
  72   float x        = 0.0f;
  73   float y        = 0.0f;
  74   float width    = 0.0f;
  75   float height   = 0.0f;
  76   float minDepth = 0.0f;
  77   float maxDepth = 0.0f;
  78 };
  79
  80 /**
  81  * @brief Describes vertex attribute input rate
  82  */
  83 enum class VertexInputRate
  84 {
  85   PER_VERTEX,  ///< Attribute read per vertex
  86   PER_INSTANCE ///< Attribute read per instance
  87 };
  88
  89 /**
  90  * @brief Vertex input format
  91  *
  92  * When UNDEFINED, the reflection is used to determine what
  93  * the actual format is.
  94  */
  95 enum class VertexInputFormat
  96 {
  97   UNDEFINED,
  98   FVECTOR2,
  99   FVECTOR3,
 100   FVECTOR4,
 101   IVECTOR2,
 102   IVECTOR3,
 103   IVECTOR4,
 104   FLOAT,
 105   INTEGER,
 106 };
 107
 108 /**
 109  * @brief Logic operators used by color blending state
 110  * when logicOpEnable is set.
 111  */
 112 enum class LogicOp
 113 {
 114   CLEAR         = 0,
 115   AND           = 1,
 116   AND_REVERSE   = 2,
 117   COPY          = 3,
 118   AND_INVERTED  = 4,
 119   NO_OP         = 5,
 120   XOR           = 6,
 121   OR            = 7,
 122   NOR           = 8,
 123   EQUIVALENT    = 9,
 124   INVERT        = 10,
 125   OR_REVERSE    = 11,
 126   COPY_INVERTED = 12,
 127   OR_INVERTED   = 13,
 128   NAND          = 14,
 129   SET           = 15,
 130 };
 131
 132 /**
 133  * @brief Blend factors
 134  */
 135 enum class BlendFactor
 136 {
 137   ZERO                     = 0,
 138   ONE                      = 1,
 139   SRC_COLOR                = 2,
 140   ONE_MINUS_SRC_COLOR      = 3,
 141   DST_COLOR                = 4,
 142   ONE_MINUS_DST_COLOR      = 5,
 143   SRC_ALPHA                = 6,
 144   ONE_MINUS_SRC_ALPHA      = 7,
 145   DST_ALPHA                = 8,
 146   ONE_MINUS_DST_ALPHA      = 9,
 147   CONSTANT_COLOR           = 10,
 148   ONE_MINUS_CONSTANT_COLOR = 11,
 149   CONSTANT_ALPHA           = 12,
 150   ONE_MINUS_CONSTANT_ALPHA = 13,
 151   SRC_ALPHA_SATURATE       = 14,
 152   SRC1_COLOR               = 15,
 153   ONE_MINUS_SRC1_COLOR     = 16,
 154   SRC1_ALPHA               = 17,
 155   ONE_MINUS_SRC1_ALPHA     = 18,
 156 };
 157
 158 /**
 159  * @brief Blend operators
 160  */
 161 enum class BlendOp
 162 {
 163   ADD              = 0,
 164   SUBTRACT         = 1,
 165   REVERSE_SUBTRACT = 2,
 166   MIN              = 3,
 167   MAX              = 4,
 168 };
 169
 170 /**
 171  * @brief Compare operators
 172  */
 173 enum class CompareOp
 174 {
 175   NEVER,
 176   LESS,
 177   EQUAL,
 178   LESS_OR_EQUAL,
 179   GREATER,
 180   NOT_EQUAL,
 181   GREATER_OR_EQUAL,
 182   ALWAYS
 183 };
 184
 185 /**
 186  * @brief Stencil operators
 187  */
 188 enum class StencilOp
 189 {
 190   KEEP,
 191   ZERO,
 192   REPLACE,
 193   INCREMENT_AND_CLAMP,
 194   DECREMENT_AND_CLAMP,
 195   INVERT,
 196   INCREMENT_AND_WRAP,
 197   DECREMENT_AND_WRAP
 198 };
 199
 200 /**
 201  * @brief Backface culling modes
 202  */
 203 enum class CullMode
 204 {
 205   NONE,
 206   FRONT,
 207   BACK,
 208   FRONT_AND_BACK
 209 };
 210
 211 /**
 212  * @brief Polygon drawing modes
 213  */
 214 enum class PolygonMode
 215 {
 216   FILL,
 217   LINE,
 218   POINT
 219 };
 220
 221 /**
 222  * @brief Front face direction
 223  */
 224 enum class FrontFace
 225 {
 226   COUNTER_CLOCKWISE,
 227   CLOCKWISE
 228 };
 229
 230 /**
 231  * @brief Primitive geometry topology
 232  */
 233 enum class PrimitiveTopology
 234 {
 235   POINT_LIST,
 236   LINE_LIST,
 237   LINE_LOOP,
 238   LINE_STRIP,
 239   TRIANGLE_LIST,
 240   TRIANGLE_STRIP,
 241   TRIANGLE_FAN
 242 };
 243
 244 /**
 245  * @brief Sampler address ( wrapping ) mode
 246  */
 247 enum class SamplerAddressMode
 248 {
 249   REPEAT,
 250   MIRRORED_REPEAT,
 251   CLAMP_TO_EDGE,
 252   CLAMP_TO_BORDER,
 253   MIRROR_CLAMP_TO_EDGE
 254 };
 255
 256 /**
 257  * @brief Filtering mode
 258  */
 259 enum class SamplerFilter
 260 {
 261   NEAREST,
 262   LINEAR
 263 };
 264
 265 /**
 266  * @brief Mipmap mode
 267  */
 268 enum class SamplerMipmapMode
 269 {
 270   NONE,
 271   NEAREST,
 272   LINEAR
 273 };
 274
 275 /**
 276  * @brief Describes pipeline's color blend state
 277  */
 278 struct ColorBlendState
 279 {
 280   bool        logicOpEnable           = false;
 281   LogicOp     logicOp                 = {};
 282   float       blendConstants[4]       = {0.0f, 0.0f, 0.0f, 0.0f};
 283   bool        blendEnable             = false;
 284   BlendFactor srcColorBlendFactor     = BlendFactor::ZERO;
 285   BlendFactor dstColorBlendFactor     = BlendFactor::ZERO;
 286   BlendOp     colorBlendOp            = {};
 287   BlendFactor srcAlphaBlendFactor     = BlendFactor::ZERO;
 288   BlendFactor dstAlphaBlendFactor     = BlendFactor::ZERO;
 289   BlendOp     alphaBlendOp            = {};
 290   uint32_t    colorComponentWriteBits = {0u};
 291
 292   auto& SetLogicOpEnable(bool value)
 293   {
 294     logicOpEnable = value;
 295     return *this;
 296   }
 297
 298   auto& SetLogicOp(LogicOp value)
 299   {
 300     logicOp = value;
 301     return *this;
 302   }
 303
 304   auto& SetBlendConstants(float value[4])
 305   {
 306     std::copy(value, value + 4, blendConstants);
 307     return *this;
 308   }
 309
 310   auto& SetBlendEnable(bool value)
 311   {
 312     blendEnable = value;
 313     return *this;
 314   }
 315
 316   auto& SetSrcColorBlendFactor(BlendFactor value)
 317   {
 318     srcColorBlendFactor = value;
 319     return *this;
 320   }
 321
 322   auto& SetDstColorBlendFactor(BlendFactor value)
 323   {
 324     dstColorBlendFactor = value;
 325     return *this;
 326   }
 327
 328   auto& SetColorBlendOp(BlendOp value)
 329   {
 330     colorBlendOp = value;
 331     return *this;
 332   }
 333
 334   auto& SetSrcAlphaBlendFactor(BlendFactor value)
 335   {
 336     srcAlphaBlendFactor = value;
 337     return *this;
 338   }
 339
 340   auto& SetDstAlphaBlendFactor(BlendFactor value)
 341   {
 342     dstAlphaBlendFactor = value;
 343     return *this;
 344   }
 345
 346   auto& SetAlphaBlendOp(BlendOp value)
 347   {
 348     alphaBlendOp = value;
 349     return *this;
 350   }
 351
 352   auto& SetColorComponentsWriteBits(uint32_t value)
 353   {
 354     colorComponentWriteBits = value;
 355     return *this;
 356   }
 357 };
 358
 359 /**
 360  * @brief Program State
 361  */
 362 struct ProgramState
 363 {
 364   const Program* program{nullptr};
 365
 366   auto& SetProgram(const Program& value)
 367   {
 368     program = &value;
 369     return *this;
 370   }
 371 };
 372
 373 /**
 374  * @brief  Framebuffer state.
 375  */
 376 struct FramebufferState
 377 {
 378   const Framebuffer* framebuffer{nullptr};
 379
 380   auto& SetFramebuffer(const Framebuffer& value)
 381   {
 382     framebuffer = &value;
 383     return *this;
 384   }
 385 };
 386
 387 /**
 388  * @brief Describes pipeline's viewport and scissor state
 389  */
 390 struct ViewportState
 391 {
 392   Viewport viewport{0.0, 0.0, 0.0, 0.0};
 393   Rect2D   scissor{0, 0, 0, 0};
 394   bool     scissorTestEnable{false};
 395
 396   auto& SetViewport(const Viewport& value)
 397   {
 398     viewport = value;
 399     return *this;
 400   }
 401
 402   auto& SetScissor(const Rect2D& value)
 403   {
 404     scissor = value;
 405     return *this;
 406   }
 407
 408   auto& SetScissorTestEnable(bool value)
 409   {
 410     scissorTestEnable = value;
 411     return *this;
 412   }
 413 };
 414
 415 /**
 416  * @brief Describes stencil operation state
 417  */
 418 struct StencilOpState
 419 {
 420   StencilOp failOp{};
 421   StencilOp passOp{};
 422   StencilOp depthFailOp{};
 423   CompareOp compareOp{};
 424   uint32_t  compareMask{0u};
 425   uint32_t  writeMask{0u};
 426   uint32_t  reference{0u};
 427
 428   auto& SetFailOp(StencilOp value)
 429   {
 430     failOp = value;
 431     return *this;
 432   }
 433
 434   auto& SetPassOp(StencilOp value)
 435   {
 436     failOp = value;
 437     return *this;
 438   }
 439
 440   auto& SetDepthFailOp(StencilOp value)
 441   {
 442     failOp = value;
 443     return *this;
 444   }
 445
 446   auto& SetCompareOp(CompareOp value)
 447   {
 448     compareOp = value;
 449     return *this;
 450   }
 451
 452   auto& SetCompareMask(uint32_t value)
 453   {
 454     compareMask = value;
 455     return *this;
 456   }
 457
 458   auto& SetWriteMask(uint32_t value)
 459   {
 460     writeMask = value;
 461     return *this;
 462   }
 463
 464   auto& SetReference(uint32_t value)
 465   {
 466     reference = value;
 467     return *this;
 468   }
 469 };
 470
 471 /**
 472  * @brief Describes pipeline's viewport and scissor state
 473  */
 474 struct DepthStencilState
 475 {
 476   bool      depthTestEnable{false};
 477   bool      depthWriteEnable{false};
 478   CompareOp depthCompareOp{};
 479
 480   bool           stencilTestEnable{false};
 481   StencilOpState front{};
 482   StencilOpState back{};
 483
 484   auto& SetDepthTestEnable(bool value)
 485   {
 486     depthTestEnable = value;
 487     return *this;
 488   }
 489
 490   auto& SetDepthWriteEnable(bool value)
 491   {
 492     depthWriteEnable = value;
 493     return *this;
 494   }
 495
 496   auto& SetDepthCompareOp(CompareOp value)
 497   {
 498     depthCompareOp = value;
 499     return *this;
 500   }
 501
 502   auto& SetFront(StencilOpState value)
 503   {
 504     front = value;
 505     return *this;
 506   }
 507
 508   auto& SetBack(StencilOpState value)
 509   {
 510     back = value;
 511     return *this;
 512   }
 513
 514   auto& SetStencilTestEnable(bool value)
 515   {
 516     stencilTestEnable = value;
 517     return *this;
 518   }
 519 };
 520
 521 /**
 522  * @brief Rasterization state descriptor
 523  */
 524 struct RasterizationState
 525 {
 526   CullMode    cullMode{};
 527   PolygonMode polygonMode{};
 528   FrontFace   frontFace{};
 529
 530   auto& SetCullMode(CullMode value)
 531   {
 532     cullMode = value;
 533     return *this;
 534   }
 535
 536   auto& SetPolygonMode(PolygonMode value)
 537   {
 538     polygonMode = value;
 539     return *this;
 540   }
 541
 542   auto& SetFrontFace(FrontFace value)
 543   {
 544     frontFace = value;
 545     return *this;
 546   }
 547 };
 548
 549 /**
 550  * @brief Input assembly state descriptor.
 551  *
 552  * Structure describes the topology for submitted
 553  * geometry.
 554  */
 555 struct InputAssemblyState
 556 {
 557   PrimitiveTopology topology{};
 558   bool              primitiveRestartEnable{true};
 559
 560   auto& SetTopology(PrimitiveTopology value)
 561   {
 562     topology = value;
 563     return *this;
 564   }
 565
 566   auto& SetPrimitiveRestartEnable(bool value)
 567   {
 568     primitiveRestartEnable = true;
 569     return *this;
 570   }
 571 };
 572
 573 /**
 574  * @brief Pipeline dynamic state bits
 575  */
 576 namespace PipelineDynamicStateBits
 577 {
 578 const uint32_t VIEWPORT_BIT             = 1 << 0;
 579 const uint32_t SCISSOR_BIT              = 1 << 1;
 580 const uint32_t LINE_WIDTH_BIT           = 1 << 2;
 581 const uint32_t DEPTH_BIAS_BIT           = 1 << 3;
 582 const uint32_t BLEND_CONSTANTS_BIT      = 1 << 4;
 583 const uint32_t DEPTH_BOUNDS_BIT         = 1 << 5;
 584 const uint32_t STENCIL_COMPARE_MASK_BIT = 1 << 6;
 585 const uint32_t STENCIL_WRITE_MASK_BIT   = 1 << 7;
 586 const uint32_t STENCIL_REFERENCE_BIT    = 1 << 8;
 587 } // namespace PipelineDynamicStateBits
 588
 589 const uint32_t PIPELINE_DYNAMIC_STATE_COUNT(9u);
 590
 591 using PipelineDynamicStateMask = uint32_t;
 592
 593 /**
 594  * @brief Structure describes vertex input state of the pipeline.
 595  * It specifies buffer binding and attribute format to be used.
 596  */
 597 struct VertexInputState
 598 {
 599   VertexInputState() = default;
 600
 601   /**
 602    * @brief Vertex buffer binding
 603    */
 604   struct Binding
 605   {
 606     Binding(uint32_t _stride, VertexInputRate _inputRate)
 607     : stride(_stride),
 608       inputRate(_inputRate)
 609     {
 610     }
 611     uint32_t        stride;
 612     VertexInputRate inputRate;
 613   };
 614
 615   /**
 616    * @brief Attribute description
 617    */
 618   struct Attribute
 619   {
 620     Attribute(uint32_t _location, uint32_t _binding, uint32_t _offset, VertexInputFormat _format)
 621     : location(_location),
 622       binding(_binding),
 623       offset(_offset),
 624       format(_format)
 625     {
 626     }
 627
 628     uint32_t          location;
 629     uint32_t          binding;
 630     uint32_t          offset;
 631     VertexInputFormat format;
 632   };
 633
 634   VertexInputState(std::vector<Binding> _bufferBindings, std::vector<Attribute> _attributes)
 635   : bufferBindings(std::move(_bufferBindings)),
 636     attributes(std::move(_attributes))
 637   {
 638   }
 639
 640   std::vector<Binding>   bufferBindings{};
 641   std::vector<Attribute> attributes{};
 642 };
 643
 644 /**
 645  * @brief List of all possible formats
 646  * Not all formats may be supported
 647  */
 648 enum class Format
 649 {
 650   UNDEFINED,
 651   // GLES compatible, luminance doesn't exist in Vulkan
 652   L8,
 653   L8A8,
 654
 655   // Vulkan compatible
 656   R4G4_UNORM_PACK8,
 657   R4G4B4A4_UNORM_PACK16,
 658   B4G4R4A4_UNORM_PACK16,
 659   R5G6B5_UNORM_PACK16,
 660   B5G6R5_UNORM_PACK16,
 661   R5G5B5A1_UNORM_PACK16,
 662   B5G5R5A1_UNORM_PACK16,
 663   A1R5G5B5_UNORM_PACK16,
 664   R8_UNORM,
 665   R8_SNORM,
 666   R8_USCALED,
 667   R8_SSCALED,
 668   R8_UINT,
 669   R8_SINT,
 670   R8_SRGB,
 671   R8G8_UNORM,
 672   R8G8_SNORM,
 673   R8G8_USCALED,
 674   R8G8_SSCALED,
 675   R8G8_UINT,
 676   R8G8_SINT,
 677   R8G8_SRGB,
 678   R8G8B8_UNORM,
 679   R8G8B8_SNORM,
 680   R8G8B8_USCALED,
 681   R8G8B8_SSCALED,
 682   R8G8B8_UINT,
 683   R8G8B8_SINT,
 684   R8G8B8_SRGB,
 685   B8G8R8_UNORM,
 686   B8G8R8_SNORM,
 687   B8G8R8_USCALED,
 688   B8G8R8_SSCALED,
 689   B8G8R8_UINT,
 690   B8G8R8_SINT,
 691   B8G8R8_SRGB,
 692   R8G8B8A8_UNORM,
 693   R8G8B8A8_SNORM,
 694   R8G8B8A8_USCALED,
 695   R8G8B8A8_SSCALED,
 696   R8G8B8A8_UINT,
 697   R8G8B8A8_SINT,
 698   R8G8B8A8_SRGB,
 699   B8G8R8A8_UNORM,
 700   B8G8R8A8_SNORM,
 701   B8G8R8A8_USCALED,
 702   B8G8R8A8_SSCALED,
 703   B8G8R8A8_UINT,
 704   B8G8R8A8_SINT,
 705   B8G8R8A8_SRGB,
 706   A8B8G8R8_UNORM_PACK32,
 707   A8B8G8R8_SNORM_PACK32,
 708   A8B8G8R8_USCALED_PACK32,
 709   A8B8G8R8_SSCALED_PACK32,
 710   A8B8G8R8_UINT_PACK32,
 711   A8B8G8R8_SINT_PACK32,
 712   A8B8G8R8_SRGB_PACK32,
 713   A2R10G10B10_UNORM_PACK32,
 714   A2R10G10B10_SNORM_PACK32,
 715   A2R10G10B10_USCALED_PACK32,
 716   A2R10G10B10_SSCALED_PACK32,
 717   A2R10G10B10_UINT_PACK32,
 718   A2R10G10B10_SINT_PACK32,
 719   A2B10G10R10_UNORM_PACK32,
 720   A2B10G10R10_SNORM_PACK32,
 721   A2B10G10R10_USCALED_PACK32,
 722   A2B10G10R10_SSCALED_PACK32,
 723   A2B10G10R10_UINT_PACK32,
 724   A2B10G10R10_SINT_PACK32,
 725   R16_UNORM,
 726   R16_SNORM,
 727   R16_USCALED,
 728   R16_SSCALED,
 729   R16_UINT,
 730   R16_SINT,
 731   R16_SFLOAT,
 732   R16G16_UNORM,
 733   R16G16_SNORM,
 734   R16G16_USCALED,
 735   R16G16_SSCALED,
 736   R16G16_UINT,
 737   R16G16_SINT,
 738   R16G16_SFLOAT,
 739   R16G16B16_UNORM,
 740   R16G16B16_SNORM,
 741   R16G16B16_USCALED,
 742   R16G16B16_SSCALED,
 743   R16G16B16_UINT,
 744   R16G16B16_SINT,
 745   R16G16B16_SFLOAT,
 746   R16G16B16A16_UNORM,
 747   R16G16B16A16_SNORM,
 748   R16G16B16A16_USCALED,
 749   R16G16B16A16_SSCALED,
 750   R16G16B16A16_UINT,
 751   R16G16B16A16_SINT,
 752   R16G16B16A16_SFLOAT,
 753   R32_UINT,
 754   R32_SINT,
 755   R32_SFLOAT,
 756   R32G32_UINT,
 757   R32G32_SINT,
 758   R32G32_SFLOAT,
 759   R32G32B32_UINT,
 760   R32G32B32_SINT,
 761   R32G32B32_SFLOAT,
 762   R32G32B32A32_UINT,
 763   R32G32B32A32_SINT,
 764   R32G32B32A32_SFLOAT,
 765   R64_UINT,
 766   R64_SINT,
 767   R64_SFLOAT,
 768   R64G64_UINT,
 769   R64G64_SINT,
 770   R64G64_SFLOAT,
 771   R64G64B64_UINT,
 772   R64G64B64_SINT,
 773   R64G64B64_SFLOAT,
 774   R64G64B64A64_UINT,
 775   R64G64B64A64_SINT,
 776   R64G64B64A64_SFLOAT,
 777   B10G11R11_UFLOAT_PACK32,
 778   E5B9G9R9_UFLOAT_PACK32,
 779   D16_UNORM,
 780   X8_D24_UNORM_PACK32,
 781   D32_SFLOAT,
 782   S8_UINT,
 783   D16_UNORM_S8_UINT,
 784   D24_UNORM_S8_UINT,
 785   D32_SFLOAT_S8_UINT,
 786   BC1_RGB_UNORM_BLOCK,
 787   BC1_RGB_SRGB_BLOCK,
 788   BC1_RGBA_UNORM_BLOCK,
 789   BC1_RGBA_SRGB_BLOCK,
 790   BC2_UNORM_BLOCK,
 791   BC2_SRGB_BLOCK,
 792   BC3_UNORM_BLOCK,
 793   BC3_SRGB_BLOCK,
 794   BC4_UNORM_BLOCK,
 795   BC4_SNORM_BLOCK,
 796   BC5_UNORM_BLOCK,
 797   BC5_SNORM_BLOCK,
 798   BC6H_UFLOAT_BLOCK,
 799   BC6H_SFLOAT_BLOCK,
 800   BC7_UNORM_BLOCK,
 801   BC7_SRGB_BLOCK,
 802   ETC2_R8G8B8_UNORM_BLOCK,
 803   ETC2_R8G8B8_SRGB_BLOCK,
 804   ETC2_R8G8B8A1_UNORM_BLOCK,
 805   ETC2_R8G8B8A1_SRGB_BLOCK,
 806   ETC2_R8G8B8A8_UNORM_BLOCK,
 807   ETC2_R8G8B8A8_SRGB_BLOCK,
 808   EAC_R11_UNORM_BLOCK,
 809   EAC_R11_SNORM_BLOCK,
 810   EAC_R11G11_UNORM_BLOCK,
 811   EAC_R11G11_SNORM_BLOCK,
 812   ASTC_4x4_UNORM_BLOCK,
 813   ASTC_4x4_SRGB_BLOCK,
 814   ASTC_5x4_UNORM_BLOCK,
 815   ASTC_5x4_SRGB_BLOCK,
 816   ASTC_5x5_UNORM_BLOCK,
 817   ASTC_5x5_SRGB_BLOCK,
 818   ASTC_6x5_UNORM_BLOCK,
 819   ASTC_6x5_SRGB_BLOCK,
 820   ASTC_6x6_UNORM_BLOCK,
 821   ASTC_6x6_SRGB_BLOCK,
 822   ASTC_8x5_UNORM_BLOCK,
 823   ASTC_8x5_SRGB_BLOCK,
 824   ASTC_8x6_UNORM_BLOCK,
 825   ASTC_8x6_SRGB_BLOCK,
 826   ASTC_8x8_UNORM_BLOCK,
 827   ASTC_8x8_SRGB_BLOCK,
 828   ASTC_10x5_UNORM_BLOCK,
 829   ASTC_10x5_SRGB_BLOCK,
 830   ASTC_10x6_UNORM_BLOCK,
 831   ASTC_10x6_SRGB_BLOCK,
 832   ASTC_10x8_UNORM_BLOCK,
 833   ASTC_10x8_SRGB_BLOCK,
 834   ASTC_10x10_UNORM_BLOCK,
 835   ASTC_10x10_SRGB_BLOCK,
 836   ASTC_12x10_UNORM_BLOCK,
 837   ASTC_12x10_SRGB_BLOCK,
 838   ASTC_12x12_UNORM_BLOCK,
 839   ASTC_12x12_SRGB_BLOCK,
 840   PVRTC1_2BPP_UNORM_BLOCK_IMG,
 841   PVRTC1_4BPP_UNORM_BLOCK_IMG,
 842   PVRTC2_2BPP_UNORM_BLOCK_IMG,
 843   PVRTC2_4BPP_UNORM_BLOCK_IMG,
 844   PVRTC1_2BPP_SRGB_BLOCK_IMG,
 845   PVRTC1_4BPP_SRGB_BLOCK_IMG,
 846   PVRTC2_2BPP_SRGB_BLOCK_IMG,
 847   PVRTC2_4BPP_SRGB_BLOCK_IMG,
 848 };
 849
 850 /**
 851  * @brief Flags specifying a buffer usage
 852  */
 853 enum class BufferUsage
 854 {
 855   TRANSFER_SRC         = 1 << 0,
 856   TRANSFER_DST         = 1 << 1,
 857   UNIFORM_TEXEL_BUFFER = 1 << 2,
 858   STORAGE_TEXEL_BUFFER = 1 << 3,
 859   UNIFORM_BUFFER       = 1 << 4,
 860   STORAGE_BUFFER       = 1 << 5,
 861   INDEX_BUFFER         = 1 << 6,
 862   VERTEX_BUFFER        = 1 << 7,
 863   INDIRECT_BUFFER      = 1 << 8,
 864 };
 865
 866 using BufferUsageFlags = uint32_t;
 867
 868 inline BufferUsageFlags operator|(BufferUsageFlags flags, BufferUsage usage)
 869 {
 870   flags |= static_cast<uint32_t>(usage);
 871   return flags;
 872 }
 873
 874 /**
 875  * @brief The structure describes memory requirements of GPU resource (texture, buffer)
 876  */
 877 struct MemoryRequirements
 878 {
 879   size_t size;
 880   size_t alignment;
 881 };
 882
 883 using TextureUpdateFlags = uint32_t;
 884 enum class TextureUpdateFlagBits
 885 {
 886   KEEP_SOURCE = 1 << 0,
 887 };
 888
 889 /**
 890  * @brief Texture update info
 891  *
 892  * Describes the texture update to be executed by
 893  * Controller::UpdateTextures()
 894  */
 895 struct TextureUpdateInfo
 896 {
 897   Texture* dstTexture{};
 898   Offset2D dstOffset2D;
 899   uint32_t layer{};
 900   uint32_t level{};
 901
 902   uint32_t srcReference{};
 903   Extent2D srcExtent2D{};
 904   uint32_t srcOffset{};
 905   uint32_t srcSize{};
 906 };
 907
 908 /**
 909  * @brief Texture update source info
 910  *
 911  * Describes the source of data (memory, buffer or another texture)
 912  * to be used when updating textures using Controller::UpdateTextures().
 913  */
 914 struct TextureUpdateSourceInfo
 915 {
 916   enum class Type
 917   {
 918     BUFFER,
 919     MEMORY,
 920     TEXTURE
 921   };
 922
 923   Type sourceType;
 924
 925   struct BufferSource
 926   {
 927     Buffer* buffer;
 928   } bufferSource;
 929
 930   struct MemorySource
 931   {
 932     void* memory;
 933   } memorySource;
 934
 935   struct TextureSource
 936   {
 937     Texture* texture;
 938   } textureSource;
 939 };
 940
 941 /**
 942  * @brief Properties of texture
 943  */
 944 struct TextureProperties
 945 {
 946   Format   format;                   ///< Texture format
 947   Format   format1;                  ///< Texture format (if emulated)
 948   bool     emulated;                 ///< Format is emulated (for example RGB as RGBA)
 949   bool     compressed;               ///< Texture is compressed
 950   bool     packed;                   ///< Texture is packed
 951   Extent2D extent2D;                 ///< Size of texture
 952   bool     directWriteAccessEnabled; ///< Direct write access (mappable textures)
 953 };
 954
 955 /**
 956  * @brief Texture tiling that directly refers to the tiling
 957  * mode supported by the Vulkan. Other implementations
 958  * of the backend may ignore the value.
 959  */
 960 enum class TextureTiling
 961 {
 962   OPTIMAL,
 963   LINEAR
 964 };
 965
 966 /**
 967  * @brief Texture color attachment used by FramebufferCreateInfo
 968  */
 969 struct ColorAttachment
 970 {
 971   uint32_t attachmentId;
 972   Texture* texture;
 973   uint32_t layerId;
 974   uint32_t levelId;
 975 };
 976
 977 /**
 978  * @brief Depth stencil attachment used by FramebufferCreateInfo
 979  */
 980 struct DepthStencilAttachment
 981 {
 982   // TODO:
 983 };
 984
 985 /**
 986  * @brief Submit flags
 987  */
 988 using SubmitFlags = uint32_t;
 989
 990 /**
 991  * Submit flag bits
 992  */
 993 enum class SubmitFlagBits : uint32_t
 994 {
 995   FLUSH         = 1 << 0, // Flush immediately
 996   DONT_OPTIMIZE = 1 << 1  // Tells controller not to optimize commands
 997 };
 998
 999 template<typename T>
1000 inline SubmitFlags operator|(T flags, SubmitFlagBits bit)
1001 {
1002   return static_cast<SubmitFlags>(flags) | static_cast<SubmitFlags>(bit);
1003 }
1004
1005 /**
1006  * @brief Describes command buffers submission
1007  */
1008 struct SubmitInfo
1009 {
1010   std::vector<CommandBuffer*> cmdBuffer;
1011   SubmitFlags                 flags;
1012 };
1013
1014 /**
1015  * @brief Shader language enum
1016  */
1017 enum class ShaderLanguage
1018 {
1019   GLSL_1,
1020   GLSL_3_1,
1021   GLSL_3_2,
1022   SPIRV_1_0,
1023   SPIRV_1_1,
1024 };
1025
1026 /**
1027  * @brief Pipeline stages
1028  */
1029 enum class PipelineStage
1030 {
1031   TOP_OF_PIPELINE,
1032   VERTEX_SHADER,
1033   GEOMETRY_SHADER,
1034   FRAGMENT_SHADER,
1035   COMPUTE_SHADER,
1036   TESSELATION_CONTROL,
1037   TESSELATION_EVALUATION,
1038   BOTTOM_OF_PIPELINE
1039 };
1040
1041 /**
1042  * @brief Vertex attribute format
1043  *
1044  * TODO: to be replaced with Format
1045  */
1046 enum class VertexInputAttributeFormat
1047 {
1048   UNDEFINED,
1049   FLOAT,
1050   INTEGER,
1051   VEC2,
1052   VEC3,
1053   VEC4
1054 };
1055
1056 /**
1057  * @brief Uniform class
1058  */
1059 enum class UniformClass
1060 {
1061   SAMPLER,
1062   IMAGE,
1063   COMBINED_IMAGE_SAMPLER,
1064   UNIFORM_BUFFER,
1065   UNIFORM,
1066   UNDEFINED
1067 };
1068
1069 /**
1070  * @brief Type of texture
1071  */
1072 enum class TextureType
1073 {
1074   TEXTURE_2D,
1075   TEXTURE_3D,
1076   TEXTURE_CUBEMAP,
1077 };
1078
1079 /**
1080  * @brief The information of the uniform
1081  */
1082 struct UniformInfo
1083 {
1084   std::string  name{""};
1085   UniformClass uniformClass{UniformClass::UNDEFINED};
1086   uint32_t     binding{0u};
1087   uint32_t     bufferIndex{0u};
1088   uint32_t     offset{0u};
1089   uint32_t     location{0u};
1090
1091   bool operator==(const UniformInfo& rhs)
1092   {
1093     return name == rhs.name &&
1094            uniformClass == rhs.uniformClass &&
1095            binding == rhs.binding &&
1096            bufferIndex == rhs.bufferIndex &&
1097            offset == rhs.offset &&
1098            location == rhs.location;
1099   }
1100 };
1101
1102 /**
1103  * @brief The information of the uniform block
1104  */
1105 struct UniformBlockInfo
1106 {
1107   std::string              name{""};
1108   uint32_t                 descriptorSet{0u};
1109   uint32_t                 binding{0u};
1110   uint32_t                 size{0u};
1111   std::vector<UniformInfo> members{};
1112 };
1113
1114 /**
1115  * @brief Describes pipeline's shading stages
1116  *
1117  * Shader state binds shader and pipeline stage that the
1118  * shader will be executed. The shader may be created with
1119  * pipeline stage and the pipelineStage member may be ignored
1120  * by setting inheritPipelineStage to true.
1121  */
1122 struct ShaderState
1123 {
1124   const Shader* shader{nullptr};             // shader to attach
1125   PipelineStage pipelineStage{};             // pipeline stage to execute the shader
1126   bool          inheritPipelineStage{false}; // stage inheritance
1127
1128   auto& SetShader(const Shader& value)
1129   {
1130     shader = &value;
1131     return *this;
1132   }
1133
1134   auto& SetPipelineStage(PipelineStage value)
1135   {
1136     pipelineStage = value;
1137     return *this;
1138   }
1139
1140   auto& SetInheritPipelineStage(bool value)
1141   {
1142     inheritPipelineStage = value;
1143     return *this;
1144   }
1145 };
1146
1147 /**
1148  * @brief Flag determining usage of texture
1149  */
1150 using TextureUsageFlags = uint32_t;
1151 enum class TextureUsageFlagBits : uint32_t
1152 {
1153   SAMPLE                   = 1 << 0,
1154   COLOR_ATTACHMENT         = 1 << 1,
1155   DEPTH_STENCIL_ATTACHMENT = 1 << 2,
1156   DONT_CARE                = 1 << 4,
1157 };
1158
1159 template<typename T>
1160 inline TextureUsageFlags operator|(T flags, TextureUsageFlagBits bit)
1161 {
1162   return static_cast<TextureUsageFlags>(flags) | static_cast<TextureUsageFlags>(bit);
1163 }
1164
1165 using TextureFormat = Dali::Graphics::Format;
1166
1167 /**
1168  * @brief Texture mipmap disable/enable enum
1169  */
1170 enum class TextureMipMapFlag
1171 {
1172   ENABLED,
1173   DISABLED,
1174 };
1175
1176 /**
1177  * @brief Depth/stencil attachment flag
1178  */
1179 enum class TextureDepthStencilFlag
1180 {
1181   NONE,
1182   DEPTH,
1183   STENCIL,
1184   DEPTH_STENCIL,
1185 };
1186
1187 /**
1188  * @brief Layout of texture
1189  *
1190  * Specifies how the memory will be allocated, organized and accessed.
1191  */
1192 enum class TextureLayout
1193 {
1194   LINEAR, ///< Creates linear memory, mapping possible
1195   OPTIMAL ///< Usually, read-only memory, driver-optimal layout
1196 };
1197
1198 /**
1199  * @brief Level of command buffer
1200  */
1201 enum class CommandBufferLevel
1202 {
1203   PRIMARY,  ///< Primary buffer can be executed on its own
1204   SECONDARY ///< Secondary buffer must be executed within scope of Primary buffer
1205 };
1206
1207 /**
1208  * @brief Enum indicating whether shader source
1209  * is text-based or binary.
1210  */
1211 enum class ShaderSourceMode
1212 {
1213   TEXT,
1214   BINARY
1215 };
1216
1217 /**
1218  * @brief Memory usage flags to be set when mapping the buffer
1219  */
1220 using MemoryUsageFlags = uint32_t;
1221 enum class MemoryUsageFlagBits : uint32_t
1222 {
1223   WRITE        = 1 << 0,
1224   READ         = 1 << 1,
1225   PERSISTENT   = 1 << 2,
1226   ASYNCHRONOUS = 1 << 3,
1227   DONT_CARE    = 1 << 4,
1228 };
1229
1230 template<typename T>
1231 inline MemoryUsageFlags operator|(T flags, MemoryUsageFlagBits bit)
1232 {
1233   return static_cast<MemoryUsageFlags>(flags) | static_cast<MemoryUsageFlags>(bit);
1234 }
1235
1236 /**
1237  * @brief Describes buffer mapping details
1238  */
1239 struct MapBufferInfo
1240 {
1241   Buffer*          buffer;
1242   MemoryUsageFlags usage;
1243   uint32_t         offset;
1244   uint32_t         size;
1245 };
1246
1247 /**
1248  * @brief Describes buffer mapping details
1249  * TODO: mapping by texture level and layer
1250  */
1251 struct MapTextureInfo
1252 {
1253   Texture*         texture;
1254   MemoryUsageFlags usage;
1255   uint32_t         offset;
1256   uint32_t         size;
1257 };
1258
1259 /**
1260  * @brief GraphicsStructureType enum is used by all create info structures
1261  * in order to identify by the implementation which structure it is
1262  * dealing with.
1263  */
1264 enum class GraphicsStructureType : uint32_t
1265 {
1266   BUFFER_CREATE_INFO_STRUCT,
1267   COMMAND_BUFFER_CREATE_INFO_STRUCT,
1268   FRAMEBUFFER_CREATE_INFO_STRUCT,
1269   PROGRAM_CREATE_INFO_STRUCT,
1270   PIPELINE_CREATE_INFO_STRUCT,
1271   RENDERPASS_CREATE_INFO_STRUCT,
1272   SAMPLER_CREATE_INFO_STRUCT,
1273   SHADER_CREATE_INFO_STRUCT,
1274   TEXTURE_CREATE_INFO_STRUCT,
1275   RENDER_TARGET_CREATE_INFO_STRUCT
1276 };
1277
1278 /**
1279  * @brief Helper function to be used by the extension developers
1280  *
1281  * The value of custom type must be unique and recognizable by the
1282  * implementation.
1283  *
1284  * @param customValue Custom value of GraphicsStructureType
1285  * @return Integer converted to GraphicsStructureType
1286  */
1287 inline GraphicsStructureType GraphicsExtensionType(uint32_t customValue)
1288 {
1289   return static_cast<GraphicsStructureType>(customValue);
1290 }
1291
1292 /**
1293  * @brief The allocation callbacks may be passed when the object is created.
1294  */
1295 struct AllocationCallbacks
1296 {
1297   void* userData                                                                          = nullptr; ///< User data passed to the allocator
1298   void* (*allocCallback)(size_t size, size_t alignment, void* userData)                   = nullptr;
1299   void* (*reallocCallback)(void* original, size_t size, size_t alignment, void* userData) = nullptr;
1300   void (*freeCallback)(void* memory, void* userData)                                      = nullptr;
1301 };
1302
1303 /**
1304  * @brief The ExtensionCreateInfo structure should be a base of any
1305  * extension create info structure. The structure isn't virtual
1306  * so the implementation must prevent slicing it.
1307  */
1308 struct ExtensionCreateInfo
1309 {
1310   GraphicsStructureType type{};
1311   ExtensionCreateInfo*  nextExtension{};
1312 };
1313
1314 /**
1315  * @brief Default deleter for graphics unique pointers
1316  *
1317  * Returned unique_ptr may require custom deleter. To get it working
1318  * with std::unique_ptr the custom type is used with polymorphic deleter
1319  */
1320 template<class T>
1321 struct DefaultDeleter
1322 {
1323   DefaultDeleter() = default;
1324
1325   /**
1326    * @brief Conversion constructor
1327    *
1328    * This constructor will set the lambda for type passed
1329    * as an argument.
1330    */
1331   template<class P, template<typename> typename U>
1332   DefaultDeleter(const U<P>& deleter)
1333   {
1334     deleteFunction = [](T* object) { U<P>()(static_cast<P*>(object)); };
1335   }
1336
1337   /**
1338    * @brief Conversion constructor from DefaultDelete<P>
1339    *
1340    * This constructor transfers deleteFunction only
1341    */
1342   template<class P>
1343   explicit DefaultDeleter(const DefaultDeleter<P>& deleter)
1344   {
1345     deleteFunction = decltype(deleteFunction)(deleter.deleteFunction);
1346   }
1347
1348   /**
1349    * @brief Default deleter
1350    *
1351    * Default deleter will use standard 'delete' call in order
1352    * to discard graphics objects unless a custom deleter was
1353    * used.
1354    *
1355    * @param[in] object Object to delete
1356    */
1357   void operator()(T* object)
1358   {
1359     if(deleteFunction)
1360     {
1361       deleteFunction(object);
1362     }
1363     else
1364     {
1365       delete object;
1366     }
1367   }
1368
1369   void (*deleteFunction)(T* object){nullptr}; ///< Custom delete function
1370 };
1371
1372 /**
1373  * unique_ptr defined in the Graphics scope
1374  */
1375 template<class T, class D = DefaultDeleter<T>>
1376 using UniquePtr = std::unique_ptr<T, D>;
1377
1378 /**
1379  * @brief MakeUnique<> version that returns Graphics::UniquePtr
1380  * @param[in] args Arguments for construction
1381  * @return
1382  */
1383 template<class T, class Deleter = DefaultDeleter<T>, class... Args>
1384 std::enable_if_t<!std::is_array<T>::value, Graphics::UniquePtr<T>>
1385 MakeUnique(Args&&... args)
1386 {
1387   return UniquePtr<T>(new T(std::forward<Args>(args)...), Deleter());
1388 }
1389
1390 } // namespace Graphics
1391 } // namespace Dali
1392
1393 #endif //DALI_GRAPHICS_API_TYPES_H