Tizen Native API
Public Member Functions | Static Public Member Functions
Dali::EncodedBufferImage Class Reference
Images

EncodedBufferImage represents an image resource that can be added to ImageViews. More...

Inheritance diagram for Dali::EncodedBufferImage:
Dali::Image Dali::BaseHandle

Public Member Functions

 EncodedBufferImage ()
 Constructor which creates an uninitialized EncodedBufferImage object.
 ~EncodedBufferImage ()
 Destructor.
 EncodedBufferImage (const EncodedBufferImage &handle)
 This copy constructor is required for (smart) pointer semantics.
EncodedBufferImage & operator= (const EncodedBufferImage &rhs)
 This assignment operator is required for (smart) pointer semantics.

Static Public Member Functions

static EncodedBufferImage New (const uint8_t *const encodedImage, std::size_t encodedImageByteCount)
 Create an initialised image object from an encoded image buffer in memory.
static EncodedBufferImage DownCast (BaseHandle handle)
 Downcast a handle to EncodedBufferImage handle.

Detailed Description

EncodedBufferImage represents an image resource that can be added to ImageViews.

A memory buffer of encoded image data is provided by the application and decoded asynchronously on a background thread to fill the image's pixel data.

The buffer of data provided to an EncodedBufferImage factory function (New) should be filled with encoded image data in one of Dali's supported image file formats, with the sequence of bytes in the buffer exactly matching the sequence of bytes that a file in the file system holding the encoded image data would have.

The application may free the encoded image buffer passed to one of the New() static factory member functions as soon as they return.

Signals

Image::UploadedSignal is emitted when the decoded image data gets uploaded to the OpenGL ES implementation.

Since :
2.4

Constructor & Destructor Documentation

Dali::EncodedBufferImage::EncodedBufferImage ( )

Constructor which creates an uninitialized EncodedBufferImage object.

Use Image::New to create an initialised object.

Since :
2.4
Dali::EncodedBufferImage::~EncodedBufferImage ( )

Destructor.

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

Since :
2.4
Dali::EncodedBufferImage::EncodedBufferImage ( const EncodedBufferImage &  handle)

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

Since :
2.4
Parameters:
[in]handleA reference to the copied handle

Member Function Documentation

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

Downcast a handle to EncodedBufferImage handle.

If handle points to a EncodedBufferImage the downcast produces valid handle. If not the returned handle is left uninitialized.

Since :
2.4
Parameters:
[in]handleHandle to an object
Returns:
Handle to a EncodedBufferImage or an uninitialized handle

Reimplemented from Dali::Image.

static EncodedBufferImage Dali::EncodedBufferImage::New ( const uint8_t *const  encodedImage,
std::size_t  encodedImageByteCount 
) [static]

Create an initialised image object from an encoded image buffer in memory.

Since :
2.4
Parameters:
[in]encodedImageThe encoded bytes of an image, in a supported image format such as PNG, JPEG, GIF, BMP, KTX, ICO, and WBMP, organised exactly as it would be as a file in the filesystem. The caller retains ownership of this buffer and is free to modify or discard it as soon as the function returns.
[in]encodedImageByteCountThe size in bytes of the buffer pointed to by encodedImage.
Returns:
A handle to a newly allocated object.
EncodedBufferImage& Dali::EncodedBufferImage::operator= ( const EncodedBufferImage &  rhs)

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

Since :
2.4
Parameters:
[in]rhsA reference to the copied handle
Returns:
A reference to this