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

FrameBufferImage represents a GLES 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 ()
 Constructor which creates an uninitialized FrameBufferImage object.
 ~FrameBufferImage ()
 Destructor.
 FrameBufferImage (const FrameBufferImage &handle)
 This copy constructor is required for (smart) pointer semantics.
FrameBufferImage & operator= (const FrameBufferImage &rhs)
 This assignment operator is required for (smart) pointer semantics.

Static Public Member Functions

static FrameBufferImage New (unsigned int width=0, unsigned int height=0, Pixel::Format pixelFormat=Pixel::RGBA8888, RenderBuffer::Format bufferFormat=RenderBuffer::COLOR)
 Create a new FrameBufferImage.
static FrameBufferImage New (NativeImageInterface &image)
 Create a new FrameBufferImage.
static FrameBufferImage DownCast (BaseHandle handle)
 Downcast a handle to FrameBufferImage handle.

Detailed Description

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

The FrameBufferImage can then be used with an Dali::Toolkit::ImageView (with optional shader effects) and rendered to the screen.

Since :
2.4

Constructor & Destructor Documentation

Dali::FrameBufferImage::FrameBufferImage ( )

Constructor which creates an uninitialized FrameBufferImage object.

Use FrameBufferImage::New to create an initialised object.

Since :
2.4
Dali::FrameBufferImage::~FrameBufferImage ( )

Destructor.

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

Since :
2.4
Dali::FrameBufferImage::FrameBufferImage ( const FrameBufferImage &  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 FrameBufferImage Dali::FrameBufferImage::DownCast ( BaseHandle  handle) [static]

Downcast a handle to FrameBufferImage handle.

If handle points to a FrameBufferImage object 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 FrameBufferImage object or an uninitialized handle

Reimplemented from Dali::Image.

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

Create a new FrameBufferImage.

The maximum size of the image is limited by GL_MAX_TEXTURE_SIZE.

Since :
2.4
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]

Create a new FrameBufferImage.

The maximum size of the image is limited by GL_MAX_TEXTURE_SIZE.

Since :
2.4
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.

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