1 #ifndef __DALI_ENCODED_BUFFER_IMAGE_H__
2 #define __DALI_ENCODED_BUFFER_IMAGE_H__
5 * Copyright (c) 2014 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.
25 #include <dali/public-api/images/image.h>
30 namespace Internal DALI_INTERNAL
32 class EncodedBufferImage;
37 * @brief EncodedBufferImage represents an image resource that can be added to
40 * A memory buffer of encoded image data is provided by the application and
41 * decoded asynchronously on a background thread to fill the image's
44 * The buffer of data provided to an EncodedBufferImage factory function
45 * (New) should be filled with encoded image data in one of %Dali's
46 * supported image file formats, with the sequence of bytes in the buffer
47 * exactly matching the sequence of bytes that a file in the file system
48 * holding the encoded image data would have.
50 * The application may free the encoded image buffer passed to one of the
51 * New() static factory member functions as soon as they return.
55 * Image::LoadingFinishedSignal is emitted when the decoding of the
56 * image data is completed, either successfully or not.
58 * Image::UploadedSignal is emitted when the decoded image data gets
59 * uploaded to the OpenGL ES implementation.
61 class DALI_IMPORT_API EncodedBufferImage : public Image
65 * @brief Constructor which creates an uninitialized EncodedBufferImage object.
67 * Use Image::New(...) to create an initialised object.
72 * @brief Create an initialised image object from an encoded image buffer in memory.
74 * The image will be created eagerly using LoadPolicy::Immediate.
75 * The function is non-blocking and returns immediately while the image
76 * decoding happens on a background thread.
77 * @param [in] encodedImage The encoded bytes of an image, in a supported
78 * image format such as PNG, JPEG, GIF, BMP, KTX, ICO, and WBMP, organised
79 * exactly as it would be as a file in the filesystem.
80 * The caller retains ownership of this buffer and is free to modify or
81 * discard it as soon as the function returns.
82 * @param [in] encodedImageByteCount The size in bytes of the buffer pointed to
84 * @param [in] attributes Requested parameters for loading (size, scaling etc.).
85 * @param [in] releasePol The ReleasePolicy to apply to Image. If the Unused
86 * policy is set, a reload will not be possible, so the Image should never be
87 * used once all actors using it have gone off-stage.
88 * @return A handle to a newly allocated object.
90 static EncodedBufferImage New(const uint8_t * const encodedImage, std::size_t encodedImageByteCount, const ImageAttributes& attributes, ReleasePolicy releasePol = Image::Never);
93 * @brief Create an initialised image object from an encoded image buffer in memory.
95 * The image will be created eagerly using LoadPolicy::Immediate.
96 * The function is non-blocking and returns immediately while the image
97 * decoding happens on a background thread.
98 * @param [in] encodedImage The encoded bytes of an image, in a supported
99 * image format such as PNG, JPEG, GIF, BMP, KTX, ICO, and WBMP, organised
100 * exactly as it would be as a file in the filesystem.
101 * The caller retains ownership of this buffer and is free to modify or
102 * discard it as soon as the function returns.
103 * @param [in] encodedImageByteCount The size in bytes of the buffer pointed to
105 * @return A handle to a newly allocated object.
107 static EncodedBufferImage New(const uint8_t * const encodedImage, std::size_t encodedImageByteCount);
110 * @brief Downcast an Object handle to EncodedBufferImage.
112 * If handle points to a EncodedBufferImage the
113 * downcast produces valid handle. If not the returned handle is left uninitialized.
114 * @param[in] handle to An object
115 * @return handle to a EncodedBufferImage or an uninitialized handle
117 static EncodedBufferImage DownCast( BaseHandle handle );
122 * This is non-virtual since derived Handle types must not contain data or virtual methods.
124 ~EncodedBufferImage();
127 * @brief This copy constructor is required for (smart) pointer semantics.
129 * @param [in] handle A reference to the copied handle
131 EncodedBufferImage(const EncodedBufferImage& handle);
134 * @brief This assignment operator is required for (smart) pointer semantics.
136 * @param [in] rhs A reference to the copied handle
137 * @return A reference to this
139 EncodedBufferImage& operator=(const EncodedBufferImage& rhs);
142 * @brief This method is defined to allow assignment of the NULL value,
143 * and will throw an exception if passed any other value.
145 * Assigning to NULL is an alias for Reset().
146 * @param [in] rhs A NULL pointer
147 * @return A reference to this handle
149 EncodedBufferImage& operator=(BaseHandle::NullType* rhs);
151 public: // Not intended for application developers
153 explicit DALI_INTERNAL EncodedBufferImage(Internal::EncodedBufferImage*);
158 #endif // __DALI_ENCODED_BUFFER_IMAGE_H__