vtkShader2 Class Reference

#include <vtkShader2.h>

Inheritance diagram for vtkShader2:

[legend]

Collaboration diagram for vtkShader2:

[legend]

List of all members.

Detailed Description

GLSL Shader.

A vtkShader2 object is made of a source code encoded into a string and a type, identifying the hardware programmable stage it is attached to. Hardware programmable stages are (or will be) 1. vertex shader 2. tessellation control shader 3. tessellation evaluation shader 4. geometry shader 5. fragment shader

Note: tessellation control shader is called hull shader in DirectX11 Note: tessellation evaluation shader is called domain shader in DirectX11 Ref: OpenGL spec 4.0 http://www.opengl.org/registry/doc/glspec40.core.20100311.withchanges.pdf Ref: "Introducing DirectX 11" http://www.gamasutra.com/view/feature/3759/sponsored_feature_introducing_.php

See also:: vtkShaderProgram2

Tests:: vtkShader2 (Tests)

Definition at line 59 of file vtkShader2.h.


Public Types
typedef vtkObject	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
const char *	GetTypeAsString ()
void	Compile ()
bool	GetLastCompileStatus ()
const char *	GetLastCompileLog ()
virtual void	ReleaseGraphicsResources ()

virtual char *	GetSourceCode ()
virtual void	SetSourceCode (const char *)

virtual int	GetType ()

virtual void	SetType (int)

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

virtual unsigned int	GetId ()

virtual vtkUniformVariables *	GetUniformVariables ()
virtual void	SetUniformVariables (vtkUniformVariables *variables)
Static Public Member Functions
static vtkShader2 *	New ()
static int	IsTypeOf (const char *type)
static vtkShader2 *	SafeDownCast (vtkObject *o)

static bool	IsSupported (vtkOpenGLRenderWindow *context)
static bool	LoadExtensions (vtkOpenGLRenderWindow *context)
Protected Member Functions
	vtkShader2 ()
virtual	~vtkShader2 ()
Protected Attributes
char *	SourceCode
int	Type
unsigned int	Id
bool	LastCompileStatus
char *	LastCompileLog
size_t	LastCompileLogCapacity
vtkTimeStamp	LastCompileTime
vtkUniformVariables *	UniformVariables
vtkOpenGLRenderWindow *	Context
bool	ExtensionsLoaded
bool	SupportGeometryShader

Member Typedef Documentation

typedef vtkObject vtkShader2::Superclass

Reimplemented from vtkObject.

Definition at line 63 of file vtkShader2.h.

Constructor & Destructor Documentation

vtkShader2::vtkShader2 ( ) [protected]

Default constructor. SourceCode is NULL. Type is vertex.

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

Destructor. Delete SourceCode and LastCompileLog if any.

Member Function Documentation

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

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

Reimplemented from vtkObject.

virtual const char* vtkShader2::GetClassName ( ) [virtual]

Reimplemented from vtkObject.

static int vtkShader2::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 vtkShader2::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 vtkShader2* vtkShader2::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkObject.

void vtkShader2::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 vtkShader2::IsSupported ( vtkOpenGLRenderWindow * context ) [static]

Returns if the context supports the required extensions.

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

Returns if the context supports the required extensions.

virtual char* vtkShader2::GetSourceCode ( ) [virtual]

String containing the shader source code. Reminder SetString makes a copy of its argument.

virtual void vtkShader2::SetSourceCode ( const char * ) [virtual]

String containing the shader source code. Reminder SetString makes a copy of its argument.

virtual int vtkShader2::GetType ( ) [virtual]

Return the shader type, .

Postcondition:: valid_result: result==VTK_SHADER_TYPE_VERTEX || result==VTK_SHADER_TYPE_TESSELLATION_CONTROL || result==VTK_SHADER_TYPE_TESSELLATION_EVALUATION || result==VTK_SHADER_TYPE_GEOMETRY || result==VTK_SHADER_TYPE_FRAGMENT.

virtual void vtkShader2::SetType ( int ) [virtual]

Set the shader type, .

Precondition:: valid_type: type==VTK_SHADER_TYPE_VERTEX || type==VTK_SHADER_TYPE_TESSELLATION_CONTROL || type==VTK_SHADER_TYPE_TESSELLATION_EVALUATION || type==VTK_SHADER_TYPE_GEOMETRY || type==VTK_SHADER_TYPE_FRAGMENT.

Postcondition:: is_set: GetType()==type.

const char* vtkShader2::GetTypeAsString ( )

Return the shader type as a string.

void vtkShader2::Compile ( )

Compile the shader code. The result of compilation can be query with GetLastCompileStatus() The log of compilation can be query with GetLastCompileLog()

Precondition:: SourceCode_exists: this->GetSourceCode()!=0

bool vtkShader2::GetLastCompileStatus ( )

Tells if the last call to compile succeeded (true) or not (false). Initial value is false.

const char* vtkShader2::GetLastCompileLog ( )

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

Postcondition:: result_exists: result!=0

void vtkShader2::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* vtkShader2::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 void vtkShader2::ReleaseGraphicsResources ( ) [virtual]

Release OpenGL resource (shader id).

virtual unsigned int vtkShader2::GetId ( ) [virtual]

Return the OpenGL shader object id.

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

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

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

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