GLSL Program. More...

#include <vtkShaderProgram2.h>

Inheritance diagram for vtkShaderProgram2:

Collaboration diagram for vtkShaderProgram2:

Public Types
typedef vtkObject	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkShaderProgram2 *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
bool	HasVertexShaders ()
bool	HasTessellationControlShaders ()
bool	HasTessellationEvaluationShaders ()
bool	HasGeometryShaders ()
bool	HasFragmentShaders ()
bool	IsValid ()
void	Build ()
void	SendUniforms ()
void	PrintActiveUniformVariablesOnCout ()
bool	IsUsed ()
void	Use ()
void	Restore ()
void	RestoreFixedPipeline ()
int	GetLastBuildStatus ()
const char *	GetLastLinkLog ()
const char *	GetLastValidateLog ()
virtual void	ReleaseGraphicsResources ()
int	GetAttributeLocation (const char *name)
bool	DisplayListUnderCreationInCompileMode ()

virtual bool	GetPrintErrors ()
virtual void	SetPrintErrors (bool)

void	SetContext (vtkOpenGLRenderWindow *context)
virtual vtkOpenGLRenderWindow *	GetContext ()

virtual vtkShader2Collection *	GetShaders ()

void	PrintActiveUniformVariables (ostream &os, vtkIndent indent)

virtual vtkUniformVariables *	GetUniformVariables ()
virtual void	SetUniformVariables (vtkUniformVariables *variables)

virtual void	SetGeometryTypeIn (int)
virtual int	GetGeometryTypeIn ()

virtual void	SetGeometryVerticesOut (int)
virtual int	GetGeometryVerticesOut ()

virtual void	SetGeometryTypeOut (int)
virtual int	GetGeometryTypeOut ()
Static Public Member Functions
static vtkShaderProgram2 *	New ()
static int	IsTypeOf (const char *type)
static vtkShaderProgram2 *	SafeDownCast (vtkObjectBase *o)

static bool	IsSupported (vtkOpenGLRenderWindow *context)
static bool	LoadExtensions (vtkOpenGLRenderWindow *context)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkShaderProgram2 ()
virtual	~vtkShaderProgram2 ()
Protected Attributes
unsigned int	Id
unsigned int	SavedId
vtkTimeStamp	LastLinkTime
vtkTimeStamp	LastSendUniformsTime
vtkShaderProgram2Uniforms *	Uniforms
vtkShader2Collection *	Shaders
int	LastBuildStatus
char *	LastLinkLog
size_t	LastLinkLogCapacity
char *	LastValidateLog
size_t	LastValidateLogCapacity
vtkUniformVariables *	UniformVariables
bool	PrintErrors
vtkOpenGLRenderWindow *	Context
bool	ExtensionsLoaded
int	GeometryTypeIn
int	GeometryTypeOut
int	GeometryVerticesOut

Detailed Description

GLSL Program.

vtkShaderProgram2 represents an implementation of the programmable OpenGL pipeline. It consists of a list of vtkShader2 object. Each vtkShader2 is a piece of source code associated with one of the shader units (vertex, fragment, geometry).

Tests:: vtkShaderProgram2 (Tests)

Definition at line 68 of file vtkShaderProgram2.h.

Member Typedef Documentation

typedef vtkObject vtkShaderProgram2::Superclass

Reimplemented from vtkObject.

Definition at line 72 of file vtkShaderProgram2.h.

Constructor & Destructor Documentation

vtkShaderProgram2::vtkShaderProgram2 ( ) [protected]

virtual vtkShaderProgram2::~vtkShaderProgram2 ( ) [protected, virtual]

Member Function Documentation

static vtkShaderProgram2* vtkShaderProgram2::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

static int vtkShaderProgram2::IsTypeOf ( const char * name ) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

virtual int vtkShaderProgram2::IsA ( const char * name ) [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

static vtkShaderProgram2* vtkShaderProgram2::SafeDownCast ( vtkObjectBase * o ) [static]

Reimplemented from vtkObject.

virtual vtkObjectBase* vtkShaderProgram2::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkObject.

vtkShaderProgram2* vtkShaderProgram2::NewInstance ( ) const

Reimplemented from vtkObject.

void vtkShaderProgram2::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		`[virtual]`

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

static bool vtkShaderProgram2::IsSupported ( vtkOpenGLRenderWindow * context ) [static]

Returns if the context supports the required extensions.

static bool vtkShaderProgram2::LoadExtensions ( vtkOpenGLRenderWindow * context ) [static]

Returns if the context supports the required extensions.

virtual bool vtkShaderProgram2::GetPrintErrors ( ) [virtual]

Tell if vtkErrorMacro should be called when there is a build error or not. It is useful to switch it to false when building a shader is a way to test if some OpenGL implementation support it or not. Initial value is true. Build errors are always reported in the status flags and log whatever is the value of PrintErrors flag.

virtual void vtkShaderProgram2::SetPrintErrors ( bool ) [virtual]

Tell if vtkErrorMacro should be called when there is a build error or not. It is useful to switch it to false when building a shader is a way to test if some OpenGL implementation support it or not. Initial value is true. Build errors are always reported in the status flags and log whatever is the value of PrintErrors flag.

void vtkShaderProgram2::SetContext ( vtkOpenGLRenderWindow * context )

Get/Set the context. This does not increase the reference count of the context to avoid reference loops. SetContext() may raise an error is the OpenGL context does not support the required OpenGL extensions.

virtual vtkOpenGLRenderWindow* vtkShaderProgram2::GetContext ( ) [virtual]

Get/Set the context. This does not increase the reference count of the context to avoid reference loops. SetContext() may raise an error is the OpenGL context does not support the required OpenGL extensions.

virtual vtkShader2Collection* vtkShaderProgram2::GetShaders ( ) [virtual]

The list of shaders. Initially, the list is empty.

Postcondition:: result_exists: result!=0

bool vtkShaderProgram2::HasVertexShaders ( )

Tells if at least one of the shaders is a vertex shader. If yes, it means the vertex processing of the fixed-pipeline is bypassed. If no, it means the vertex processing of the fixed-pipeline is used.

bool vtkShaderProgram2::HasTessellationControlShaders ( )

Tells if at least one of the shaders is a tessellation control shader.

bool vtkShaderProgram2::HasTessellationEvaluationShaders ( )

Tells if at least one of the shaders is a tessellation evaluation shader.

bool vtkShaderProgram2::HasGeometryShaders ( )

Tells if at least one of the shaders is a geometry shader.

bool vtkShaderProgram2::HasFragmentShaders ( )

Tells if at least one of the shaders is a fragment shader. If yes, it means the fragment processing of the fixed-pipeline is bypassed. If no, it means the fragment processing of the fixed-pipeline is used.

bool vtkShaderProgram2::IsValid ( )

Tell if the shader program is valid with the current OpenGL state.

Precondition:: context_is_set: this->GetContext()!=0; current_context_matches: this->Context()->IsCurrent(); built this->GetLastBuildStatus()==VTK_SHADER_PROGRAM2_LINK_SUCCEEDED

void vtkShaderProgram2::Build ( )

If not done yet, compile all the shaders and link the program. The status of the build can then be query with GetLastBuildStatus() and GetLastLinkLog().

Precondition:: context_is_set: this->GetContext()!=0; current_context_matches: this->GetContext()->IsCurrent()

void vtkShaderProgram2::SendUniforms ( )

Send the uniform variables values to the program.

Precondition:: context_is_set: this->GetContext()!=0; current_context_matches: this->GetContext()->IsCurrent(); built this->GetLastBuildStatus()==VTK_SHADER_PROGRAM2_LINK_SUCCEEDED

void vtkShaderProgram2::PrintActiveUniformVariables	(	ostream &	os,
		vtkIndent	indent
	)

Introspection. Return the list of active uniform variables of the program.

Precondition:: context_is_set: this->GetContext()!=0; current_context_matches: this->Context()->IsCurrent(); built this->GetLastBuildStatus()==VTK_SHADER_PROGRAM2_LINK_SUCCEEDED

void vtkShaderProgram2::PrintActiveUniformVariablesOnCout ( )

Call PrintActiveUniformVariables on cout. Useful for calling inside gdb.

Precondition:: context_is_set: this->GetContext()!=0; current_context_matches: this->Context()->IsCurrent(); built this->GetLastBuildStatus()==VTK_SHADER_PROGRAM2_LINK_SUCCEEDED

bool vtkShaderProgram2::IsUsed ( )

Tell if the program is the one currently used by OpenGL.

Precondition:: context_is_set: this->GetContext()!=0; current_context_matches: this->GetContext()->IsCurrent()

void vtkShaderProgram2::Use ( )

Use the shader program. It saves the current shader program or fixed-pipeline in use. It also set the uniform variables.

Precondition:: context_is_set: this->GetContext()!=0; current_context_matches: this->GetContext()->IsCurrent()

void vtkShaderProgram2::Restore ( )

Restore the previous shader program (or fixed-pipeline).

Precondition:: context_is_set: this->GetContext()!=0; current_context_matches: this->GetContext()->IsCurrent()

void vtkShaderProgram2::RestoreFixedPipeline ( )

Force the current shader program to be the fixed-pipeline. Warning: this call will be compiled if called inside a display list creation.

Precondition:: context_is_set: this->GetContext()!=0; current_context_matches: this->GetContext()->IsCurrent()

int vtkShaderProgram2::GetLastBuildStatus ( )

Tells if the last build: failed during compilation of one of the shader, fails during link of the program or succeeded to link the program. Initial value is VTK_SHADER_PROGRAM2_COMPILE_FAILED.

Postcondition:: valid_value: result== VTK_SHADER_PROGRAM2_COMPILE_FAILED || result==VTK_SHADER_PROGRAM2_LINK_FAILED || result==VTK_SHADER_PROGRAM2_LINK_SUCCEEDED

const char* vtkShaderProgram2::GetLastLinkLog ( )

Return the log of the last link as a string. Initial value is the empty string ""='\0'.

Postcondition:: result_exists: result!=0

const char* vtkShaderProgram2::GetLastValidateLog ( )

Return the log of the last call to IsValid as a string. Initial value is the empty string ""='\0'.

Postcondition:: result_exists: result!=0

virtual void vtkShaderProgram2::ReleaseGraphicsResources ( ) [virtual]

Release OpenGL resource (program id and sub-resources).

int vtkShaderProgram2::GetAttributeLocation ( const char * name )

Returns the generic attribute location. The shader must be bound before calling this.

Precondition:: context_is_set: this->GetContext()!=0; current_context_matches: this->GetContext()->IsCurrent(); name_exists: name!=0; built: this->GetLastBuildStatus()==VTK_SHADER_PROGRAM2_LINK_SUCCEEDED

virtual vtkUniformVariables* vtkShaderProgram2::GetUniformVariables ( ) [virtual]

Get/Set the list of uniform variables values. Initial value is an empty list (not null pointer).

virtual void vtkShaderProgram2::SetUniformVariables ( vtkUniformVariables * variables ) [virtual]

Get/Set the list of uniform variables values. Initial value is an empty list (not null pointer).

bool vtkShaderProgram2::DisplayListUnderCreationInCompileMode ( )

Tells if a display list is under construction with GL_COMPILE mode. Return false if there is no display list under construction of if the mode is GL_COMPILE_AND_EXECUTE. Used internally and provided as a public method for whoever find it useful.

Precondition:: context_is_set: this->GetContext()!=0; current_context_matches: this->GetContext()->IsCurrent()

virtual void vtkShaderProgram2::SetGeometryTypeIn ( int ) [virtual]

Specific to the geometry shader part of the program. Relevant only when HasGeometryShaders() is true. From OpenGL 3.2, it is replaced by an input layout qualifier in GLSL 1.50. The input primitive type on which the geometry shader operate. It can be VTK_GEOMETRY_SHADER_IN_TYPE_POINTS, VTK_GEOMETRY_SHADER_IN_TYPE_LINES, VTK_GEOMETRY_SHADER_IN_TYPE_LINES_ADJACENCY, VTK_GEOMETRY_SHADER_IN_TYPE_TRIANGLES or VTK_GEOMETRY_SHADER_IN_TYPE_TRIANGLES_ADJACENCY Initial value is VTK_GEOMETRY_SHADER_IN_TYPE_POINTS.

virtual int vtkShaderProgram2::GetGeometryTypeIn ( ) [virtual]

Specific to the geometry shader part of the program. Relevant only when HasGeometryShaders() is true. From OpenGL 3.2, it is replaced by an input layout qualifier in GLSL 1.50. The input primitive type on which the geometry shader operate. It can be VTK_GEOMETRY_SHADER_IN_TYPE_POINTS, VTK_GEOMETRY_SHADER_IN_TYPE_LINES, VTK_GEOMETRY_SHADER_IN_TYPE_LINES_ADJACENCY, VTK_GEOMETRY_SHADER_IN_TYPE_TRIANGLES or VTK_GEOMETRY_SHADER_IN_TYPE_TRIANGLES_ADJACENCY Initial value is VTK_GEOMETRY_SHADER_IN_TYPE_POINTS.

virtual void vtkShaderProgram2::SetGeometryVerticesOut ( int ) [virtual]

Specific to the geometry shader part of the program. Relevant only when HasGeometryShaders() is true. This is a pre OpenGL 3.2 geometry shader setting. From OpenGL 3.2, it is replaced by an output layout qualifier in GLSL 1.50. The maximum number of vertices the geometry shader will emit in one invocation. If a geometry shader, in one invocation, emits more vertices than this value, these emits may have no effect. Initial value is 1.

virtual int vtkShaderProgram2::GetGeometryVerticesOut ( ) [virtual]

Specific to the geometry shader part of the program. Relevant only when HasGeometryShaders() is true. This is a pre OpenGL 3.2 geometry shader setting. From OpenGL 3.2, it is replaced by an output layout qualifier in GLSL 1.50. The maximum number of vertices the geometry shader will emit in one invocation. If a geometry shader, in one invocation, emits more vertices than this value, these emits may have no effect. Initial value is 1.

virtual void vtkShaderProgram2::SetGeometryTypeOut ( int ) [virtual]

Specific to the geometry shader part of the program. Relevant only when HasGeometryShaders() is true. From OpenGL 3.2, it is replaced by an output layout qualifier in GLSL 1.50. The output primitive type generated by the geometry shader. It can be VTK_GEOMETRY_SHADER_OUT_TYPE_POINTS, VTK_GEOMETRY_SHADER_OUT_TYPE_LINE_STRIP or VTK_GEOMETRY_SHADER_OUT_TYPE_TRIANGLE_STRIP. Initial value is VTK_GEOMETRY_SHADER_OUT_TYPE_POINTS.

virtual int vtkShaderProgram2::GetGeometryTypeOut ( ) [virtual]

Specific to the geometry shader part of the program. Relevant only when HasGeometryShaders() is true. From OpenGL 3.2, it is replaced by an output layout qualifier in GLSL 1.50. The output primitive type generated by the geometry shader. It can be VTK_GEOMETRY_SHADER_OUT_TYPE_POINTS, VTK_GEOMETRY_SHADER_OUT_TYPE_LINE_STRIP or VTK_GEOMETRY_SHADER_OUT_TYPE_TRIANGLE_STRIP. Initial value is VTK_GEOMETRY_SHADER_OUT_TYPE_POINTS.