1 #ifndef DALI_NATIVE_IMAGE_SOURCE_QUEUE_H
2 #define DALI_NATIVE_IMAGE_SOURCE_QUEUE_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.
22 #include <dali/public-api/images/native-image-interface.h>
23 #include <dali/public-api/object/any.h>
27 #include <dali/public-api/dali-adaptor-common.h>
32 * @addtogroup dali_adaptor_framework
36 namespace Internal DALI_INTERNAL
40 class NativeImageSourceQueue;
44 class NativeImageSourceQueue;
47 * @brief Pointer to Dali::NativeImageSourceQueue.
49 typedef Dali::IntrusivePtr< Dali::NativeImageSourceQueue > NativeImageSourceQueuePtr;
52 * @brief Used for displaying native images.
54 * NativeImage is a platform specific way of providing pixel data to the GPU for rendering,for example via an EGL image.
55 * NativeImageSourceQueue can be created internally or externally by native image source.
56 * It has a queue which handles some image buffers.
57 * Someone should fill the buffers and enqueue them, then DALi will show them.
59 class DALI_ADAPTOR_API NativeImageSourceQueue : public NativeImageInterface
64 * @brief Enumeration for the instance when creating a native image, the color depth has to be specified.
68 COLOR_DEPTH_DEFAULT, ///< Uses the current screen default depth (recommended)
69 COLOR_DEPTH_24, ///< 24 bits per pixel
70 COLOR_DEPTH_32 ///< 32 bits per pixel
74 * @brief Creates a new NativeImageSourceQueue.
75 * Depending on hardware, the width and height may have to be a power of two.
76 * @param[in] width The width of the image
77 * @param[in] height The height of the image
78 * @param[in] depth color depth of the image
79 * @return A smart-pointer to a newly allocated image
81 static NativeImageSourceQueuePtr New( uint32_t width, uint32_t height, ColorDepth depth );
84 * @brief Creates a new NativeImageSourceQueue from an existing native image source.
86 * @param[in] nativeImageSourceQueue NativeImageSourceQueue must be a any handle with native image source
87 * @return A smart-pointer to a newly allocated image
88 * @see NativeImageInterface
90 static NativeImageSourceQueuePtr New( Any nativeImageSourceQueue );
93 * @brief Retrieves the internal native image.
95 * @return Any object containing the internal native image source queue
97 Any GetNativeImageSourceQueue();
100 * @brief Sets the size of the image.
102 * @param[in] width The width of the image
103 * @param[in] height The height of the image
105 void SetSize( uint32_t width, uint32_t height );
107 private: // native image
110 * @copydoc Dali::NativeImageInterface::GlExtensionCreate()
112 virtual bool GlExtensionCreate();
115 * @copydoc Dali::NativeImageInterface::GlExtensionDestroy()
117 virtual void GlExtensionDestroy();
120 * @copydoc Dali::NativeImageInterface::TargetTexture()
122 virtual uint32_t TargetTexture();
125 * @copydoc Dali::NativeImageInterface::PrepareTexture()
127 virtual void PrepareTexture();
130 * @copydoc Dali::NativeImageInterface::GetWidth()
132 virtual uint32_t GetWidth() const;
135 * @copydoc Dali::NativeImageInterface::GetHeight()
137 virtual uint32_t GetHeight() const;
140 * @copydoc Dali::NativeImageInterface::RequiresBlending()
142 virtual bool RequiresBlending() const;
145 * @copydoc Dali::NativeImageInterface::GetExtension()
147 NativeImageInterface::Extension* GetExtension();
153 * @brief Private constructor.
154 * @param[in] width The width of the image
155 * @param[in] height The height of the image
156 * @param[in] depth color depth of the image
157 * @param[in] nativeImageSourceQueue contains either: native image source or is empty
159 DALI_INTERNAL NativeImageSourceQueue( uint32_t width, uint32_t height, ColorDepth depth, Any nativeImageSourceQueue );
162 * @brief A reference counted object may only be deleted by calling Unreference().
164 * The implementation should destroy the NativeImage resources.
166 DALI_INTERNAL virtual ~NativeImageSourceQueue();
169 * @brief Undefined copy constructor.
171 * This avoids accidental calls to a default copy constructor.
172 * @param[in] nativeImageSourceQueue A reference to the object to copy
174 DALI_INTERNAL NativeImageSourceQueue( const NativeImageSourceQueue& nativeImageSourceQueue );
177 * @brief Undefined assignment operator.
179 * This avoids accidental calls to a default assignment operator.
180 * @param[in] rhs A reference to the object to copy
182 DALI_INTERNAL NativeImageSourceQueue& operator=(const NativeImageSourceQueue& rhs);
188 std::unique_ptr< Internal::Adaptor::NativeImageSourceQueue > mImpl; ///< Implementation pointer
197 #endif // DALI_NATIVE_IMAGE_SOURCE_QUEUE_H