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

   1 #ifndef DALI_GRAPHICS_BUFFER_CREATE_INFO_H
   2 #define DALI_GRAPHICS_BUFFER_CREATE_INFO_H
   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
  24 // INTERNAL INCLUDES
  25 #include "graphics-command-buffer.h"
  26 #include "graphics-types.h"
  27
  28 namespace Dali
  29 {
  30 namespace Graphics
  31 {
  32 /**
  33  * @brief CommandBufferCreateInfo describes new command buffer
  34  */
  35 struct CommandBufferCreateInfo
  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 Sets command buffer level
  56    *
  57    * The command buffer level can be set to primary or secondary. Primary buffers
  58    * are able to execute content of secondary buffers. This way, certain commands
  59    * can be reused within multiple primary buffers by executing them. The pipeline
  60    * state may be inherited from the primary buffer.
  61    *
  62    * @param[in] value Level of buffer
  63    * @return reference to this structure
  64    */
  65   auto& SetLevel(CommandBufferLevel value)
  66   {
  67     level = value;
  68     return *this;
  69   }
  70
  71   /**
  72    * @brief Sets fixed capacity of buffer
  73    *
  74    * Using fixed capacity buffer the memory for the commands may be pre-allocated.
  75    * Fixed capacity buffers may use different memory allocation strategy from dynamic
  76    * buffers (default behaviour). Buffers of known size and often re-recorded should
  77    * use fixed capacity.
  78    *
  79    * @param[in] value number of commands to be allocated
  80    * @return reference to this structure
  81    */
  82   auto& SetFixedCapacity(uint32_t value)
  83   {
  84     fixedCapacity = value;
  85     return *this;
  86   }
  87
  88   /**
  89    * @brief Sets allocation callbacks which will be used when object is created
  90    * and destroyed.
  91    *
  92    * @param[in] value Valid reference to AllocationCallbacksStructure
  93    * @return reference to this structure
  94    */
  95   auto& SetAllocationCallbacks(const AllocationCallbacks& value)
  96   {
  97     allocationCallbacks = &value;
  98     return *this;
  99   }
 100
 101   GraphicsStructureType type{GraphicsStructureType::COMMAND_BUFFER_CREATE_INFO_STRUCT};
 102   ExtensionCreateInfo*  nextExtension{nullptr};
 103   CommandBufferLevel    level{};
 104   uint32_t              fixedCapacity{0u};
 105
 106   const AllocationCallbacks* allocationCallbacks{nullptr};
 107 };
 108
 109 } // namespace Graphics
 110 } // namespace Dali
 111
 112 #endif // DALI_GRAPHICS_BUFFER_CREATE_INFO_H