Tizen Native API  5.0
Public Types | Public Member Functions | Static Public Member Functions
Dali::Image Class Reference
Images

An Image object represents an image resource that can be used for rendering. More...

Inheritance diagram for Dali::Image:
Dali::BaseHandle Dali::BufferImage Dali::EncodedBufferImage Dali::FrameBufferImage Dali::NativeImage Dali::ResourceImage

Public Types

typedef Signal< void(Image) > ImageSignalType
 Type of signal for Image Uploaded.

Public Member Functions

 Image () DALI_DEPRECATED_API
 Constructor which creates an empty Image handle.
 ~Image () DALI_DEPRECATED_API
 Destructor.
 Image (const Image &handle) DALI_DEPRECATED_API
 This copy constructor is required for (smart) pointer semantics.
Image & operator= (const Image &rhs) DALI_DEPRECATED_API
 This assignment operator is required for (smart) pointer semantics.
uint32_t GetWidth () const DALI_DEPRECATED_API
 Returns the width of the image.
uint32_t GetHeight () const DALI_DEPRECATED_API
 Returns the height of the image.
ImageSignalType & UploadedSignal () DALI_DEPRECATED_API
 This signal is emitted when the image data gets uploaded to GL.

Static Public Member Functions

static Image DownCast (BaseHandle handle) DALI_DEPRECATED_API
 Downcasts a handle to Image handle.

Detailed Description

An Image object represents an image resource that can be used for rendering.

Deprecated:
Deprecated since 4.0, DALi version 1.2.41

Image objects can be shared between Actors. This is practical if you have a visual element on screen which is repeatedly used.

The image resource is released as soon as the last Image handle is released.

Since:
2.4, DALi version 1.0.0
Note:
If a resource was shared between Image objects it exists until its last reference is gone.

Image objects are responsible for the underlying resource's lifetime.

Signals | Signal Name | Method | |------------------------|------------------------------| | uploaded | UploadedSignal() |

Since:
2.4, DALi version 1.0.0

Member Typedef Documentation

typedef Signal< void (Image) > Dali::Image::ImageSignalType

Type of signal for Image Uploaded.

Deprecated:
Deprecated since 4.0, DALi version 1.2.41
Since:
2.4, DALi version 1.0.0

Constructor & Destructor Documentation

Dali::Image::Image ( )

Constructor which creates an empty Image handle.

Deprecated:
Deprecated since 4.0, DALi version 1.2.41

This class has no New method. Use the appropriate New method of its subclasses to create an initialized handle. (Dali::BufferImage::New(), Dali::EncodedBufferImage::New(), Dali::FrameBufferImage::New(), Dali::NativeImage::New(), Dali::ResourceImage::New()).

Since:
2.4, DALi version 1.0.0
Dali::Image::~Image ( )

Destructor.

Deprecated:
Deprecated since 4.0, DALi version 1.2.41

This is non-virtual since derived Handle types must not contain data or virtual methods.

Since:
2.4, DALi version 1.0.0
Dali::Image::Image ( const Image &  handle)

This copy constructor is required for (smart) pointer semantics.

Deprecated:
Deprecated since 4.0, DALi version 1.2.41
Since:
2.4, DALi version 1.0.0
Parameters:
[in]handleA reference to the copied handle

Member Function Documentation

static Image Dali::Image::DownCast ( BaseHandle  handle) [static]

Downcasts a handle to Image handle.

Deprecated:
Deprecated since 4.0, DALi version 1.2.41

If handle points to a Image object, the downcast produces valid handle. If not, the returned handle is left uninitialized.

Since:
2.4, DALi version 1.0.0
Parameters:
[in]handleHandle to an object
Returns:
Handle to a Image object or an uninitialized handle

Reimplemented in Dali::ResourceImage, Dali::BufferImage, Dali::EncodedBufferImage, Dali::NativeImage, and Dali::FrameBufferImage.

uint32_t Dali::Image::GetHeight ( ) const

Returns the height of the image.

Deprecated:
Deprecated since 4.0, DALi version 1.2.41

Returns either the requested height or the actual loaded height if no specific size was requested.

Since:
2.4, DALi version 1.0.0
Returns:
Height of the image in pixels
uint32_t Dali::Image::GetWidth ( ) const

Returns the width of the image.

Deprecated:
Deprecated since 4.0, DALi version 1.2.41

Returns either the requested width or the actual loaded width if no specific size was requested.

Since:
2.4, DALi version 1.0.0
Returns:
Width of the image in pixels
Image& Dali::Image::operator= ( const Image &  rhs)

This assignment operator is required for (smart) pointer semantics.

Deprecated:
Deprecated since 4.0, DALi version 1.2.41
Since:
2.4, DALi version 1.0.0
Parameters:
[in]rhsA reference to the copied handle
Returns:
A reference to this
ImageSignalType& Dali::Image::UploadedSignal ( )

This signal is emitted when the image data gets uploaded to GL.

Deprecated:
Deprecated since 4.0, DALi version 1.2.41

It Will be sent after an actor using the image is added to the stage, when such a staged image is reloaded, or when a staged BufferImage calls Update().

Since:
2.4, DALi version 1.0.0
Returns:
A signal object to Connect() with