GLSL Shader. More...

#include <vtkShader2.h>

Inheritance diagram for vtkShader2:

Collaboration diagram for vtkShader2:

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual int	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkShader2 *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

const char *	GetTypeAsString ()
	Return the shader type as a string. More...

void	Compile ()
	Compile the shader code. More...

bool	GetLastCompileStatus ()
	Tells if the last call to compile succeeded (true) or not (false). More...

const char *	GetLastCompileLog ()
	Return the log of the last call to compile as a string. More...

virtual void	ReleaseGraphicsResources ()
	Release OpenGL resource (shader id). More...


virtual char *	GetSourceCode ()
	String containing the shader source code. More...

virtual void	SetSourceCode (const char *)
	String containing the shader source code. More...


virtual int	GetType ()
	Return the shader type, . More...


virtual void	SetType (int)
	Set the shader type, . More...


void	SetContext (vtkRenderWindow *context)
	Get/Set the context. More...

vtkRenderWindow *	GetContext ()
	Get/Set the context. More...


virtual unsigned int	GetId ()
	Return the OpenGL shader object id. More...


virtual vtkUniformVariables *	GetUniformVariables ()
	Get/Set the list of uniform variables values. More...

virtual void	SetUniformVariables (vtkUniformVariables *variables)
	Get/Set the list of uniform variables values. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkShader2 *	New ()

static int	IsTypeOf (const char *type)

static vtkShader2 *	SafeDownCast (vtkObjectBase *o)

static bool	IsSupported (vtkRenderWindow *context)
	Returns if the context supports the required extensions. More...

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkShader2 ()
	Default constructor. More...

virtual	~vtkShader2 ()
	Destructor. More...

bool	LoadRequiredExtensions (vtkRenderWindow *context)
	Load the required OpenGL extensions. More...

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

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 62 of file vtkShader2.h.

Member Typedef Documentation

typedef vtkObject vtkShader2::Superclass

Definition at line 66 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 vtkObjectBase.

static vtkShader2* vtkShader2::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkShader2::NewInstanceInternal ( ) const

protectedvirtual

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 183 of file vtkShader2.h.

int vtkShader2::Type

protected

Definition at line 184 of file vtkShader2.h.

unsigned int vtkShader2::Id

protected

Definition at line 186 of file vtkShader2.h.

bool vtkShader2::LastCompileStatus

protected

Definition at line 188 of file vtkShader2.h.

char* vtkShader2::LastCompileLog

protected

Definition at line 189 of file vtkShader2.h.

size_t vtkShader2::LastCompileLogCapacity

protected

Definition at line 190 of file vtkShader2.h.

vtkTimeStamp vtkShader2::LastCompileTime

protected

Definition at line 192 of file vtkShader2.h.

vtkUniformVariables* vtkShader2::UniformVariables

protected

Definition at line 193 of file vtkShader2.h.

vtkWeakPointer<vtkRenderWindow> vtkShader2::Context

protected

Definition at line 195 of file vtkShader2.h.

bool vtkShader2::ExtensionsLoaded

protected

Definition at line 197 of file vtkShader2.h.

bool vtkShader2::SupportGeometryShader

protected

Definition at line 198 of file vtkShader2.h.

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

/home/demarle/Builds/VTK/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