Merge "Level up Dali::Internal::FreeList as Dali::FreeList" into devel/master
[platform/core/uifw/dali-core.git] / dali / devel-api / images / pixel-data-devel.h
1 #ifndef DALI_PIXEL_DATA_DEVEL_H
2 #define DALI_PIXEL_DATA_DEVEL_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 <cstdint>
23
24 // INTERNAL INCLUDES
25 #include <dali/public-api/images/pixel-data.h>
26 #include <dali/public-api/images/pixel.h>
27
28 namespace Dali
29 {
30 namespace DevelPixelData
31 {
32 /**
33  * Struct to keep the buffer pointer and the allocation method.
34  *
35  * @note Need to find a better solution - one library should not
36  * be freeing data from a different source with potentially
37  * different allocators.
38  */
39 struct PixelDataBuffer
40 {
41   uint8_t*                   buffer;
42   uint32_t                   bufferSize;
43   PixelData::ReleaseFunction releaseFunction;
44
45   PixelDataBuffer(uint8_t*                   buffer,
46                   uint32_t                   bufferSize,
47                   PixelData::ReleaseFunction releaseFunction)
48   : buffer(buffer),
49     bufferSize(bufferSize),
50     releaseFunction(releaseFunction)
51   {
52   }
53 };
54
55 /**
56  * Get the buffer from a pixel data object, zero it in the pixel data object
57  * and release the handle.
58  * @param[in,out] pixelData The pixel data object to take the buffer from
59  * @return the buffer and the data release mechanism
60  */
61 DALI_CORE_API PixelDataBuffer ReleasePixelDataBuffer(PixelData& pixelData);
62
63 } // namespace DevelPixelData
64
65 } // namespace Dali
66
67 #endif // DALI_PIXEL_DATA_DEVEL_H