Tizen(Headed) Native API  6.5
Classes | Public Member Functions | Static Public Member Functions
Dali::FrameBuffer Class Reference
Rendering & Effect

FrameBuffer is a collection of textures that can be used as the destination for rendering. More...

Inheritance diagram for Dali::FrameBuffer:
Dali::BaseHandle

Classes

struct  Attachment
 The initial attachments to create the FrameBuffer with. More...

Public Member Functions

 FrameBuffer ()
 Default constructor, creates an empty handle.
 ~FrameBuffer ()
 Destructor.
 FrameBuffer (const FrameBuffer &handle)
 Copy constructor, creates a new handle to the same object.
FrameBuffer & operator= (const FrameBuffer &handle)
 Assignment operator, changes this handle to point at the same object.
void AttachColorTexture (Texture &texture)
 Attach the base LOD of a 2D texture to the framebuffer for color rendering.
void AttachColorTexture (Texture &texture, uint32_t mipmapLevel, uint32_t layer)
 Attach a texture to the framebuffer for color rendering.
Texture GetColorTexture ()
 Gets the first color texture used as output in the FrameBuffer.
 FrameBuffer (Internal::FrameBuffer *pointer)
 The constructor.

Static Public Member Functions

static FrameBuffer New (uint32_t width, uint32_t height)
 Creates a new FrameBuffer, which attaches only COLOR texture.
static FrameBuffer New (uint32_t width, uint32_t height, Attachment::Mask attachments)
 Creates a new FrameBuffer with specific attachments.
static FrameBuffer New (uint32_t width, uint32_t height, uint32_t attachments)
 Creates a new FrameBuffer object.
static FrameBuffer DownCast (BaseHandle handle)
 Downcasts to a FrameBuffer. If not, the returned handle is left uninitialized.

Detailed Description

FrameBuffer is a collection of textures that can be used as the destination for rendering.

Since:
3.0, DALi version 1.1.43

Constructor & Destructor Documentation

Dali::FrameBuffer::~FrameBuffer ( )

Destructor.

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

Copy constructor, creates a new handle to the same object.

Since:
3.0, DALi version 1.1.43
Parameters:
[in]handleHandle to an object
Dali::FrameBuffer::FrameBuffer ( Internal::FrameBuffer *  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 FrameBuffer

Member Function Documentation

void Dali::FrameBuffer::AttachColorTexture ( Texture &  texture)

Attach the base LOD of a 2D texture to the framebuffer for color rendering.

Note:
This causes a color attachment to be added.
Repeated calls to this method add textures as subsequent color attachments.
A maximum of 8 color attachments are supported.
Since:
3.0, DALi version 1.1.43
Parameters:
[in]textureThe texture that will be used as output when rendering
Note:
The texture has to have same size as that of FrameBuffer otherwise it won't be attached.
void Dali::FrameBuffer::AttachColorTexture ( Texture &  texture,
uint32_t  mipmapLevel,
uint32_t  layer 
)

Attach a texture to the framebuffer for color rendering.

Note:
This causes a color attachment to be added.
Repeated calls to this method add textures as subsequent color attachments.
A maximum of 8 color attachments are supported.
Since:
3.0, DALi version 1.1.43
Parameters:
[in]textureThe texture that will be used as output when rendering
[in]mipmapLevelThe mipmap of the texture to be attached
[in]layerIndicates which layer of a cube map or array texture to attach. Unused for 2D textures
Note:
The mipmapped texture has to have same size as that of FrameBuffer otherwise it won't be attached.
static FrameBuffer Dali::FrameBuffer::DownCast ( BaseHandle  handle) [static]

Downcasts to a FrameBuffer. If not, the returned handle is left uninitialized.

Since:
3.0, DALi version 1.1.43
Parameters:
[in]handleHandle to an object
Returns:
FrameBuffer handle or an uninitialized handle
Texture Dali::FrameBuffer::GetColorTexture ( )

Gets the first color texture used as output in the FrameBuffer.

Since:
3.0, DALi version 1.1.43
Returns:
A handle to the texture used as color output, or an uninitialized handle
static FrameBuffer Dali::FrameBuffer::New ( uint32_t  width,
uint32_t  height 
) [static]

Creates a new FrameBuffer, which attaches only COLOR texture.

Since:
5.5, DALi version 1.4.0
Note:
Call GetColorTexture() to get the COLOR texture
Parameters:
[in]widthThe width of the FrameBuffer and the color texture
[in]heightThe height of the FrameBuffer and the color texture
Returns:
A handle to a newly allocated FrameBuffer
static FrameBuffer Dali::FrameBuffer::New ( uint32_t  width,
uint32_t  height,
Attachment::Mask  attachments 
) [static]

Creates a new FrameBuffer with specific attachments.

Since:
5.5, DALi version 1.4.0
Parameters:
[in]widthThe width of the FrameBuffer and the attachments
[in]heightThe height of the FrameBuffer and the attachments
[in]attachmentsEnumeration of the attachments to create
Returns:
A handle to a newly allocated FrameBuffer
static FrameBuffer Dali::FrameBuffer::New ( uint32_t  width,
uint32_t  height,
uint32_t  attachments 
) [static]

Creates a new FrameBuffer object.

Deprecated:
Deprecated since 5.5, DALi version 1.4.0 use New( uint32_t width, uint32_t height ) or New( uint32_t width, uint32_t height, Attachment::Mask attachments ) instead
Since:
3.0, DALi version 1.1.43
Parameters:
[in]widthThe width of the FrameBuffer
[in]heightThe height of the FrameBuffer
[in]attachmentsThe attachments comprising the format of the FrameBuffer (the type is int to allow multiple bitmasks to be ORd)
Returns:
A handle to a newly allocated FrameBuffer
FrameBuffer& Dali::FrameBuffer::operator= ( const FrameBuffer &  handle)

Assignment operator, changes this handle to point at the same object.

Since:
3.0, DALi version 1.1.43
Parameters:
[in]handleHandle to an object
Returns:
Reference to the assigned object