Tizen Native API  4.0
Public Member Functions | Static Public Member Functions
Dali::RenderTaskList Class Reference
Rendering & Effect

An ordered list of Dali::RenderTasks. More...

Inheritance diagram for Dali::RenderTaskList:
Dali::BaseHandle

Public Member Functions

 RenderTaskList ()
 Creates an empty RenderTaskList handle.
 ~RenderTaskList ()
 Destructor.
 RenderTaskList (const RenderTaskList &handle)
 This copy constructor is required for (smart) pointer semantics.
RenderTaskList & operator= (const RenderTaskList &rhs)
 This assignment operator is required for (smart) pointer semantics.
RenderTask CreateTask ()
 Creates a new RenderTask.
void RemoveTask (RenderTask task)
 Removes a RenderTask from the list of render-tasks.
unsigned int GetTaskCount () const
 Queries the number of render-tasks in the list.
RenderTask GetTask (unsigned int index) const
 Retrieves a render-task.

Static Public Member Functions

static RenderTaskList DownCast (BaseHandle handle)
 Downcasts a handle to RenderTaskList handle.

Detailed Description

An ordered list of Dali::RenderTasks.

These tasks describe how the Dali scene should be rendered;

See also:
Dali::RenderTask for more details.
Since:
3.0, DALi version 1.0.0

Constructor & Destructor Documentation

Dali::RenderTaskList::RenderTaskList ( )

Creates an empty RenderTaskList handle.

This can be initialised with Stage::GetRenderTaskList().

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

Destructor.

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

Since:
3.0, DALi version 1.0.0
Dali::RenderTaskList::RenderTaskList ( const RenderTaskList &  handle)

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

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

Member Function Documentation

RenderTask Dali::RenderTaskList::CreateTask ( )

Creates a new RenderTask.

This will be appended to the list of render-tasks.

Since:
3.0, DALi version 1.0.0
Returns:
A valid handle to a new RenderTask
static RenderTaskList Dali::RenderTaskList::DownCast ( BaseHandle  handle) [static]

Downcasts a handle to RenderTaskList handle.

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

Since:
3.0, DALi version 1.0.0
Parameters:
[in]handleA handle to an object
Returns:
A handle to a RenderTaskList or an uninitialized handle
RenderTask Dali::RenderTaskList::GetTask ( unsigned int  index) const

Retrieves a render-task.

Since:
3.0, DALi version 1.0.0
Parameters:
[in]indexThe index of the render task to retrieve
Returns:
A handle to the render-task
Precondition:
index should be in range i.e. less than GetTaskCount().
unsigned int Dali::RenderTaskList::GetTaskCount ( ) const

Queries the number of render-tasks in the list.

This is ordered i.e. the task with index 0 is the first to be processed each frame.

Since:
3.0, DALi version 1.0.0
Returns:
The number of render-tasks
RenderTaskList& Dali::RenderTaskList::operator= ( const RenderTaskList &  rhs)

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

Since:
3.0, DALi version 1.0.0
Parameters:
[in]rhsA reference to the copied handle
Returns:
A reference to this
void Dali::RenderTaskList::RemoveTask ( RenderTask  task)

Removes a RenderTask from the list of render-tasks.

Since:
3.0, DALi version 1.0.0
Parameters:
[in]taskThe render-task to remove.