Dali 3D User Interface Engine
List of all members | Public Member Functions | Static Public Member Functions
Dali::FrameBufferImage Class Reference

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

#include <frame-buffer-image.h>

Inheritance diagram for Dali::FrameBufferImage:
Inheritance graph
[legend]
Collaboration diagram for Dali::FrameBufferImage:
Collaboration graph
[legend]

Public Member Functions

 FrameBufferImage ()
 Constructor which creates an uninitialized FrameBufferImage object. More...
 
 ~FrameBufferImage ()
 Destructor. More...
 
 FrameBufferImage (const FrameBufferImage &handle)
 This copy constructor is required for (smart) pointer semantics. More...
 
FrameBufferImageoperator= (const FrameBufferImage &rhs)
 This assignment operator is required for (smart) pointer semantics. More...
 
DALI_INTERNAL FrameBufferImage (Internal::FrameBufferImage *)
 
- Public Member Functions inherited from Dali::Image
 Image ()
 Constructor which creates an empty Image handle. More...
 
 ~Image ()
 Destructor. More...
 
 Image (const Image &handle)
 This copy constructor is required for (smart) pointer semantics. More...
 
Imageoperator= (const Image &rhs)
 This assignment operator is required for (smart) pointer semantics. More...
 
ReleasePolicy GetReleasePolicy () const
 .3 More...
 
unsigned int GetWidth () const
 Returns the width of the image. More...
 
unsigned int GetHeight () const
 Returns the height of the image. More...
 
ImageSignalTypeUploadedSignal ()
 This signal is emitted when the image data gets uploaded to GL. More...
 
DALI_INTERNAL Image (Internal::Image *)
 
- Public Member Functions inherited from Dali::BaseHandle
 BaseHandle (Dali::BaseObject *handle)
 This constructor is used by Dali New() methods. More...
 
 BaseHandle ()
 This constructor provides an uninitialized Dali::BaseHandle. More...
 
 ~BaseHandle ()
 Dali::BaseHandle is intended as a base class. More...
 
 BaseHandle (const BaseHandle &handle)
 This copy constructor is required for (smart) pointer semantics. More...
 
BaseHandleoperator= (const BaseHandle &rhs)
 This assignment operator is required for (smart) pointer semantics. More...
 
template<class T >
bool ConnectSignal (ConnectionTrackerInterface *connectionTracker, const std::string &signalName, const T &functor)
 Connects a void() functor to a specified signal. More...
 
bool DoAction (const std::string &actionName, const Property::Map &attributes)
 Perform action on this object with the given action name and attributes. More...
 
const std::string & GetTypeName () const
 Returns the type name for the Handle. More...
 
bool GetTypeInfo (Dali::TypeInfo &info) const
 Returns the type info for the Handle. More...
 
BaseObjectGetBaseObject ()
 Retrieve the internal Dali resource. More...
 
const BaseObjectGetBaseObject () const
 Retrieve the internal Dali resource. More...
 
void Reset ()
 Resets the handle. More...
 
 operator BooleanType () const
 Converts an handle to a BooleanType. More...
 
bool operator== (const BaseHandle &rhs) const
 Equality operator overload. More...
 
bool operator!= (const BaseHandle &rhs) const
 Inequality operator overload. More...
 
Dali::RefObjectGetObjectPtr () const
 Get the reference counted object pointer. More...
 

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. More...
 
static FrameBufferImage New (unsigned int width, unsigned int height, Pixel::Format pixelFormat, ReleasePolicy releasePolicy, RenderBuffer::Format bufferFormat=RenderBuffer::COLOR)
 .3. More...
 
static FrameBufferImage New (NativeImageInterface &image)
 Create a new FrameBufferImage. More...
 
static FrameBufferImage New (NativeImageInterface &image, ReleasePolicy releasePolicy)
 .3. More...
 
static FrameBufferImage DownCast (BaseHandle handle)
 Downcast an Object handle to FrameBufferImage handle. More...
 
- Static Public Member Functions inherited from Dali::Image
static Image DownCast (BaseHandle handle)
 Downcast an Object handle to Image handle. More...
 

Additional Inherited Members

- Public Types inherited from Dali::Image
enum  ReleasePolicy { UNUSED, NEVER }
 .3. More...
 
typedef Signal< void(Image) > ImageSignalType
 Type of signal for Image Uploaded. More...
 
- Protected Member Functions inherited from Dali::BaseHandle
void ThisIsSaferThanReturningVoidStar () const
 Used by the safe bool idiom. More...
 

Detailed Description

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

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

Definition at line 60 of file frame-buffer-image.h.

Constructor & Destructor Documentation

Dali::FrameBufferImage::FrameBufferImage ( )

Constructor which creates an uninitialized FrameBufferImage object.

Use Image::New(...) to create an initialised object. .0

Definition at line 30 of file frame-buffer-image.cpp.

Referenced by DownCast(), and New().

Here is the caller graph for this function:

Dali::FrameBufferImage::~FrameBufferImage ( )

Destructor.

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

Definition at line 39 of file frame-buffer-image.cpp.

Dali::FrameBufferImage::FrameBufferImage ( const FrameBufferImage handle)

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

.0

Parameters
[in]handleA reference to the copied handle

Definition at line 43 of file frame-buffer-image.cpp.

Dali::FrameBufferImage::FrameBufferImage ( Internal::FrameBufferImage internal)
explicit

Definition at line 34 of file frame-buffer-image.cpp.

Member Function Documentation

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

Downcast an Object handle to FrameBufferImage handle.

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

Parameters
[in]handleto An object
Returns
handle to a FrameBufferImage object or an uninitialized handle

Definition at line 92 of file frame-buffer-image.cpp.

References FrameBufferImage(), and Dali::BaseHandle::GetObjectPtr().

Referenced by Dali::Scripting::CreatePropertyMap(), Dali::Toolkit::Internal::Builder::GetFrameBufferImage(), UtcDaliFrameBufferImageDownCast(), UtcDaliScriptingNewImage06P(), UtcDaliScriptingNewImage09P(), and UtcDaliSuperBlurViewGetBlurredImage().

Here is the call graph for this function:

Here is the caller graph for this function:

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.

.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.

Definition at line 54 of file frame-buffer-image.cpp.

References FrameBufferImage(), Dali::PropertyTypes::Get(), Dali::Stage::GetCurrent(), Dali::Stage::GetSize(), Dali::Vector2::height, Dali::Internal::FrameBufferImage::New(), and Dali::Vector2::width.

Referenced by anonymous_namespace{utc-Dali-RenderTask.cpp}::CreateRenderTask(), Dali::Toolkit::Internal::EmbossFilter::Enable(), Dali::Toolkit::Internal::BlurTwoPassFilter::Enable(), Dali::Toolkit::Internal::SpreadFilter::Enable(), Dali::Toolkit::Text::Clipper::Initialize(), Dali::Scripting::NewImage(), Dali::Toolkit::Internal::BubbleEmitter::OnInitialize(), Dali::Toolkit::Internal::SuperBlurView::OnSizeSet(), Dali::Toolkit::Text::Clipper::Refresh(), UtcDaliEffectsViewSetGetOutputImage(), UtcDaliEffectsViewSetOutputImageN(), UtcDaliEffectsViewSetRefreshOnDemandP(), UtcDaliEffectsViewSizeSet(), UtcDaliFrameBufferImageAttachments01(), UtcDaliFrameBufferImageAttachments02(), UtcDaliFrameBufferImageAttachments03(), UtcDaliFrameBufferImageAttachments04(), UtcDaliFrameBufferImageDownCast(), UtcDaliFrameBufferImageNew01(), UtcDaliFrameBufferImageNew02(), UtcDaliFrameBufferImageNew03(), UtcDaliGaussianBlurViewSetGetRenderTarget(), UtcDaliHitTestAlgorithmWithFunctorOnRenderTask(), UtcDaliHoverOffscreenRenderTasks(), UtcDaliImageActorUseImageAlpha04(), UtcDaliImageGetWidthHeight(), UtcDaliRenderTaskFinishInvisibleSourceActor(), UtcDaliRenderTaskGetTargetFrameBufferP(), UtcDaliRenderTaskSetScreenToFrameBufferMappingActor(), UtcDaliRenderTaskSetTargetFrameBufferP(), UtcDaliRenderTaskSignalFinished(), UtcDaliScriptingCreatePropertyMapImage(), and UtcDaliTouchOffscreenRenderTasks().

Here is the call graph for this function:

Here is the caller graph for this function:

FrameBufferImage Dali::FrameBufferImage::New ( unsigned int  width,
unsigned int  height,
Pixel::Format  pixelFormat,
ReleasePolicy  releasePolicy,
RenderBuffer::Format  bufferFormat = RenderBuffer::COLOR 
)
static

.3.

Use New() instead.

Create a new FrameBufferImage.

The maximum size of the image is limited by GL_MAX_TEXTURE_SIZE. .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.
[in]releasePolicyThe ReleasePolicy to apply to the FrameBufferImage.
[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.

Definition at line 66 of file frame-buffer-image.cpp.

References FrameBufferImage(), Dali::PropertyTypes::Get(), Dali::Stage::GetCurrent(), Dali::Stage::GetSize(), Dali::Vector2::height, Dali::Internal::FrameBufferImage::New(), and Dali::Vector2::width.

Here is the call graph for this function:

FrameBufferImage Dali::FrameBufferImage::New ( NativeImageInterface image)
static

Create a new FrameBufferImage.

The maximum size of the image is limited by GL_MAX_TEXTURE_SIZE. .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.

Definition at line 86 of file frame-buffer-image.cpp.

References FrameBufferImage(), Dali::PropertyTypes::Get(), and Dali::Internal::FrameBufferImage::New().

Here is the call graph for this function:

FrameBufferImage Dali::FrameBufferImage::New ( NativeImageInterface image,
ReleasePolicy  releasePolicy 
)
static

.3.

Use New( NativeImageInterface& ) instead.

Create a new FrameBufferImage.

The maximum size of the image is limited by GL_MAX_TEXTURE_SIZE. .0

Parameters
[in]imageThe native image.
[in]releasePolicyThe ReleasePolicy to apply to the FrameBufferImage.
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.

Definition at line 79 of file frame-buffer-image.cpp.

References FrameBufferImage(), Dali::PropertyTypes::Get(), and Dali::Internal::FrameBufferImage::New().

Here is the call graph for this function:

FrameBufferImage & Dali::FrameBufferImage::operator= ( const FrameBufferImage rhs)

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

.0

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

Definition at line 48 of file frame-buffer-image.cpp.

References Dali::BaseHandle::operator=().

Here is the call graph for this function:


The documentation for this class was generated from the following files:
Dali Docs Home
Read more about Dali