1 #ifndef DALI_INTERNAL_RENDER_PROPERTY_BUFFER_H
2 #define DALI_INTERNAL_RENDER_PROPERTY_BUFFER_H
5 * Copyright (c) 2018 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
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>
48 * Structure that holds the meta-data of the format of PropertyBuffer.
52 std::vector<Component> components;
57 * @brief Default constructor
67 * @brief Set the format of the buffer
69 * This function takes ownership of the pointer
71 * @param[in] format The format for the PropertyBuffer
73 void SetFormat( PropertyBuffer::Format* format );
76 * @brief Set the data of the PropertyBuffer
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
82 void SetData( Dali::Vector<uint8_t>* data, uint32_t size );
85 * @brief Set the number of elements
86 * @param[in] size The number of elements
88 void SetSize( uint32_t size );
91 * @brief Bind the property buffer
92 * @param context The context to bind the the buffer
93 * @param[in] target The binding point
95 void BindBuffer( Context& context, GpuBuffer::Target target );
98 * Perform the upload of the buffer only when requiered
99 * @param[in] context The GL context
101 bool Update( Context& context );
104 * Enable the vertex attributes for each vertex buffer from the corresponding
106 * @param[in] context The GL context
107 * @param[in] vAttributeLocation Vector containing attributes location for current program
108 * @param[in] locationBase Index in vAttributeLocation corresponding to the first attribute defined by this buffer
110 uint32_t EnableVertexAttributes( Context& context, Vector<GLint>& vAttributeLocation, uint32_t locationBase );
113 * Get the number of attributes present in the buffer
114 * @return The number of attributes stored in this buffer
116 inline uint32_t GetAttributeCount() const
118 DALI_ASSERT_DEBUG( mFormat && "Format should be set ");
119 return static_cast<uint32_t>( mFormat->components.size() );
123 * Retrieve the i-essim attribute name
124 * @param[in] index The index of the attribute
125 * @return The name of the attribute
127 inline const std::string& GetAttributeName( uint32_t index ) const
129 DALI_ASSERT_DEBUG( mFormat && "Format should be set ");
130 return mFormat->components[index].name;
134 * Retrieve the size of the buffer in bytes
135 * @return The total size of the buffer
137 inline uint32_t GetDataSize() const
139 DALI_ASSERT_DEBUG( mFormat && "Format should be set ");
140 return mFormat->size * mSize;
144 * Retrieve the size of one element of the buffer
145 * @return The size of one element
147 inline uint32_t GetElementSize() const
149 DALI_ASSERT_DEBUG( mFormat && "Format should be set ");
150 return mFormat->size;
154 * Retrieve the number of elements in the buffer
155 * @return The total number of elements
157 inline uint32_t GetElementCount() const
163 * Retrieve reference to the data storage vector
164 * @return Reference to the data storage
166 inline const Dali::Vector< uint8_t >& GetData() const
172 * Retrieve data writeable pointer ( direct access to the buffer data )
173 * @return Pointer to data converted to requested type
175 template <typename T>
176 inline T* GetDataTypedPtr()
178 Dali::Vector< uint8_t >* data = mData.Release();
180 return reinterpret_cast<T*>( &data->operator[]( 0 ) );
183 inline const PropertyBuffer::Format* GetFormat() const
185 return mFormat.Get();
189 OwnerPointer< PropertyBuffer::Format > mFormat; ///< Format of the buffer
190 OwnerPointer< Dali::Vector< uint8_t > > mData; ///< Data
191 OwnerPointer< GpuBuffer > mGpuBuffer; ///< Pointer to the GpuBuffer associated with this RenderPropertyBuffer
193 uint32_t mSize; ///< Number of Elements in the buffer
194 bool mDataChanged; ///< Flag to know if data has changed in a frame
197 } // namespace Render
199 } // namespace Internal
204 #endif // DALI_INTERNAL_RENDER_PROPERTY_BUFFER_H