1 #ifndef DALI_PIXEL_DATA_H
2 #define DALI_PIXEL_DATA_H
5 * Copyright (c) 2022 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.
22 #include <cstdint> // uint8_t, uint32_t
25 #include <dali/public-api/images/pixel.h>
26 #include <dali/public-api/object/base-handle.h>
31 * @addtogroup dali_core_images
41 * @brief The PixelData object holds a pixel buffer .
42 * The PixelData takes over the ownership of the pixel buffer.
43 * The buffer memory must NOT be released outside of this class, instead, the PixelData object will release it automatically when the reference count falls to zero.
47 class DALI_CORE_API PixelData : public BaseHandle
51 * @brief Enumeration for Function to release the pixel buffer.
56 FREE, ///< Use free function to release the pixel buffer @SINCE_1_1.43
57 DELETE_ARRAY, ///< Use delete[] operator to release the pixel buffer @SINCE_1_1.43
61 * @brief Creates a PixelData object.
64 * @param[in] buffer The raw pixel data
65 * @param[in] bufferSize The size of the buffer in bytes
66 * @param[in] width Buffer width in pixels
67 * @param[in] height Buffer height in pixels
68 * @param[in] pixelFormat The pixel format
69 * @param[in] releaseFunction The function used to release the memory
70 * @return A handle to the PixelData
72 static PixelData New(uint8_t* buffer,
76 Pixel::Format pixelFormat,
77 ReleaseFunction releaseFunction);
80 * @brief Creates a PixelData object.
83 * @param[in] buffer The raw pixel data
84 * @param[in] bufferSize The size of the buffer in bytes
85 * @param[in] width Buffer width in pixels
86 * @param[in] height Buffer height in pixels
87 * @param[in] stride Buffer stride in pixels, 0 means the buffer is tightly packed
88 * @param[in] pixelFormat The pixel format
89 * @param[in] releaseFunction The function used to release the memory
90 * @return A handle to the PixelData
92 static PixelData New(uint8_t* buffer,
97 Pixel::Format pixelFormat,
98 ReleaseFunction releaseFunction);
100 * @brief Creates an empty handle.
101 * Use PixelData::New() to create an initialized object.
115 * @brief This copy constructor is required for (smart) pointer semantics.
118 * @param[in] handle A reference to the copied handle
120 PixelData(const PixelData& handle);
123 * @brief This assignment operator is required for (smart) pointer semantics.
126 * @param[in] rhs A reference to the copied handle
127 * @return A reference to this object
129 PixelData& operator=(const PixelData& rhs);
132 * @brief Move constructor.
135 * @param[in] rhs A reference to the moved handle
137 PixelData(PixelData&& rhs);
140 * @brief Move assignment operator.
143 * @param[in] rhs A reference to the moved handle
144 * @return A reference to this handle
146 PixelData& operator=(PixelData&& rhs);
149 * @brief Gets the width of the buffer in pixels.
152 * @return The width of the buffer in pixels
154 uint32_t GetWidth() const;
157 * @brief Gets the height of the buffer in pixels.
160 * @return The height of the buffer in pixels
162 uint32_t GetHeight() const;
165 * @brief Gets the pixel format.
168 * @return The pixel format
170 Pixel::Format GetPixelFormat() const;
173 * @brief Gets the stride of the buffer in pixels.
176 * @return The stride of the buffer in pixels. 0 means the buffer is tightly packed.
178 uint32_t GetStride() const;
181 * Class method to get the total currently allocated size of pixel buffers
183 static uint32_t GetTotalAllocatedSize();
187 * @brief The constructor.
188 * @note Not intended for application developers.
190 * @param[in] pointer A pointer to a newly allocated PixelData
192 explicit DALI_INTERNAL PixelData(Internal::PixelData* pointer);
200 #endif // DALI_PIXEL_DATA_H