dali/public-api/rendering/vertex-buffer.h

   1 #ifndef DALI_VERTEX_BUFFER_H
   2 #define DALI_VERTEX_BUFFER_H
   3
   4 /*
   5  * Copyright (c) 2020 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 <cstddef> // std::size_t
  23 #include <string>  // std::string
  24
  25 // INTERNAL INCLUDES
  26 #include <dali/public-api/object/handle.h>       // Dali::Handle
  27 #include <dali/public-api/object/property-map.h> // Dali::Property::Map
  28
  29 namespace Dali
  30 {
  31 /**
  32  * @addtogroup dali_core_rendering_effects
  33  * @{
  34  */
  35
  36 namespace Internal DALI_INTERNAL
  37 {
  38 class VertexBuffer;
  39 }
  40
  41 /**
  42  * @brief VertexBuffer is a handle to an object that contains a buffer of structured data.
  43  *
  44  * VertexBuffers can be used to provide data to Geometry objects.
  45  *
  46  * Example:
  47  *
  48  *  const float halfQuadSize = .5f;
  49  *  struct TexturedQuadVertex { Vector2 position; Vector2 textureCoordinates; };
  50  *  TexturedQuadVertex texturedQuadVertexData[4] = {
  51  *    { Vector2(-halfQuadSize, -halfQuadSize), Vector2(0.f, 0.f) },
  52  *    { Vector2( halfQuadSize, -halfQuadSize), Vector2(1.f, 0.f) },
  53  *    { Vector2(-halfQuadSize,  halfQuadSize), Vector2(0.f, 1.f) },
  54  *    { Vector2( halfQuadSize,  halfQuadSize), Vector2(1.f, 1.f) } };
  55  *
  56  *  Property::Map texturedQuadVertexFormat;
  57  *  texturedQuadVertexFormat["aPosition"] = Property::VECTOR2;
  58  *  texturedQuadVertexFormat["aTexCoord"] = Property::VECTOR2;
  59  *  VertexBuffer texturedQuadVertices = VertexBuffer::New( texturedQuadVertexFormat );
  60  *  texturedQuadVertices.SetData( texturedQuadVertexData, 4 );
  61  *
  62  *  // Create indices
  63  *  uint32_t indexData[6] = { 0, 3, 1, 0, 2, 3 };
  64  *
  65  *  // Create the geometry object
  66  *  Geometry texturedQuadGeometry = Geometry::New();
  67  *  texturedQuadGeometry.AddVertexBuffer( texturedQuadVertices );
  68  *  texturedQuadGeometry.SetIndexBuffer( indexData, sizeof(indexData)/sizeof(indexData[0] );
  69  *
  70  * @SINCE_1_1.43
  71  */
  72 class DALI_CORE_API VertexBuffer : public BaseHandle
  73 {
  74 public:
  75
  76   /**
  77    * @brief Creates a VertexBuffer.
  78    *
  79    * @SINCE_1_9.27
  80    * @param[in] bufferFormat Map of names and types that describes the components of the buffer
  81    * @return Handle to a newly allocated VertexBuffer
  82    */
  83   static VertexBuffer New( Dali::Property::Map& bufferFormat );
  84
  85   /**
  86    * @brief Default constructor, creates an empty handle.
  87    *
  88    * @SINCE_1_9.27
  89    */
  90   VertexBuffer();
  91
  92   /**
  93    * @brief Destructor.
  94    *
  95    * @SINCE_1_9.27
  96    */
  97   ~VertexBuffer();
  98
  99   /**
 100    * @brief Copy constructor, creates a new handle to the same object.
 101    *
 102    * @SINCE_1_9.27
 103    * @param[in] handle Handle to an object
 104    */
 105   VertexBuffer( const VertexBuffer& handle );
 106
 107   /**
 108    * @brief Downcasts to a property buffer handle.
 109    * If not, a property buffer the returned property buffer handle is left uninitialized.
 110    *
 111    * @SINCE_1_9.27
 112    * @param[in] handle Handle to an object
 113    * @return Property buffer handle or an uninitialized handle
 114    */
 115   static VertexBuffer DownCast( BaseHandle handle );
 116
 117   /**
 118    * @brief Assignment operator, changes this handle to point at the same object.
 119    *
 120    * @SINCE_1_9.27
 121    * @param[in] handle Handle to an object
 122    * @return Reference to the assigned object
 123    */
 124   VertexBuffer& operator=( const VertexBuffer& handle );
 125
 126   /**
 127    * @brief Move constructor.
 128    *
 129    * @SINCE_1_9.27
 130    * @param[in] rhs A reference to the moved handle
 131    */
 132   VertexBuffer( VertexBuffer&& rhs );
 133
 134   /**
 135    * @brief Move assignment operator.
 136    *
 137    * @SINCE_1_9.27
 138    * @param[in] rhs A reference to the moved handle
 139    * @return A reference to this handle
 140    */
 141   VertexBuffer& operator=( VertexBuffer&& rhs );
 142
 143   /**
 144    * @brief Updates the whole buffer information.
 145    *
 146    * This function expects a pointer to an array of structures with the same
 147    * format that was given in the construction, and the number of elements to
 148    * be the same as the size of the buffer.
 149    *
 150    * If the initial structure was: { { "position", VECTOR3}, { "uv", VECTOR2 } }
 151    * and a size of 10 elements, this function should be called with a pointer equivalent to:
 152    * <pre>
 153    * struct Vertex {
 154    *   Dali::Vector3 position;
 155    *   Dali::Vector2 uv;
 156    * };
 157    * Vertex vertices[ 10 ] = { ... };
 158    * vertexBuffer.SetData( vertices );
 159    * </pre>
 160    *
 161    * @SINCE_1_9.27
 162    * @param[in] data A pointer to the data that will be copied to the buffer
 163    * @param[in] size Number of elements to expand or contract the buffer
 164    */
 165   void SetData( const void* data, std::size_t size );
 166
 167   /**
 168    * @brief Gets the number of elements in the buffer.
 169    *
 170    * @SINCE_1_9.27
 171    * @return Number of elements to expand or contract the buffer
 172    */
 173   std::size_t GetSize() const;
 174
 175 public:
 176
 177   /**
 178    * @brief The constructor.
 179    * @note  Not intended for application developers.
 180    * @SINCE_1_9.27
 181    * @param[in] pointer A pointer to a newly allocated VertexBuffer
 182    */
 183   explicit DALI_INTERNAL VertexBuffer( Internal::VertexBuffer* pointer );
 184 };
 185
 186 /**
 187  * @}
 188  */
 189 } // namespace Dali
 190
 191 #endif // DALI_VERTEX_BUFFER_H