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

The PixelData object holds a pixel buffer . The PixelData takes over the ownership of the pixel buffer. The buffer memory must NOT be released outside of this class, instead, the PixelData object will release it automatically when the reference count falls to zero. More...

Inheritance diagram for Dali::PixelData:
Dali::BaseHandle

Public Types

enum  ReleaseFunction
 Enumeration for Function to release the pixel buffer. More...

Public Member Functions

 PixelData ()
 Creates an empty handle. Use PixelData::New() to create an initialized object.
 ~PixelData ()
 Destructor.
 PixelData (const PixelData &handle)
 This copy constructor is required for (smart) pointer semantics.
PixelData & operator= (const PixelData &rhs)
 This assignment operator is required for (smart) pointer semantics.
uint32_t GetWidth () const
 Gets the width of the buffer in pixels.
uint32_t GetHeight () const
 Gets the height of the buffer in pixels.
Pixel::Format GetPixelFormat () const
 Gets the pixel format.
 PixelData (Internal::PixelData *pointer)
 The constructor.

Static Public Member Functions

static PixelData New (uint8_t *buffer, uint32_t bufferSize, uint32_t width, uint32_t height, Pixel::Format pixelFormat, ReleaseFunction releaseFunction)
 Creates a PixelData object.

Detailed Description

The PixelData object holds a pixel buffer . The PixelData takes over the ownership of the pixel buffer. The buffer memory must NOT be released outside of this class, instead, the PixelData object will release it automatically when the reference count falls to zero.

Since:
3.0, DALi version 1.1.43

Member Enumeration Documentation

enum Dali::PixelData::ReleaseFunction

Enumeration for Function to release the pixel buffer.

Since:
3.0, DALi version 1.1.43
Enumerator:
FREE 

Use free function to release the pixel buffer.

Since:
3.0, DALi version 1.1.43
DELETE_ARRAY 

Use delete[] operator to release the pixel buffer.

Since:
3.0, DALi version 1.1.43

Constructor & Destructor Documentation

Dali::PixelData::PixelData ( )

Creates an empty handle. Use PixelData::New() to create an initialized object.

Since:
3.0, DALi version 1.1.43
Dali::PixelData::~PixelData ( )

Destructor.

Since:
3.0, DALi version 1.1.43
Dali::PixelData::PixelData ( const PixelData &  handle)

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

Since:
3.0, DALi version 1.1.43
Parameters:
[in]handleA reference to the copied handle
Dali::PixelData::PixelData ( Internal::PixelData *  pointer) [explicit]

The constructor.

Note:
Not intended for application developers.
Since:
3.0, DALi version 1.1.43
Parameters:
[in]pointerA pointer to a newly allocated PixelData

Member Function Documentation

uint32_t Dali::PixelData::GetHeight ( ) const

Gets the height of the buffer in pixels.

Since:
3.0, DALi version 1.1.43
Returns:
The height of the buffer in pixels
Pixel::Format Dali::PixelData::GetPixelFormat ( ) const

Gets the pixel format.

Since:
3.0, DALi version 1.1.43
Returns:
The pixel format
uint32_t Dali::PixelData::GetWidth ( ) const

Gets the width of the buffer in pixels.

Since:
3.0, DALi version 1.1.43
Returns:
The width of the buffer in pixels
static PixelData Dali::PixelData::New ( uint8_t *  buffer,
uint32_t  bufferSize,
uint32_t  width,
uint32_t  height,
Pixel::Format  pixelFormat,
ReleaseFunction  releaseFunction 
) [static]

Creates a PixelData object.

Since:
3.0, DALi version 1.1.43
Parameters:
[in]bufferThe raw pixel data
[in]bufferSizeThe size of the buffer in bytes
[in]widthBuffer width in pixels
[in]heightBuffer height in pixels
[in]pixelFormatThe pixel format
[in]releaseFunctionThe function used to release the memory
Returns:
A handle to the PixelData
PixelData& Dali::PixelData::operator= ( const PixelData &  rhs)

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

Since:
3.0, DALi version 1.1.43
Parameters:
[in]rhsA reference to the copied handle
Returns:
A reference to this object