dali/internal/render/renderers/render-property-buffer.h

   1 #ifndef DALI_INTERNAL_RENDER_PROPERTY_BUFFER_H
   2 #define DALI_INTERNAL_RENDER_PROPERTY_BUFFER_H
   3
   4 /*
   5  * Copyright (c) 2018 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 // INTERNAL INCLUDES
  21 #include <dali/public-api/actors/sampling.h>
  22 #include <dali/public-api/common/vector-wrapper.h>
  23 #include <dali/public-api/rendering/sampler.h>
  24 #include <dali/internal/common/owner-pointer.h>
  25 #include <dali/internal/render/renderers/render-sampler.h>
  26 #include <dali/internal/render/gl-resources/gpu-buffer.h>
  27
  28 namespace Dali
  29 {
  30 namespace Internal
  31 {
  32 namespace Render
  33 {
  34
  35 class PropertyBuffer
  36 {
  37 public:
  38
  39   struct Component
  40   {
  41     std::string    name;
  42     uint32_t       offset;
  43     uint32_t       size;
  44     Property::Type type;
  45   };
  46
  47   /**
  48    * Structure that holds the meta-data of the format of PropertyBuffer.
  49    */
  50   struct Format
  51   {
  52     std::vector<Component> components;
  53     uint32_t               size;
  54   };
  55
  56   /**
  57    * @brief Default constructor
  58    */
  59   PropertyBuffer();
  60
  61   /**
  62    * @brief Destructor
  63    */
  64   ~PropertyBuffer();
  65
  66   /**
  67    * @brief Set the format of the buffer
  68    *
  69    * This function takes ownership of the pointer
  70    *
  71    * @param[in] format The format for the PropertyBuffer
  72    */
  73   void SetFormat( PropertyBuffer::Format* format );
  74
  75   /**
  76    * @brief Set the data of the PropertyBuffer
  77    *
  78    * This function takes ownership of the pointer
  79    * @param[in] data The new data of the PropertyBuffer
  80    * @param[in] size The new size of the buffer
  81    */
  82   void SetData( Dali::Vector<uint8_t>* data, uint32_t size );
  83
  84   /**
  85    * @brief Set the number of elements
  86    * @param[in] size The number of elements
  87    */
  88   void SetSize( uint32_t size );
  89
  90   /**
  91    * @brief Bind the property buffer
  92    * @param[in] target The binding point
  93    */
  94   void BindBuffer(GpuBuffer::Target target);
  95
  96   /**
  97    * Perform the upload of the buffer only when requiered
  98    * @param[in] context The GL context
  99    */
 100   bool Update( Context& context );
 101
 102   /**
 103    * Enable the vertex attributes for each vertex buffer from the corresponding
 104    * shader program.
 105    * @param[in] context The GL context
 106    * @param[in] vAttributeLocation Vector containing attributes location for current program
 107    * @param[in] locationBase Index in vAttributeLocation corresponding to the first attribute defined by this buffer
 108    */
 109   uint32_t EnableVertexAttributes( Context& context, Vector<GLint>& vAttributeLocation, uint32_t locationBase );
 110
 111   /**
 112    * Get the number of attributes present in the buffer
 113    * @return The number of attributes stored in this buffer
 114    */
 115   inline uint32_t GetAttributeCount() const
 116   {
 117     DALI_ASSERT_DEBUG( mFormat && "Format should be set ");
 118     return static_cast<uint32_t>( mFormat->components.size() );
 119   }
 120
 121   /**
 122    * Retrieve the i-essim attribute name
 123    * @param[in] index The index of the attribute
 124    * @return The name of the attribute
 125    */
 126   inline const std::string& GetAttributeName( uint32_t index ) const
 127   {
 128     DALI_ASSERT_DEBUG( mFormat && "Format should be set ");
 129     return mFormat->components[index].name;
 130   }
 131
 132   /**
 133    * Retrieve the size of the buffer in bytes
 134    * @return The total size of the buffer
 135    */
 136   inline uint32_t GetDataSize() const
 137   {
 138     DALI_ASSERT_DEBUG( mFormat && "Format should be set ");
 139     return mFormat->size * mSize;
 140   }
 141
 142   /**
 143    * Retrieve the size of one element of the buffer
 144    * @return The size of one element
 145    */
 146   inline uint32_t GetElementSize() const
 147   {
 148     DALI_ASSERT_DEBUG( mFormat && "Format should be set ");
 149     return mFormat->size;
 150   }
 151
 152   /**
 153    * Retrieve the number of elements in the buffer
 154    * @return The total number of elements
 155    */
 156   inline uint32_t GetElementCount() const
 157   {
 158     return mSize;
 159   }
 160
 161   /**
 162    * Retrieve reference to the data storage vector
 163    * @return Reference to the data storage
 164    */
 165   inline const Dali::Vector< uint8_t >& GetData() const
 166   {
 167     return *mData.Get();
 168   }
 169
 170   /**
 171    * Retrieve data writeable pointer ( direct access to the buffer data )
 172    * @return Pointer to data converted to requested type
 173    */
 174   template <typename T>
 175   inline T* GetDataTypedPtr()
 176   {
 177     Dali::Vector< char >* data = mData.Release();
 178     mData = data;
 179     return reinterpret_cast<T*>( &data->operator[]( 0 ) );
 180   }
 181
 182   inline const PropertyBuffer::Format* GetFormat() const
 183   {
 184     return mFormat.Get();
 185   }
 186
 187 private:
 188   OwnerPointer< PropertyBuffer::Format >  mFormat;    ///< Format of the buffer
 189   OwnerPointer< Dali::Vector< uint8_t > > mData;      ///< Data
 190   OwnerPointer< GpuBuffer >               mGpuBuffer; ///< Pointer to the GpuBuffer associated with this RenderPropertyBuffer
 191
 192   uint32_t mSize;       ///< Number of Elements in the buffer
 193   bool mDataChanged;  ///< Flag to know if data has changed in a frame
 194 };
 195
 196 } // namespace Render
 197
 198 } // namespace Internal
 199
 200 } // namespace Dali
 201
 202
 203 #endif //  DALI_INTERNAL_RENDER_PROPERTY_BUFFER_H