GpuProgramDescriptor Class Reference

This class describes a GPU program including I/O parameters. More...

#include <GpuProgramDescriptor.h>

List of all members.

Public Types
enum	GpuProgramTypeEnum { VERTEX_PROGRAM, FRAGMENT_PROGRAM }
typedef EnumWrapper < GpuProgramTypeEnum >	GpuProgramType
Public Member Functions
virtual void	setName (const std::string &name)=0
virtual const std::string &	getName () const =0
virtual void	setType (GpuProgramType type)=0
virtual GpuProgramType	getType () const =0
virtual bool	removeParameter (const std::string &name)=0
virtual bool	setParameter (const std::string &name, const DataVariant &value)=0
virtual const DynamicObject *	getParameters () const =0
virtual const DataVariant &	getParameter (const std::string &name) const =0
virtual GpuProgramDescriptor *	copy () const =0
Protected Member Functions
virtual	~GpuProgramDescriptor ()

---

Detailed Description

This class describes a GPU program including I/O parameters.

Definition at line 23 of file GpuProgramDescriptor.h.

---

Member Typedef Documentation

typedef EnumWrapper<GpuProgramTypeEnum> GpuProgramDescriptor::GpuProgramType

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

Definition at line 38 of file GpuProgramDescriptor.h.

---

Member Enumeration Documentation

enum GpuProgramDescriptor::GpuProgramTypeEnum

This type specifies the GPU shader type.

Enumerator:

VERTEX_PROGRAM	The program should run on the GPU's vertex processor.
FRAGMENT_PROGRAM	The program should run on the GPU's fragment processor.

Definition at line 29 of file GpuProgramDescriptor.h.

---

Constructor & Destructor Documentation

virtual GpuProgramDescriptor::~GpuProgramDescriptor

(

)

[protected, virtual]

This is automatically destroyed by the application.

Definition at line 123 of file GpuProgramDescriptor.h.

---

Member Function Documentation

virtual void GpuProgramDescriptor::setName

(

const std::string &

name

)

[pure virtual]

Mutate the name of this GPU program.

Parameters:

name

The new name

virtual const std::string& GpuProgramDescriptor::getName

(

)

const [pure virtual]

Access the name of this GPU program.

Returns:

The name

virtual void GpuProgramDescriptor::setType

(

GpuProgramType

type

)

[pure virtual]

Mutate the type of this GPU program.

Parameters:

type

The new type

virtual GpuProgramType GpuProgramDescriptor::getType

(

)

const [pure virtual]

Access the type of this GPU program.

Returns:

The type

virtual bool GpuProgramDescriptor::removeParameter

(

const std::string &

name

)

[pure virtual]

Remove a parameter from this GPU program's parameter specification.

Parameters:

name

The name of the parameter to remove

Returns:

True if successful, false if the parameter does not exist

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

Set the value of a parameter in this GPU program's parameter specification.

Parameters:

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

Returns:

True if the parameter's value was set, false if the parameter does not exist

virtual const DynamicObject* GpuProgramDescriptor::getParameters

(

)

const [pure virtual]

Get all the parameters and values in this GPU program's parameter specification.

Returns:

A DynamicObject containing the parameter names and values

virtual const DataVariant& GpuProgramDescriptor::getParameter

(

const std::string &

name

)

const [pure virtual]

Get the value of a parameter in this GPU program'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 GpuProgramDescriptor* GpuProgramDescriptor::copy

(

)

const [pure virtual]

Create a cloned copy of this GpuProgramDescriptor.

Returns:

A copy of this GpuProgramDescriptor or NULL if there was an error creating the copy.