ork::Program Class Reference
[render]

A GPU program. More...

#include <Program.h>

Inheritance diagram for ork::Program:
ork::Object

List of all members.

Public Member Functions

 Program (const vector< ptr< Module > > &modules)
 Creates a new program.
 Program (ptr< Module > module)
 Creates a new program.
virtual ~Program ()
 Deletes this program.
virtual int getId () const
 Returns the id of this program.
int getModuleCount () const
 Returns the number of Module objects in this program.
ptr< Module > getModule (int index) const
 Returns the Module of this program whose index is given.
ptr< Uniform > getUniform (const string &name)
 Returns the uniform of this program whose name is given.
ptr< Uniform1f > getUniform1f (const string &name)
 Returns the uniform1f of this program whose name is given.
ptr< Uniform1d > getUniform1d (const string &name)
 Returns the uniform1d of this program whose name is given.
ptr< Uniform1i > getUniform1i (const string &name)
 Returns the uniform1i of this program whose name is given.
ptr< Uniform1ui > getUniform1ui (const string &name)
 Returns the uniform1ui of this program whose name is given.
ptr< Uniform1b > getUniform1b (const string &name)
 Returns the uniform1b of this program whose name is given.
ptr< Uniform2f > getUniform2f (const string &name)
 Returns the uniform2f of this program whose name is given.
ptr< Uniform2d > getUniform2d (const string &name)
 Returns the uniform2d of this program whose name is given.
ptr< Uniform2i > getUniform2i (const string &name)
 Returns the uniform2i of this program whose name is given.
ptr< Uniform2ui > getUniform2ui (const string &name)
 Returns the uniform2ui of this program whose name is given.
ptr< Uniform2b > getUniform2b (const string &name)
 Returns the uniform2b of this program whose name is given.
ptr< Uniform3f > getUniform3f (const string &name)
 Returns the uniform3f of this program whose name is given.
ptr< Uniform3d > getUniform3d (const string &name)
 Returns the uniform3d of this program whose name is given.
ptr< Uniform3i > getUniform3i (const string &name)
 Returns the uniform3i of this program whose name is given.
ptr< Uniform3ui > getUniform3ui (const string &name)
 Returns the uniform3ui of this program whose name is given.
ptr< Uniform3b > getUniform3b (const string &name)
 Returns the uniform3b of this program whose name is given.
ptr< Uniform4f > getUniform4f (const string &name)
 Returns the uniform4f of this program whose name is given.
ptr< Uniform4d > getUniform4d (const string &name)
 Returns the uniform4d of this program whose name is given.
ptr< Uniform4i > getUniform4i (const string &name)
 Returns the uniform4i of this program whose name is given.
ptr< Uniform4ui > getUniform4ui (const string &name)
 Returns the uniform4ui of this program whose name is given.
ptr< Uniform4b > getUniform4b (const string &name)
 Returns the uniform4b of this program whose name is given.
ptr< UniformMatrix2f > getUniformMatrix2f (const string &name)
 Returns the uniformMatrix2f of this program whose name is given.
ptr< UniformMatrix2d > getUniformMatrix2d (const string &name)
 Returns the uniformMatrix2d of this program whose name is given.
ptr< UniformMatrix3f > getUniformMatrix3f (const string &name)
 Returns the uniformMatrix3f of this program whose name is given.
ptr< UniformMatrix3d > getUniformMatrix3d (const string &name)
 Returns the uniformMatrix3d of this program whose name is given.
ptr< UniformMatrix4f > getUniformMatrix4f (const string &name)
 Returns the uniformMatrix4f of this program whose name is given.
ptr< UniformMatrix4d > getUniformMatrix4d (const string &name)
 Returns the uniformMatrix4d of this program whose name is given.
ptr< UniformMatrix2x3f > getUniformMatrix2x3f (const string &name)
 Returns the uniformMatrix2x3f of this program whose name is given.
ptr< UniformMatrix2x3d > getUniformMatrix2x3d (const string &name)
 Returns the uniformMatrix2x3d of this program whose name is given.
ptr< UniformMatrix2x4f > getUniformMatrix2x4f (const string &name)
 Returns the uniformMatrix2x4f of this program whose name is given.
ptr< UniformMatrix2x4d > getUniformMatrix2x4d (const string &name)
 Returns the uniformMatrix2x4d of this program whose name is given.
ptr< UniformMatrix3x2f > getUniformMatrix3x2f (const string &name)
 Returns the uniformMatrix3x2f of this program whose name is given.
ptr< UniformMatrix3x2d > getUniformMatrix3x2d (const string &name)
 Returns the uniformMatrix3x2d of this program whose name is given.
ptr< UniformMatrix3x4f > getUniformMatrix3x4f (const string &name)
 Returns the uniformMatrix3x4f of this program whose name is given.
ptr< UniformMatrix3x4d > getUniformMatrix3x4d (const string &name)
 Returns the uniformMatrix3x4d of this program whose name is given.
ptr< UniformMatrix4x2f > getUniformMatrix4x2f (const string &name)
 Returns the uniformMatrix4x2f of this program whose name is given.
ptr< UniformMatrix4x2d > getUniformMatrix4x2d (const string &name)
 Returns the uniformMatrix4x2d of this program whose name is given.
ptr< UniformMatrix4x3f > getUniformMatrix4x3f (const string &name)
 Returns the uniformMatrix4x3f of this program whose name is given.
ptr< UniformMatrix4x3d > getUniformMatrix4x3d (const string &name)
 Returns the uniformMatrix4x2d of this program whose name is given.
ptr< UniformSampler > getUniformSampler (const string &name)
 Returns the uniform sampler of this program whose name is given.
ptr< UniformBlock > getUniformBlock (const string &name)
 Returns the uniform block of this program whose name is given.

Protected Member Functions

 Program ()
 Creates an unitialized program.
void init (const vector< ptr< Module > > &modules)
 Initializes this program.
virtual void swap (ptr< Program > t)
 Swaps this program with the given one.

Protected Attributes

vector< ptr< Module > > modules
 The modules of this program.

Detailed Description

A GPU program.

A GPU program can define vertex, tessellation, geometry and fragment programs. It is made of one or more Module, themselves made of one or more GLSL shaders.

Constructor & Destructor Documentation

ork::Program::Program ( const vector< ptr< Module > > &  modules  ) 

Creates a new program.

Parameters:
modules the modules that will compose this program.
ork::Program::Program ( ptr< Module >  module  ) 

Creates a new program.

Parameters:
module the single module that will compose this program.
virtual ork::Program::~Program (  )  [virtual]

Deletes this program.

ork::Program::Program (  )  [protected]

Creates an unitialized program.

Member Function Documentation

virtual int ork::Program::getId (  )  const [virtual]

Returns the id of this program.

ptr<Module> ork::Program::getModule ( int  index  )  const

Returns the Module of this program whose index is given.

int ork::Program::getModuleCount (  )  const

Returns the number of Module objects in this program.

ptr<Uniform> ork::Program::getUniform ( const string &  name  ) 

Returns the uniform of this program whose name is given.

Parameters:
name a GLSL uniform name.
Returns:
the uniform of this program whose name is given, or NULL if there is no such uniform.
ptr< Uniform1b > ork::Program::getUniform1b ( const string &  name  )  [inline]

Returns the uniform1b of this program whose name is given.

Parameters:
name a GLSL uniform name.
Returns:
the uniform of this program whose name is given, or NULL if there is no such uniform.
ptr< Uniform1d > ork::Program::getUniform1d ( const string &  name  )  [inline]

Returns the uniform1d of this program whose name is given.

Parameters:
name a GLSL uniform name.
Returns:
the uniform of this program whose name is given, or NULL if there is no such uniform.
ptr< Uniform1f > ork::Program::getUniform1f ( const string &  name  )  [inline]

Returns the uniform1f of this program whose name is given.

Parameters:
name a GLSL uniform name.
Returns:
the uniform of this program whose name is given, or NULL if there is no such uniform.
ptr< Uniform1i > ork::Program::getUniform1i ( const string &  name  )  [inline]

Returns the uniform1i of this program whose name is given.

Parameters:
name a GLSL uniform name.
Returns:
the uniform of this program whose name is given, or NULL if there is no such uniform.
ptr< Uniform1ui > ork::Program::getUniform1ui ( const string &  name  )  [inline]

Returns the uniform1ui of this program whose name is given.

Parameters:
name a GLSL uniform name.
Returns:
the uniform of this program whose name is given, or NULL if there is no such uniform.
ptr< Uniform2b > ork::Program::getUniform2b ( const string &  name  )  [inline]

Returns the uniform2b of this program whose name is given.

Parameters:
name a GLSL uniform name.
Returns:
the uniform of this program whose name is given, or NULL if there is no such uniform.
ptr< Uniform2d > ork::Program::getUniform2d ( const string &  name  )  [inline]

Returns the uniform2d of this program whose name is given.

Parameters:
name a GLSL uniform name.
Returns:
the uniform of this program whose name is given, or NULL if there is no such uniform.
ptr< Uniform2f > ork::Program::getUniform2f ( const string &  name  )  [inline]

Returns the uniform2f of this program whose name is given.

Parameters:
name a GLSL uniform name.
Returns:
the uniform of this program whose name is given, or NULL if there is no such uniform.
ptr< Uniform2i > ork::Program::getUniform2i ( const string &  name  )  [inline]

Returns the uniform2i of this program whose name is given.

Parameters:
name a GLSL uniform name.
Returns:
the uniform of this program whose name is given, or NULL if there is no such uniform.
ptr< Uniform2ui > ork::Program::getUniform2ui ( const string &  name  )  [inline]

Returns the uniform2ui of this program whose name is given.

Parameters:
name a GLSL uniform name.
Returns:
the uniform of this program whose name is given, or NULL if there is no such uniform.
ptr< Uniform3b > ork::Program::getUniform3b ( const string &  name  )  [inline]

Returns the uniform3b of this program whose name is given.

Parameters:
name a GLSL uniform name.
Returns:
the uniform of this program whose name is given, or NULL if there is no such uniform.
ptr< Uniform3d > ork::Program::getUniform3d ( const string &  name  )  [inline]

Returns the uniform3d of this program whose name is given.

Parameters:
name a GLSL uniform name.
Returns:
the uniform of this program whose name is given, or NULL if there is no such uniform.
ptr< Uniform3f > ork::Program::getUniform3f ( const string &  name  )  [inline]

Returns the uniform3f of this program whose name is given.

Parameters:
name a GLSL uniform name.
Returns:
the uniform of this program whose name is given, or NULL if there is no such uniform.
ptr< Uniform3i > ork::Program::getUniform3i ( const string &  name  )  [inline]

Returns the uniform3i of this program whose name is given.

Parameters:
name a GLSL uniform name.
Returns:
the uniform of this program whose name is given, or NULL if there is no such uniform.
ptr< Uniform3ui > ork::Program::getUniform3ui ( const string &  name  )  [inline]

Returns the uniform3ui of this program whose name is given.

Parameters:
name a GLSL uniform name.
Returns:
the uniform of this program whose name is given, or NULL if there is no such uniform.
ptr< Uniform4b > ork::Program::getUniform4b ( const string &  name  )  [inline]

Returns the uniform4b of this program whose name is given.

Parameters:
name a GLSL uniform name.
Returns:
the uniform of this program whose name is given, or NULL if there is no such uniform.
ptr< Uniform4d > ork::Program::getUniform4d ( const string &  name  )  [inline]

Returns the uniform4d of this program whose name is given.

Parameters:
name a GLSL uniform name.
Returns:
the uniform of this program whose name is given, or NULL if there is no such uniform.
ptr< Uniform4f > ork::Program::getUniform4f ( const string &  name  )  [inline]

Returns the uniform4f of this program whose name is given.

Parameters:
name a GLSL uniform name.
Returns:
the uniform of this program whose name is given, or NULL if there is no such uniform.
ptr< Uniform4i > ork::Program::getUniform4i ( const string &  name  )  [inline]

Returns the uniform4i of this program whose name is given.

Parameters:
name a GLSL uniform name.
Returns:
the uniform of this program whose name is given, or NULL if there is no such uniform.
ptr< Uniform4ui > ork::Program::getUniform4ui ( const string &  name  )  [inline]

Returns the uniform4ui of this program whose name is given.

Parameters:
name a GLSL uniform name.
Returns:
the uniform of this program whose name is given, or NULL if there is no such uniform.
ptr<UniformBlock> ork::Program::getUniformBlock ( const string &  name  ) 

Returns the uniform block of this program whose name is given.

Parameters:
name a GLSL uniform block name.
Returns:
the uniform block of this program whose name is given, or NULL if there is no such uniform.
ptr< UniformMatrix2d > ork::Program::getUniformMatrix2d ( const string &  name  )  [inline]

Returns the uniformMatrix2d of this program whose name is given.

Parameters:
name a GLSL uniform name.
Returns:
the uniform of this program whose name is given, or NULL if there is no such uniform.
ptr< UniformMatrix2f > ork::Program::getUniformMatrix2f ( const string &  name  )  [inline]

Returns the uniformMatrix2f of this program whose name is given.

Parameters:
name a GLSL uniform name.
Returns:
the uniform of this program whose name is given, or NULL if there is no such uniform.
ptr< UniformMatrix2x3d > ork::Program::getUniformMatrix2x3d ( const string &  name  )  [inline]

Returns the uniformMatrix2x3d of this program whose name is given.

Parameters:
name a GLSL uniform name.
Returns:
the uniform of this program whose name is given, or NULL if there is no such uniform.
ptr< UniformMatrix2x3f > ork::Program::getUniformMatrix2x3f ( const string &  name  )  [inline]

Returns the uniformMatrix2x3f of this program whose name is given.

Parameters:
name a GLSL uniform name.
Returns:
the uniform of this program whose name is given, or NULL if there is no such uniform.
ptr< UniformMatrix2x4d > ork::Program::getUniformMatrix2x4d ( const string &  name  )  [inline]

Returns the uniformMatrix2x4d of this program whose name is given.

Parameters:
name a GLSL uniform name.
Returns:
the uniform of this program whose name is given, or NULL if there is no such uniform.
ptr< UniformMatrix2x4f > ork::Program::getUniformMatrix2x4f ( const string &  name  )  [inline]

Returns the uniformMatrix2x4f of this program whose name is given.

Parameters:
name a GLSL uniform name.
Returns:
the uniform of this program whose name is given, or NULL if there is no such uniform.
ptr< UniformMatrix3d > ork::Program::getUniformMatrix3d ( const string &  name  )  [inline]

Returns the uniformMatrix3d of this program whose name is given.

Parameters:
name a GLSL uniform name.
Returns:
the uniform of this program whose name is given, or NULL if there is no such uniform.
ptr< UniformMatrix3f > ork::Program::getUniformMatrix3f ( const string &  name  )  [inline]

Returns the uniformMatrix3f of this program whose name is given.

Parameters:
name a GLSL uniform name.
Returns:
the uniform of this program whose name is given, or NULL if there is no such uniform.
ptr< UniformMatrix3x2d > ork::Program::getUniformMatrix3x2d ( const string &  name  )  [inline]

Returns the uniformMatrix3x2d of this program whose name is given.

Parameters:
name a GLSL uniform name.
Returns:
the uniform of this program whose name is given, or NULL if there is no such uniform.
ptr< UniformMatrix3x2f > ork::Program::getUniformMatrix3x2f ( const string &  name  )  [inline]

Returns the uniformMatrix3x2f of this program whose name is given.

Parameters:
name a GLSL uniform name.
Returns:
the uniform of this program whose name is given, or NULL if there is no such uniform.
ptr< UniformMatrix3x4d > ork::Program::getUniformMatrix3x4d ( const string &  name  )  [inline]

Returns the uniformMatrix3x4d of this program whose name is given.

Parameters:
name a GLSL uniform name.
Returns:
the uniform of this program whose name is given, or NULL if there is no such uniform.
ptr< UniformMatrix3x4f > ork::Program::getUniformMatrix3x4f ( const string &  name  )  [inline]

Returns the uniformMatrix3x4f of this program whose name is given.

Parameters:
name a GLSL uniform name.
Returns:
the uniform of this program whose name is given, or NULL if there is no such uniform.
ptr< UniformMatrix4d > ork::Program::getUniformMatrix4d ( const string &  name  )  [inline]

Returns the uniformMatrix4d of this program whose name is given.

Parameters:
name a GLSL uniform name.
Returns:
the uniform of this program whose name is given, or NULL if there is no such uniform.
ptr< UniformMatrix4f > ork::Program::getUniformMatrix4f ( const string &  name  )  [inline]

Returns the uniformMatrix4f of this program whose name is given.

Parameters:
name a GLSL uniform name.
Returns:
the uniform of this program whose name is given, or NULL if there is no such uniform.
ptr< UniformMatrix4x2d > ork::Program::getUniformMatrix4x2d ( const string &  name  )  [inline]

Returns the uniformMatrix4x2d of this program whose name is given.

Parameters:
name a GLSL uniform name.
Returns:
the uniform of this program whose name is given, or NULL if there is no such uniform.
ptr< UniformMatrix4x2f > ork::Program::getUniformMatrix4x2f ( const string &  name  )  [inline]

Returns the uniformMatrix4x2f of this program whose name is given.

Parameters:
name a GLSL uniform name.
Returns:
the uniform of this program whose name is given, or NULL if there is no such uniform.
ptr< UniformMatrix4x3d > ork::Program::getUniformMatrix4x3d ( const string &  name  )  [inline]

Returns the uniformMatrix4x2d of this program whose name is given.

Parameters:
name a GLSL uniform name.
Returns:
the uniform of this program whose name is given, or NULL if there is no such uniform.
ptr< UniformMatrix4x3f > ork::Program::getUniformMatrix4x3f ( const string &  name  )  [inline]

Returns the uniformMatrix4x3f of this program whose name is given.

Parameters:
name a GLSL uniform name.
Returns:
the uniform of this program whose name is given, or NULL if there is no such uniform.
ptr< UniformSampler > ork::Program::getUniformSampler ( const string &  name  )  [inline]

Returns the uniform sampler of this program whose name is given.

Parameters:
name a GLSL uniform name.
Returns:
the uniform of this program whose name is given, or NULL if there is no such uniform.
void ork::Program::init ( const vector< ptr< Module > > &  modules  )  [protected]

Initializes this program.

Parameters:
modules the modules that will compose this program.
virtual void ork::Program::swap ( ptr< Program >  t  )  [protected, virtual]

Swaps this program with the given one.

Member Data Documentation

vector< ptr<Module> > ork::Program::modules [protected]

The modules of this program.

Generated on Mon Oct 18 09:36:09 2010 for ork by  doxygen 1.6.1