dali/graphics-api/graphics-framebuffer-create-info.h

   1 #ifndef DALI_GRAPHICS_FRAMEBUFFER_CREATE_INFO_H
   2 #define DALI_GRAPHICS_FRAMEBUFFER_CREATE_INFO_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 // EXTERNAL INCLUDES
  22 #include <memory>
  23
  24 // INTERNAL INCLUDES
  25 #include "graphics-framebuffer.h"
  26 #include "graphics-types.h"
  27
  28 namespace Dali
  29 {
  30 namespace Graphics
  31 {
  32 /**
  33  * @brief Interface class for FramebufferCreateInfo types in the graphics API.
  34  */
  35 struct FramebufferCreateInfo
  36 {
  37   /**
  38    * @brief Sets pointer to the extension
  39    *
  40    * The pointer to the extension must be set either to nullptr
  41    * or to the valid structure. The structures may create
  42    * a chain. The last structure in a chain must point at
  43    * nullptr.
  44    *
  45    * @param[in] value pointer to the valid extension structure
  46    * @return reference to this structure
  47    */
  48   auto& SetNextExtension(ExtensionCreateInfo* value)
  49   {
  50     nextExtension = value;
  51     return *this;
  52   }
  53
  54   /**
  55    * @brief Adds color attachments to the framebuffer
  56    *
  57    * The color attachments are provided as a list. The number
  58    * of color attachments depends on the driver capability. It may be
  59    * a single attachment allowed for old hardware and multiple attachments
  60    * for the modern one (MRT).
  61    *
  62    * @param[in] value List of attachment descriptors
  63    * @return reference to this structure
  64    */
  65   auto& SetColorAttachments(std::vector<ColorAttachment> value)
  66   {
  67     colorAttachments = value;
  68     return *this;
  69   }
  70
  71   /**
  72    * @brief Adds depth/stencil attachment to the framebuffer
  73    *
  74    * The depth/stencil attachment may be supported only by certain (modern)
  75    * hardware. The hardware capabilities should be checked before using
  76    * the depth/stencil attachment.
  77    *
  78    * @param[in] value Depth/stencil attachment descriptor
  79    * @return reference to this structure
  80    */
  81   auto& SetDepthStencilAttachment(DepthStencilAttachment value)
  82   {
  83     depthStencilAttachment = value;
  84     return *this;
  85   }
  86
  87   /**
  88    * @brief Sets size of framebuffer
  89    *
  90    * @param[in] value size of framebuffer
  91    * @return reference to this structure
  92    */
  93   auto& SetSize(Extent2D value)
  94   {
  95     size = value;
  96     return *this;
  97   }
  98
  99   /**
 100    * @brief Sets multisampling level of framebuffer
 101    *
 102    * @param[in] value multisampling level of framebuffer
 103    * @return reference to this structure
 104    */
 105   auto& SetMultiSamplingLevel(uint8_t value)
 106   {
 107     multiSamplingLevel = value;
 108     return *this;
 109   }
 110
 111   /**
 112    * @brief Sets allocation callbacks which will be used when object is created
 113    * and destroyed.
 114    *
 115    * @param[in] value Valid reference to AllocationCallbacksStructure
 116    * @return reference to this structure
 117    */
 118   auto& SetAllocationCallbacks(const AllocationCallbacks& value)
 119   {
 120     allocationCallbacks = &value;
 121     return *this;
 122   }
 123
 124   GraphicsStructureType        type{GraphicsStructureType::FRAMEBUFFER_CREATE_INFO_STRUCT};
 125   ExtensionCreateInfo*         nextExtension{nullptr};
 126   std::vector<ColorAttachment> colorAttachments{};
 127   DepthStencilAttachment       depthStencilAttachment{};
 128   Extent2D                     size{};
 129   uint8_t                      multiSamplingLevel{0u};
 130
 131   const AllocationCallbacks* allocationCallbacks{nullptr};
 132 };
 133
 134 } // namespace Graphics
 135 } // namespace Dali
 136
 137 #endif // DALI_GRAPHICS_FRAMEBUFFER_CREATE_INFO_H