VTK
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkShader Class Reference

Vertex or Fragment shader, combined into a ShaderProgram. More...

#include <vtkShader.h>

Inheritance diagram for vtkShader:
[legend]
Collaboration diagram for vtkShader:
[legend]

Classes

class  ReplacementSpec
 
class  ReplacementValue
 

Public Types

enum  Type { Vertex, Fragment, Geometry, Unknown }
 Available shader types. More...
 
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkShaderNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetType (Type type)
 Set the shader type. More...
 
Type GetType () const
 Get the shader type, typically Vertex or Fragment. More...
 
void SetSource (const std::string &source)
 Set the shader source to the supplied string. More...
 
std::string GetSource () const
 Get the source for the shader. More...
 
std::string GetError () const
 Get the error message (empty if none) for the shader. More...
 
int GetHandle () const
 Get the handle of the shader. More...
 
bool Compile ()
 Compile the shader. More...
 
void Cleanup ()
 Delete the shader. 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 ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool 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...
 
vtkCommandGetCommand (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...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool 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 vtkShaderNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkShaderSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkShader ()
 
 ~vtkShader () override
 
- 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=nullptr)
 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

Type ShaderType
 
int Handle
 
bool Dirty
 
std::string Source
 
std::string Error
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Vertex or Fragment shader, combined into a ShaderProgram.

encapsulate a glsl shader

This class creates a Vertex, Fragment or Geometry shader, that can be attached to a ShaderProgram in order to render geometry etc.

vtkShader represents a shader, vertex, fragment, geometry etc

Definition at line 37 of file vtkShader.h.

Member Typedef Documentation

Definition at line 41 of file vtkShader.h.

Member Enumeration Documentation

Available shader types.

Enumerator
Vertex 

Vertex shader.

Fragment 

Fragment shader.

Geometry 

Geometry shader.

Unknown 

Unknown (default)

Definition at line 45 of file vtkShader.h.

Constructor & Destructor Documentation

vtkShader::vtkShader ( )
protected
vtkShader::~vtkShader ( )
overrideprotected

Member Function Documentation

static vtkShader* vtkShader::New ( )
static
static vtkTypeBool vtkShader::IsTypeOf ( const char *  type)
static
virtual vtkTypeBool vtkShader::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 vtkShader* vtkShader::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkShader::NewInstanceInternal ( ) const
protectedvirtual
vtkShader* vtkShader::NewInstance ( ) const
void vtkShader::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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.

void vtkShader::SetType ( Type  type)

Set the shader type.

Type vtkShader::GetType ( ) const
inline

Get the shader type, typically Vertex or Fragment.

Definition at line 57 of file vtkShader.h.

void vtkShader::SetSource ( const std::string &  source)

Set the shader source to the supplied string.

std::string vtkShader::GetSource ( ) const
inline

Get the source for the shader.

Definition at line 63 of file vtkShader.h.

std::string vtkShader::GetError ( ) const
inline

Get the error message (empty if none) for the shader.

Definition at line 66 of file vtkShader.h.

int vtkShader::GetHandle ( ) const
inline

Get the handle of the shader.

Definition at line 69 of file vtkShader.h.

bool vtkShader::Compile ( )

Compile the shader.

Note
A valid context must to current in order to compile the shader.
void vtkShader::Cleanup ( )

Delete the shader.

Note
This should only be done once the ShaderProgram is done with the Shader.

Member Data Documentation

Type vtkShader::ShaderType
protected

Definition at line 124 of file vtkShader.h.

int vtkShader::Handle
protected

Definition at line 125 of file vtkShader.h.

bool vtkShader::Dirty
protected

Definition at line 126 of file vtkShader.h.

std::string vtkShader::Source
protected

Definition at line 128 of file vtkShader.h.

std::string vtkShader::Error
protected

Definition at line 129 of file vtkShader.h.


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