ImageFilterDescriptor Class Reference

Provides information on image filter. More...

#include <ImageFilterDescriptor.h>

List of all members.

Public Types
enum	ImageProcessTypeEnum { GPU_PROCESS, IMAGE_FILTER, FEEDBACK_FILTER }
typedef EnumWrapper < ImageProcessTypeEnum >	ImageProcessType
Public Member Functions
virtual const std::string &	getName () const =0
virtual const std::string &	getDescription () const =0
virtual ImageProcessType	getType () const =0
virtual bool	hasGpuProgram (const GpuProgramDescriptor &gpuDescriptor) const =0
virtual const std::vector < GpuProgramDescriptor * > &	getGpuPrograms () const =0
virtual bool	setParameter (const std::string &name, const DataVariant &value)=0
virtual const DataVariant &	getParameter (const std::string &name) const =0
virtual const DynamicObject *	getParameters () const =0
virtual bool	removeParameter (const std::string &name)=0
Protected Member Functions
virtual	~ImageFilterDescriptor ()

---

Detailed Description

Provides information on image filter.

This class provides information on a specific image filter, which is implemented via Graphical Processor Unit (GPU) programs. It provides the name, description, GPU programs, and parameters for the image filter.

Definition at line 31 of file ImageFilterDescriptor.h.

---

Member Typedef Documentation

typedef EnumWrapper<ImageProcessTypeEnum> ImageFilterDescriptor::ImageProcessType

The EnumWrapper contains a given enum value and provides a isValid() method which returns true if the contained enum value is valid.

Please see How To Use EnumWrapper for more information. The wrapped enum values are ImageProcessTypeEnum.

Definition at line 47 of file ImageFilterDescriptor.h.

---

Member Enumeration Documentation

enum ImageFilterDescriptor::ImageProcessTypeEnum

This type specifies how the shader program will be treated by the application.

Enumerator:

GPU_PROCESS	Generic process running on Gpu.
IMAGE_FILTER	Image filter process running on Gpu.
FEEDBACK_FILTER	Recursive filter process running on Gpu.

Definition at line 37 of file ImageFilterDescriptor.h.

---

Constructor & Destructor Documentation

virtual ImageFilterDescriptor::~ImageFilterDescriptor

(

)

[protected, virtual]

This is automatically destroyed by the application.

Definition at line 139 of file ImageFilterDescriptor.h.

---

Member Function Documentation

virtual const std::string& ImageFilterDescriptor::getName

(

)

const [pure virtual]

Gets the name of the image filter.

Returns:

Name of the image filter.

virtual const std::string& ImageFilterDescriptor::getDescription

(

)

const [pure virtual]

Gets the description of the image filter.

Returns:

Description of the image filter.

virtual ImageProcessType ImageFilterDescriptor::getType

(

)

const [pure virtual]

Gets the type of the image filter.

Returns:

Type of the image filter.

virtual bool ImageFilterDescriptor::hasGpuProgram

(

const GpuProgramDescriptor &

gpuDescriptor

)

const [pure virtual]

Queries for one of the image filter's GPU programs in the list.

Parameters:

gpuDescriptor

GPU Program descriptor.

Returns:

True if GPU program is in image filter descriptor list, otherwise false.

See also:

addGpuProgram()

virtual const std::vector<GpuProgramDescriptor*>& ImageFilterDescriptor::getGpuPrograms

(

)

const [pure virtual]

Gets the image filter's GPU programs list.

Returns:

The image filter's GPU programs.

virtual bool ImageFilterDescriptor::setParameter	(	const std::string &	name,
		const DataVariant &	value
	)			[pure virtual]

Sets the value of a parameter in this filter's parameter specification.

Parameters:

	name	The name of the parameter to set.
	value	The new value of the parameter.

Returns:

Returns true if the parameter's value was set or false if the parameter does not exist.

virtual const DataVariant& ImageFilterDescriptor::getParameter

(

const std::string &

name

)

const [pure virtual]

Gets the value of a parameter in this filter's parameter specification.

Parameters:

name

The name of the parameter to get.

Returns:

The value of the parameter. If the parameter does not exist, this will be an invalid DataVariant.

virtual const DynamicObject* ImageFilterDescriptor::getParameters

(

)

const [pure virtual]

Gets all the parameters and values in this filter's parameter specification.

Returns:

A DynamicObject containing the parameter names and values.

virtual bool ImageFilterDescriptor::removeParameter

(

const std::string &

name

)

[pure virtual]

Removes a parameter from this filter's parameter specification.

Parameters:

name

The name of the parameter to remove.

Returns:

Returns true if successful or false if the parameter does not exist.