Wizt::GLProgram Class Reference

An OpenGL shading program. More...

#include </home/werner/origo/vish/ocean/GLvish/Shader.hpp>

List of all members.

Classes

• struct CannotAssignUniform

  Exception class if a uniform variable in a shader could not be assigned. More...
  

• struct Error
• struct LinkerError

  Exception that happens when there was a problem with linking compiled shader programs. More...
  

• struct NoSuchAttribute

  Exception thrown when a vertex attribute was not found. More...
  

• struct NoSuchUniform

  Exception thrown when a uniform variable was not found. More...
  

• struct NotSupportedCall

  Exception class if a GL call is not supported. More...
  

Public Member Functions

• override bool activate (const Anemone &)

  Anemone::Tentacle Implementation: use this shader.
  

• void attach (const Shader &Sh) const

  Attach a certain shader to this program.
  

• void bindFragData (GLuint colorNumber, const char *name) const
• override bool deactivate (const Anemone &)

  Anemone::Tentacle Implementation: disable use of shaders.
  

• override void enable (const std::string &ShaderVariable, const MemCore::RefPtr< RenderBasin::VertexAttribute > &Data)
• GLint getAttribID (const char *name) const

  Get the identifier of some attribute (uniform variable) as defined in the Program.
  

• GLint getAttribID (const string &name) const

  Get the identifier of some attribute variable as defined in the Program.
  

• GLuint getID () const

  Get the associated OpenGL ID.
  

• bool getUniformValuef (const char *name, float &value) const
• bool getUniformValuei (const char *name, GLint &value) const
• GLProgram ()

  Constructor.
  

• GLProgram (const string &vertex_code, const string &fragment_code)

  Construct a program with vertex and fragment shader code.
  

• std::string InfoLog () const

  Return verbose compilation info.
  

• bool isValid () const

  Validates that this program is ready to use.
  

• void link ()

  Link the program.
  

• bool setUniformTexture (const char *name, const TextureBase &TextureID) const
• bool setUniformValue (const char *name, const Eagle::PhysicalSpace::tvector &v) const
• bool setUniformValuef (const char *name, float value) const

  Set a variable in the program to a certain value.
  

• bool setUniformValuef (const char *name, float v1, float v2) const
• bool setUniformValuef (const char *name, float v1, float v2, float v3) const
• bool setUniformValuef (const char *name, float v1, float v2, float v3, float v4) const
• bool setUniformValuei (const char *name, GLint value) const
• void setUniformValuei (const char *name, GLint v0, GLint v1) const
• void setUniformValuei (const char *name, GLint v0, GLint v1, GLint v2) const
• void setUniformValuei (const char *name, GLint v0, GLint v1, GLint v2, GLint v3) const
• void setUniformValuei (const char *name, int Count, const GLint *values) const
• void SetupViewport () const

  Set a uniform variable int Viewport[4] in the program to contain the current OpenGL view port.
  

• void setVariables () const

  Setup the internally defined variables.
  

• std::pair< WeakPtr< GLProgram >
  , string > uniform (const char *name)

  Return some context on how to address a uniform variable in the shader.
  

• override void use () const

  Use the program.
  

• ~GLProgram ()

  Destructor.
  

Static Public Member Functions

• static void dont_use_any_shaders ()

  Disable the use of any shaders.
  

• static const char * UnprojectCode ()
• static const char * VarType (GLenum type)

  Tell the type of the given variable, as specified by the CannotAssignUniform exception.
  

Public Attributes

• RefPtr< FragmentShader > myFragmentShader
• RefPtr< GeometryShader > myGeometryShader
• RefPtr< VertexShader > myVertexShader
• bool SilentlyIgnoreUnknownUniforms

  If this boolean is set to true, then assignments to non existent uniform variables are silently ignored.
  

---

Detailed Description

An OpenGL shading program.

The value of a floating point slot may be directly assigned to a uniform shader variable:

   scaleFactor << Context > MyProgram;

An additional function may be applied during assignment:

   scaleFactor << Context > (MyProgram + pow10);

---

Constructor & Destructor Documentation

Wizt::GLProgram::GLProgram	(	const string &	vertex_code,
		const string &	fragment_code
	)

Construct a program with vertex and fragment shader code.

The specified vertex and fragment shader codes are compiled and linked immediatly.

The most trivial vertex shade is this:

void main(void)
{
        gl_Position = ftransform();
}

The most trivial fragment shader is this:

void main (void)
{
        gl_FragColor = gl_Color;
}

---

Member Function Documentation

void Wizt::GLProgram::bindFragData	(	GLuint	colorNumber,
		const char *	name
	)		const

Note:

Calls the following OpenGL routine: http://www.opengl.org/sdk/docs/man4/xhtml/glBindFragDataLocation.xml Should be called before link(), and after program creation.

GLint Wizt::GLProgram::getAttribID

(

const char *

name

)

const

Get the identifier of some attribute (uniform variable) as defined in the Program.

Attributes are values that are provided per vertex and declared in the Program using GSGL like in this following code fragment:

            attribute float value;

GLint Wizt::GLProgram::getAttribID

(

const string &

name

)

const [inline]

Get the identifier of some attribute variable as defined in the Program.

Attributes are values that are provided per vertex and declared in the Program using GSGL like in this following code fragment:

            attribute float value;

bool Wizt::GLProgram::isValid

(

)

const

Validates that this program is ready to use.

http://www.opengl.org/sdk/docs/man/xhtml/glValidateProgram.xml

bool Wizt::GLProgram::setUniformValuef	(	const char *	name,
		float	value
	)		const

Set a variable in the program to a certain value.

Parameters:

name	The variable as given in the program.

Returns:

false, if the certain name is not valid in the program.

void Wizt::GLProgram::setUniformValuei	(	const char *	name,
		GLint	v0,
		GLint	v1
	)		const

Note:

Calls the following OpenGL routines: http://www.opengl.org/sdk/docs/man/xhtml/glGetUniformLocation.xml http://www.opengl.org/sdk/docs/man/xhtml/glUniform.xml

std::pair< WeakPtr< GLProgram >, string > Wizt::GLProgram::uniform

(

const char *

name

)

Return some context on how to address a uniform variable in the shader.

Used for the >> operator.

---

Member Data Documentation

bool Wizt::GLProgram::SilentlyIgnoreUnknownUniforms

If this boolean is set to true, then assignments to non existent uniform variables are silently ignored.

Note that a shader program may well contain uniform variables in its source code, but they may vanish during optimized compilation. Setting this flag allows to still assign such removed variables. The default value is false.

---

The documentation for this class was generated from the following files:

• ocean/GLvish/Shader.hpp
• ocean/GLvish/Shader.cpp