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 Buffer property bits
 876  *
 877  * Use these bits to set BufferPropertiesFlags.
 878  */
 879 enum class BufferPropertiesFlagBit : uint32_t
 880 {
 881   CPU_ALLOCATED    = 1 << 0, ///< Buffer is allocated on the CPU side
 882   TRANSIENT_MEMORY = 1 << 1, ///< Buffer memory will be short-lived
 883 };
 884
 885 /**
 886  * @brief BufferPropetiesFlags alters behaviour of implementation
 887  */
 888 using BufferPropertiesFlags = uint32_t;
 889
 890 inline BufferPropertiesFlags operator|(BufferPropertiesFlags flags, BufferPropertiesFlagBit usage)
 891 {
 892   flags |= static_cast<uint32_t>(usage);
 893   return flags;
 894 }
 895
 896 /**
 897  * @brief The structure describes memory requirements of GPU resource (texture, buffer)
 898  */
 899 struct MemoryRequirements
 900 {
 901   size_t size;
 902   size_t alignment;
 903 };
 904
 905 using TextureUpdateFlags = uint32_t;
 906 enum class TextureUpdateFlagBits
 907 {
 908   KEEP_SOURCE = 1 << 0,
 909 };
 910
 911 /**
 912  * @brief Texture update info
 913  *
 914  * Describes the texture update to be executed by
 915  * Controller::UpdateTextures()
 916  */
 917 struct TextureUpdateInfo
 918 {
 919   Texture* dstTexture{};
 920   Offset2D dstOffset2D;
 921   uint32_t layer{};
 922   uint32_t level{};
 923
 924   uint32_t srcReference{};
 925   Extent2D srcExtent2D{};
 926   uint32_t srcOffset{};
 927   uint32_t srcSize{};
 928 };
 929
 930 /**
 931  * @brief Texture update source info
 932  *
 933  * Describes the source of data (memory, buffer or another texture)
 934  * to be used when updating textures using Controller::UpdateTextures().
 935  */
 936 struct TextureUpdateSourceInfo
 937 {
 938   enum class Type
 939   {
 940     BUFFER,
 941     MEMORY,
 942     TEXTURE
 943   };
 944
 945   Type sourceType;
 946
 947   struct BufferSource
 948   {
 949     Buffer* buffer;
 950   } bufferSource;
 951
 952   struct MemorySource
 953   {
 954     void* memory;
 955   } memorySource;
 956
 957   struct TextureSource
 958   {
 959     Texture* texture;
 960   } textureSource;
 961 };
 962
 963 /**
 964  * @brief Properties of texture
 965  */
 966 struct TextureProperties
 967 {
 968   Format   format;                   ///< Texture format
 969   Format   format1;                  ///< Texture format (if emulated)
 970   bool     emulated;                 ///< Format is emulated (for example RGB as RGBA)
 971   bool     compressed;               ///< Texture is compressed
 972   bool     packed;                   ///< Texture is packed
 973   Extent2D extent2D;                 ///< Size of texture
 974   bool     directWriteAccessEnabled; ///< Direct write access (mappable textures)
 975 };
 976
 977 /**
 978  * @brief Texture tiling that directly refers to the tiling
 979  * mode supported by the Vulkan. Other implementations
 980  * of the backend may ignore the value.
 981  */
 982 enum class TextureTiling
 983 {
 984   OPTIMAL,
 985   LINEAR
 986 };
 987
 988 /**
 989  * @brief Texture color attachment used by FramebufferCreateInfo
 990  */
 991 struct ColorAttachment
 992 {
 993   uint32_t attachmentId;
 994   Texture* texture;
 995   uint32_t layerId;
 996   uint32_t levelId;
 997 };
 998
 999 /**
1000  * @brief Depth stencil attachment used by FramebufferCreateInfo
1001  */
1002 struct DepthStencilAttachment
1003 {
1004   // TODO:
1005   Texture* depthTexture;
1006   Texture* stencilTexture;
1007   uint32_t depthLevel;
1008   uint32_t stencilLevel;
1009 };
1010
1011 /**
1012  * @brief Submit flags
1013  */
1014 using SubmitFlags = uint32_t;
1015
1016 /**
1017  * Submit flag bits
1018  */
1019 enum class SubmitFlagBits : uint32_t
1020 {
1021   FLUSH         = 1 << 0, // Flush immediately
1022   DONT_OPTIMIZE = 1 << 1  // Tells controller not to optimize commands
1023 };
1024
1025 template<typename T>
1026 inline SubmitFlags operator|(T flags, SubmitFlagBits bit)
1027 {
1028   return static_cast<SubmitFlags>(flags) | static_cast<SubmitFlags>(bit);
1029 }
1030
1031 /**
1032  * @brief Describes command buffers submission
1033  */
1034 struct SubmitInfo
1035 {
1036   std::vector<CommandBuffer*> cmdBuffer;
1037   SubmitFlags                 flags;
1038 };
1039
1040 /**
1041  * @brief Shader language enum
1042  */
1043 enum class ShaderLanguage
1044 {
1045   GLSL_1,
1046   GLSL_3_1,
1047   GLSL_3_2,
1048   SPIRV_1_0,
1049   SPIRV_1_1,
1050 };
1051
1052 /**
1053  * @brief Pipeline stages
1054  */
1055 enum class PipelineStage
1056 {
1057   TOP_OF_PIPELINE,
1058   VERTEX_SHADER,
1059   GEOMETRY_SHADER,
1060   FRAGMENT_SHADER,
1061   COMPUTE_SHADER,
1062   TESSELATION_CONTROL,
1063   TESSELATION_EVALUATION,
1064   BOTTOM_OF_PIPELINE
1065 };
1066
1067 /**
1068  * @brief Vertex attribute format
1069  *
1070  * TODO: to be replaced with Format
1071  */
1072 enum class VertexInputAttributeFormat
1073 {
1074   UNDEFINED,
1075   FLOAT,
1076   INTEGER,
1077   VEC2,
1078   VEC3,
1079   VEC4
1080 };
1081
1082 /**
1083  * @brief Uniform class
1084  */
1085 enum class UniformClass
1086 {
1087   SAMPLER,
1088   IMAGE,
1089   COMBINED_IMAGE_SAMPLER,
1090   UNIFORM_BUFFER,
1091   UNIFORM,
1092   UNDEFINED
1093 };
1094
1095 /**
1096  * @brief Type of texture
1097  */
1098 enum class TextureType
1099 {
1100   TEXTURE_2D,
1101   TEXTURE_3D,
1102   TEXTURE_CUBEMAP,
1103 };
1104
1105 /**
1106  * @brief The information of the uniform
1107  */
1108 struct UniformInfo
1109 {
1110   std::string  name{""};
1111   UniformClass uniformClass{UniformClass::UNDEFINED};
1112   uint32_t     binding{0u};
1113   uint32_t     bufferIndex{0u};
1114   uint32_t     offset{0u};
1115   uint32_t     location{0u};
1116
1117   bool operator==(const UniformInfo& rhs)
1118   {
1119     return name == rhs.name &&
1120            uniformClass == rhs.uniformClass &&
1121            binding == rhs.binding &&
1122            bufferIndex == rhs.bufferIndex &&
1123            offset == rhs.offset &&
1124            location == rhs.location;
1125   }
1126 };
1127
1128 /**
1129  * @brief The information of the uniform block
1130  */
1131 struct UniformBlockInfo
1132 {
1133   std::string              name{""};
1134   uint32_t                 descriptorSet{0u};
1135   uint32_t                 binding{0u};
1136   uint32_t                 size{0u};
1137   std::vector<UniformInfo> members{};
1138 };
1139
1140 /**
1141  * @brief Describes pipeline's shading stages
1142  *
1143  * Shader state binds shader and pipeline stage that the
1144  * shader will be executed. The shader may be created with
1145  * pipeline stage and the pipelineStage member may be ignored
1146  * by setting inheritPipelineStage to true.
1147  */
1148 struct ShaderState
1149 {
1150   const Shader* shader{nullptr};             // shader to attach
1151   PipelineStage pipelineStage{};             // pipeline stage to execute the shader
1152   bool          inheritPipelineStage{false}; // stage inheritance
1153
1154   auto& SetShader(const Shader& value)
1155   {
1156     shader = &value;
1157     return *this;
1158   }
1159
1160   auto& SetPipelineStage(PipelineStage value)
1161   {
1162     pipelineStage = value;
1163     return *this;
1164   }
1165
1166   auto& SetInheritPipelineStage(bool value)
1167   {
1168     inheritPipelineStage = value;
1169     return *this;
1170   }
1171 };
1172
1173 /**
1174  * @brief Flag determining usage of texture
1175  */
1176 using TextureUsageFlags = uint32_t;
1177 enum class TextureUsageFlagBits : uint32_t
1178 {
1179   SAMPLE                   = 1 << 0,
1180   COLOR_ATTACHMENT         = 1 << 1,
1181   DEPTH_STENCIL_ATTACHMENT = 1 << 2,
1182   DONT_CARE                = 1 << 4,
1183 };
1184
1185 template<typename T>
1186 inline TextureUsageFlags operator|(T flags, TextureUsageFlagBits bit)
1187 {
1188   return static_cast<TextureUsageFlags>(flags) | static_cast<TextureUsageFlags>(bit);
1189 }
1190
1191 using TextureFormat = Dali::Graphics::Format;
1192
1193 /**
1194  * @brief Texture mipmap disable/enable enum
1195  */
1196 enum class TextureMipMapFlag
1197 {
1198   ENABLED,
1199   DISABLED,
1200 };
1201
1202 /**
1203  * @brief Depth/stencil attachment flag
1204  */
1205 enum class TextureDepthStencilFlag
1206 {
1207   NONE,
1208   DEPTH,
1209   STENCIL,
1210   DEPTH_STENCIL,
1211 };
1212
1213 /**
1214  * @brief Layout of texture
1215  *
1216  * Specifies how the memory will be allocated, organized and accessed.
1217  */
1218 enum class TextureLayout
1219 {
1220   LINEAR, ///< Creates linear memory, mapping possible
1221   OPTIMAL ///< Usually, read-only memory, driver-optimal layout
1222 };
1223
1224 /**
1225  * @brief Level of command buffer
1226  */
1227 enum class CommandBufferLevel
1228 {
1229   PRIMARY,  ///< Primary buffer can be executed on its own
1230   SECONDARY ///< Secondary buffer must be executed within scope of Primary buffer
1231 };
1232
1233 /**
1234  * @brief Enum indicating whether shader source
1235  * is text-based or binary.
1236  */
1237 enum class ShaderSourceMode
1238 {
1239   TEXT,
1240   BINARY
1241 };
1242
1243 /**
1244  * @brief Memory usage flags to be set when mapping the buffer
1245  */
1246 using MemoryUsageFlags = uint32_t;
1247 enum class MemoryUsageFlagBits : uint32_t
1248 {
1249   WRITE        = 1 << 0,
1250   READ         = 1 << 1,
1251   PERSISTENT   = 1 << 2,
1252   ASYNCHRONOUS = 1 << 3,
1253   DONT_CARE    = 1 << 4,
1254 };
1255
1256 template<typename T>
1257 inline MemoryUsageFlags operator|(T flags, MemoryUsageFlagBits bit)
1258 {
1259   return static_cast<MemoryUsageFlags>(flags) | static_cast<MemoryUsageFlags>(bit);
1260 }
1261
1262 /**
1263  * @brief Describes buffer mapping details
1264  */
1265 struct MapBufferInfo
1266 {
1267   Buffer*          buffer;
1268   MemoryUsageFlags usage;
1269   uint32_t         offset;
1270   uint32_t         size;
1271 };
1272
1273 /**
1274  * @brief Describes buffer mapping details
1275  * TODO: mapping by texture level and layer
1276  */
1277 struct MapTextureInfo
1278 {
1279   Texture*         texture;
1280   MemoryUsageFlags usage;
1281   uint32_t         offset;
1282   uint32_t         size;
1283 };
1284
1285 /**
1286  * @brief GraphicsStructureType enum is used by all create info structures
1287  * in order to identify by the implementation which structure it is
1288  * dealing with.
1289  */
1290 enum class GraphicsStructureType : uint32_t
1291 {
1292   BUFFER_CREATE_INFO_STRUCT,
1293   COMMAND_BUFFER_CREATE_INFO_STRUCT,
1294   FRAMEBUFFER_CREATE_INFO_STRUCT,
1295   PROGRAM_CREATE_INFO_STRUCT,
1296   PIPELINE_CREATE_INFO_STRUCT,
1297   RENDERPASS_CREATE_INFO_STRUCT,
1298   SAMPLER_CREATE_INFO_STRUCT,
1299   SHADER_CREATE_INFO_STRUCT,
1300   TEXTURE_CREATE_INFO_STRUCT,
1301   RENDER_TARGET_CREATE_INFO_STRUCT
1302 };
1303
1304 /**
1305  * @brief Enum describes load operation associated
1306  * with particular framebuffer attachment
1307  */
1308 enum class AttachmentLoadOp
1309 {
1310   LOAD, ///< Load previous content
1311   CLEAR, ///< Clear the attachment
1312   DONT_CARE ///< Let driver decide
1313 };
1314
1315 /**
1316  * @brief Enum describes store operation associated
1317  * with particular framebuffer attachment
1318  */
1319 enum class AttachmentStoreOp
1320 {
1321   STORE, ///< Store content (color attachemnts)
1322   DONT_CARE ///< Let driver decide (depth/stencil attachemnt with no intention of reading)
1323 };
1324
1325 /**
1326  * @brief The structure describes the read/write
1327  * modes of a single framebuffer attachment
1328  *
1329  * The attachment description specifies what is going to
1330  * happen to the attachment at the beginning and end of the
1331  * render pass.
1332  *
1333  * The stencil operation is separated as it may be set
1334  * independent from the depth component (use loadOp, storeOp
1335  * to set up the depth component and stencilLoadOp, stencilStoreOp
1336  * for stencil component).
1337  */
1338 struct AttachmentDescription
1339 {
1340   /**
1341    * @brief Sets load operation for the attachment
1342    *
1343    * @param value Load operation
1344    * @return this structure
1345    */
1346   auto& SetLoadOp( AttachmentLoadOp value )
1347   {
1348     loadOp = value;
1349     return *this;
1350   }
1351
1352   /**
1353    * @brief Sets store operation for the attachment
1354    *
1355    * @param value Store operation
1356    * @return this structure
1357    */
1358   auto& SetStoreOp( AttachmentStoreOp value )
1359   {
1360     storeOp = value;
1361     return *this;
1362   }
1363
1364   /**
1365    * @brief Sets load operation for the stencil part of attachment
1366    *
1367    * @param value load operation
1368    * @return this structure
1369    */
1370   auto& SetStencilLoadOp( AttachmentLoadOp value )
1371   {
1372     stencilLoadOp = value;
1373     return *this;
1374   }
1375
1376   /**
1377    * @brief Sets store operation for the stencil part of attachment
1378    *
1379    * @param value store operation
1380    * @return this structure
1381    */
1382   auto& SetStencilStoreOp( AttachmentStoreOp value )
1383   {
1384     stencilStoreOp = value;
1385     return *this;
1386   }
1387
1388   AttachmentLoadOp loadOp{};
1389   AttachmentStoreOp storeOp{};
1390   AttachmentLoadOp stencilLoadOp{};
1391   AttachmentStoreOp stencilStoreOp{};
1392 };
1393
1394 /**
1395  * @brief Helper function to be used by the extension developers
1396  *
1397  * The value of custom type must be unique and recognizable by the
1398  * implementation.
1399  *
1400  * @param customValue Custom value of GraphicsStructureType
1401  * @return Integer converted to GraphicsStructureType
1402  */
1403 inline GraphicsStructureType GraphicsExtensionType(uint32_t customValue)
1404 {
1405   return static_cast<GraphicsStructureType>(customValue);
1406 }
1407
1408 /**
1409  * @brief The allocation callbacks may be passed when the object is created.
1410  */
1411 struct AllocationCallbacks
1412 {
1413   void* userData                                                                          = nullptr; ///< User data passed to the allocator
1414   void* (*allocCallback)(size_t size, size_t alignment, void* userData)                   = nullptr;
1415   void* (*reallocCallback)(void* original, size_t size, size_t alignment, void* userData) = nullptr;
1416   void (*freeCallback)(void* memory, void* userData)                                      = nullptr;
1417 };
1418
1419 /**
1420  * @brief The ExtensionCreateInfo structure should be a base of any
1421  * extension create info structure. The structure isn't virtual
1422  * so the implementation must prevent slicing it.
1423  */
1424 struct ExtensionCreateInfo
1425 {
1426   GraphicsStructureType type{};
1427   ExtensionCreateInfo*  nextExtension{};
1428 };
1429
1430 /**
1431  * @brief Default deleter for graphics unique pointers
1432  *
1433  * Returned unique_ptr may require custom deleter. To get it working
1434  * with std::unique_ptr the custom type is used with polymorphic deleter
1435  */
1436 template<class T>
1437 struct DefaultDeleter
1438 {
1439   DefaultDeleter() = default;
1440
1441   /**
1442    * @brief Conversion constructor
1443    *
1444    * This constructor will set the lambda for type passed
1445    * as an argument.
1446    */
1447   template<class P, template<typename> typename U>
1448   DefaultDeleter(const U<P>& deleter)
1449   {
1450     deleteFunction = [](T* object) { U<P>()(static_cast<P*>(object)); };
1451   }
1452
1453   /**
1454    * @brief Conversion constructor from DefaultDelete<P>
1455    *
1456    * This constructor transfers deleteFunction only
1457    */
1458   template<class P>
1459   explicit DefaultDeleter(const DefaultDeleter<P>& deleter)
1460   {
1461     deleteFunction = decltype(deleteFunction)(deleter.deleteFunction);
1462   }
1463
1464   /**
1465    * @brief Default deleter
1466    *
1467    * Default deleter will use standard 'delete' call in order
1468    * to discard graphics objects unless a custom deleter was
1469    * used.
1470    *
1471    * @param[in] object Object to delete
1472    */
1473   void operator()(T* object)
1474   {
1475     if(deleteFunction)
1476     {
1477       deleteFunction(object);
1478     }
1479     else
1480     {
1481       delete object;
1482     }
1483   }
1484
1485   void (*deleteFunction)(T* object){nullptr}; ///< Custom delete function
1486 };
1487
1488 /**
1489  * Surface type is just a void* to any native object.
1490  */
1491 using Surface = void;
1492
1493 /**
1494  * @brief Enum describing preTransform of render target
1495  */
1496 enum class RenderTargetTransformFlagBits
1497 {
1498   TRANSFORM_IDENTITY_BIT = 0x00000001,
1499   ROTATE_90_BIT = 0x00000002,
1500   ROTATE_180_BIT = 0x00000004,
1501   ROTATE_270_BIT = 0x00000008,
1502   HORIZONTAL_MIRROR_BIT = 0x00000010,
1503   HORIZONTAL_MIRROR_ROTATE_90_BIT = 0x00000020,
1504   HORIZONTAL_MIRROR_ROTATE_180_BIT = 0x00000040,
1505   HORIZONTAL_MIRROR_ROTATE_270_BIT = 0x00000080,
1506 };
1507
1508 using RenderTargetTransformFlags = uint32_t;
1509
1510 template<typename T>
1511 inline RenderTargetTransformFlags operator|(T flags, RenderTargetTransformFlagBits bit)
1512 {
1513   return static_cast<RenderTargetTransformFlags>(flags) | static_cast<RenderTargetTransformFlags>(bit);
1514 }
1515
1516 /**
1517  * unique_ptr defined in the Graphics scope
1518  */
1519 template<class T, class D = DefaultDeleter<T>>
1520 using UniquePtr = std::unique_ptr<T, D>;
1521
1522 /**
1523  * @brief MakeUnique<> version that returns Graphics::UniquePtr
1524  * @param[in] args Arguments for construction
1525  * @return
1526  */
1527 template<class T, class Deleter = DefaultDeleter<T>, class... Args>
1528 std::enable_if_t<!std::is_array<T>::value, Graphics::UniquePtr<T>>
1529 MakeUnique(Args&&... args)
1530 {
1531   return UniquePtr<T>(new T(std::forward<Args>(args)...), Deleter());
1532 }
1533
1534 } // namespace Graphics
1535 } // namespace Dali
1536
1537 #endif //DALI_GRAPHICS_API_TYPES_H