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

FrameBufferImage represents an Open GL ES Frame Buffer Object and contains the result of an 'off screen' render pass of a RenderTask. More...

Inheritance diagram for Dali::FrameBufferImage:
Dali::Image Dali::BaseHandle

Public Member Functions

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

Static Public Member Functions

static FrameBufferImage New (uint32_t width=0, uint32_t height=0, Pixel::Format pixelFormat=Pixel::RGBA8888, RenderBuffer::Format bufferFormat=RenderBuffer::COLOR) DALI_DEPRECATED_API
 Creates a new FrameBufferImage.
static FrameBufferImage New (NativeImageInterface &image) DALI_DEPRECATED_API
 Creates a new FrameBufferImage.
static FrameBufferImage DownCast (BaseHandle handle) DALI_DEPRECATED_API
 Downcasts a handle to FrameBufferImage handle.

Detailed Description

FrameBufferImage represents an Open GL ES Frame Buffer Object and contains the result of an 'off screen' render pass of a RenderTask.

Deprecated:
Deprecated since 4.0, DALi version 1.2.41

The FrameBufferImage can then be used for rendering to the screen.

Since:
3.0, DALi version 1.0.0

Constructor & Destructor Documentation

Dali::FrameBufferImage::FrameBufferImage ( )

Constructor which creates an uninitialized FrameBufferImage object.

Deprecated:
Deprecated since 4.0, DALi version 1.2.41

Use FrameBufferImage::New to create an initialized object.

Since:
3.0, DALi version 1.0.0
Dali::FrameBufferImage::~FrameBufferImage ( )

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:
3.0, DALi version 1.0.0
Dali::FrameBufferImage::FrameBufferImage ( const FrameBufferImage &  handle)

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

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

Member Function Documentation

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

Downcasts a handle to FrameBufferImage handle.

Deprecated:
Deprecated since 4.0, DALi version 1.2.41

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

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

Reimplemented from Dali::Image.

static FrameBufferImage Dali::FrameBufferImage::New ( uint32_t  width = 0,
uint32_t  height = 0,
Pixel::Format  pixelFormat = Pixel::RGBA8888,
RenderBuffer::Format  bufferFormat = RenderBuffer::COLOR 
) [static]

Creates a new FrameBufferImage.

Deprecated:
Deprecated since 4.0, DALi version 1.2.41

The maximum size of the image is limited by GL_MAX_TEXTURE_SIZE.

Since:
3.0, DALi version 1.0.0
Parameters:
[in]widthThe width in pixels. Setting to zero will use the width of the stage
[in]heightThe height in pixels. Setting to zero will use the height of the stage
[in]pixelFormatThe pixel format (rgba 32 bit by default)
[in]bufferFormatThe format of the buffers that are going to be created for the FBO, (COLOR and DEPTH buffer as default)
Returns:
A handle to a new instance of a FrameBufferImage
Postcondition:
When the FrameBufferImage is first used as a render target, an exception may be thrown if pixelFormat is not supported on the hardware platform.
static FrameBufferImage Dali::FrameBufferImage::New ( NativeImageInterface &  image) [static]

Creates a new FrameBufferImage.

Deprecated:
Deprecated since 4.0, DALi version 1.2.41

The maximum size of the image is limited by GL_MAX_TEXTURE_SIZE.

Since:
3.0, DALi version 1.0.0
Parameters:
[in]imageThe native image
Returns:
A handle to a new instance of a FrameBufferImage
Postcondition:
When the FrameBufferImage is first used as a render target, an exception may be thrown if the NativeImage cannot be mapped to a texture.
FrameBufferImage& Dali::FrameBufferImage::operator= ( const FrameBufferImage &  rhs)

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

Deprecated:
Deprecated since 4.0, DALi version 1.2.41
Since:
3.0, DALi version 1.0.0
Parameters:
[in]rhsA reference to the copied handle
Returns:
A reference to this