GLSL Shader. More...

#include <vtkShader2.h>

Inheritance diagram for vtkShader2:

Collaboration diagram for vtkShader2:

Public Types
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkShader2 *	NewInstance () const

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 (vtkRenderWindow *context)

vtkRenderWindow *	GetContext ()


virtual unsigned int	GetId ()


virtual vtkUniformVariables *	GetUniformVariables ()

virtual void	SetUniformVariables (vtkUniformVariables *variables)

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkShader2 *	New ()

static int	IsTypeOf (const char *type)

static vtkShader2 *	SafeDownCast (vtkObjectBase *o)

static bool	IsSupported (vtkRenderWindow *context)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkShader2 ()

virtual	~vtkShader2 ()

bool	LoadRequiredExtensions (vtkRenderWindow *context)

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
char *	SourceCode

int	Type

unsigned int	Id

bool	LastCompileStatus

char *	LastCompileLog

size_t	LastCompileLogCapacity

vtkTimeStamp	LastCompileTime

vtkUniformVariables *	UniformVariables

vtkWeakPointer< vtkRenderWindow >	Context

bool	ExtensionsLoaded

bool	SupportGeometryShader

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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)

vertex shader
tessellation control shader
tessellation evaluation shader
geometry shader
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 61 of file vtkShader2.h.

Member Typedef Documentation

typedef vtkObject vtkShader2::Superclass

Definition at line 65 of file vtkShader2.h.

Constructor & Destructor Documentation

vtkShader2::vtkShader2 ( )

protected

Default constructor. SourceCode is NULL. Type is vertex.

virtual vtkShader2::~vtkShader2 ( )

protectedvirtual

Destructor. Delete SourceCode and LastCompileLog if any.

Member Function Documentation

static vtkShader2* vtkShader2::New ( )

static

static int vtkShader2::IsTypeOf ( const char * type )

static

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 ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkShader2::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

vtkShader2* vtkShader2::NewInstance ( ) const

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 ( vtkRenderWindow * context )

static

Returns if the context supports the required extensions. Extensions are load when the context is set.

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 ""='\0'.

Postcondition: result_exists: result!=0

void vtkShader2::SetContext ( vtkRenderWindow * 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.

vtkRenderWindow* vtkShader2::GetContext ( )

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

bool vtkShader2::LoadRequiredExtensions ( vtkRenderWindow * context )

protected

Load the required OpenGL extensions.

Member Data Documentation

char* vtkShader2::SourceCode

protected

Definition at line 147 of file vtkShader2.h.

int vtkShader2::Type

protected

Definition at line 148 of file vtkShader2.h.

unsigned int vtkShader2::Id

protected

Definition at line 150 of file vtkShader2.h.

bool vtkShader2::LastCompileStatus

protected

Definition at line 152 of file vtkShader2.h.

char* vtkShader2::LastCompileLog

protected

Definition at line 153 of file vtkShader2.h.

size_t vtkShader2::LastCompileLogCapacity

protected

Definition at line 154 of file vtkShader2.h.

vtkTimeStamp vtkShader2::LastCompileTime

protected

Definition at line 156 of file vtkShader2.h.

vtkUniformVariables* vtkShader2::UniformVariables

protected

Definition at line 157 of file vtkShader2.h.

vtkWeakPointer<vtkRenderWindow> vtkShader2::Context

protected

Definition at line 159 of file vtkShader2.h.

bool vtkShader2::ExtensionsLoaded

protected

Definition at line 161 of file vtkShader2.h.

bool vtkShader2::SupportGeometryShader

protected

Definition at line 162 of file vtkShader2.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Rendering/OpenGL/vtkShader2.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation