1 #ifndef __DALI_IMAGE_H__
2 #define __DALI_IMAGE_H__
5 * Copyright (c) 2015 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/object/base-handle.h>
26 #include <dali/public-api/signals/dali-signal.h>
31 * @addtogroup dali_core_images
35 namespace Internal DALI_INTERNAL
41 * @brief An Image object represents an image resource that can be used for rendering.
43 * Image objects can be shared between Actors. This is practical if you have a visual element on screen
44 * which is repeatedly used.
46 * The image resource is released as soon as the last Image handle is released.
48 * @note If a resource was shared between Image objects it exists until its last reference is gone.
50 * Image objects are responsible for the underlying resource's lifetime.
53 * | %Signal Name | Method |
54 * |------------------------|------------------------------|
55 * | uploaded | @ref UploadedSignal() |
58 class DALI_IMPORT_API Image : public BaseHandle
63 * @brief Type of signal for Image Uploaded.
66 typedef Signal< void (Image) > ImageSignalType;
71 * @brief Constructor which creates an empty Image handle.
73 * This class has no New method.
74 * Use the appropriate New method of its subclasses to create an initialized handle.
75 * (Dali::BufferImage::New(), Dali::EncodedBufferImage::New(), Dali::FrameBufferImage::New(),
76 * Dali::NativeImage::New(), Dali::ResourceImage::New())
84 * This is non-virtual since derived Handle types must not contain data or virtual methods.
90 * @brief This copy constructor is required for (smart) pointer semantics.
93 * @param [in] handle A reference to the copied handle
95 Image(const Image& handle);
98 * @brief This assignment operator is required for (smart) pointer semantics.
101 * @param [in] rhs A reference to the copied handle
102 * @return A reference to this
104 Image& operator=(const Image& rhs);
107 * @brief Downcast a handle to Image handle.
109 * If handle points to a Image object the
110 * downcast produces valid handle. If not the returned handle is left uninitialized.
112 * @param[in] handle Handle to an object
113 * @return Handle to a Image object or an uninitialized handle
115 static Image DownCast( BaseHandle handle );
118 * @brief Returns the width of the image.
120 * Returns either the requested width or the actual loaded width if no specific size was requested.
123 * @return Width of the image in pixels.
125 unsigned int GetWidth() const;
128 * @brief Returns the height of the image.
130 * Returns either the requested height or the actual loaded height if no specific size was requested.
133 * @return Height of the image in pixels.
135 unsigned int GetHeight() const;
140 * @brief This signal is emitted when the image data gets uploaded to GL.
142 * It Will be sent after an actor using the image is added to
143 * the stage, when such a staged image is reloaded, or when a staged
144 * BufferImage calls Update().
146 * @return A signal object to Connect() with.
148 ImageSignalType& UploadedSignal();
150 public: // Not intended for application developers
152 explicit DALI_INTERNAL Image(Internal::Image*);
160 #endif // __DALI_IMAGE_H__