PipelineTask

Inherited: Object

Description

All render tasks must be inherited from this class.

Public Methods

void

exec (PipelineContext & context)

int

inputCount () const

std::string

inputName (int index) const

bool

isEnabled () const

Texture *

output (int index)

int

outputCount () const

std::string

outputName (int index) const

void

resize (int width, int height)

void

setEnabled (bool enable)

void

setInput (int index, Texture * source)

void

setSettings (const PostProcessSettings & settings)

Static Methods

None

Methods Description

void PipelineTask::exec (PipelineContext & context)

The task will be executed for the provided context.


int PipelineTask::inputCount () const

Return the number of inputs.


std::string PipelineTask::inputName (int index) const

Returns by index a name of input.


bool PipelineTask::isEnabled () const

Returns true if task is enabled; otherwise returns false.


:ref:`Texture<api_Texture>`* PipelineTask::output (int index)

Returns by index a result of task as a render texture.


int PipelineTask::outputCount () const

Return the number of outputs.


std::string PipelineTask::outputName (int index) const

Returns by index a name of output.


void PipelineTask::resize (int width, int height)

A callback to react on screen width and height changed.


void PipelineTask::setEnabled (bool enable)

Sets task to enable or disable. The disabled effect will not be executed.

See also isEnabled().


void PipelineTask::setInput (int index, Texture * source)

Set a source texture with given index to use it in the render task.


void PipelineTask::setSettings (PostProcessSettings & settings)

A callback to react on chage of settings.