vtkOpenGLShaderCache Class Reference

manage Shader Programs within a context More...

#include <vtkOpenGLShaderCache.h>

Inheritance diagram for vtkOpenGLShaderCache:

Collaboration diagram for vtkOpenGLShaderCache:

Public Types
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.
vtkOpenGLShaderCache *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual vtkShaderProgram *	ReadyShaderProgram (const char *vertexCode, const char *fragmentCode, const char *geometryCode, vtkTransformFeedback *cap=nullptr)
virtual vtkShaderProgram *	ReadyShaderProgram (const char *vertexCode, const char *fragmentCode, const char *geometryCode, const char *tessControlCode, const char *tessEvalCode, vtkTransformFeedback *cap=nullptr)
virtual vtkShaderProgram *	ReadyShaderProgram (std::map< vtkShader::Type, vtkShader * > shaders, vtkTransformFeedback *cap=nullptr)
virtual vtkShaderProgram *	ReadyShaderProgram (vtkShaderProgram *shader, vtkTransformFeedback *cap=nullptr)
void	ReleaseCurrentShader ()
	Release the current shader.
virtual void	ReleaseGraphicsResources (vtkWindow *win)
	Free up any resources being used by the provided shader.
virtual void	ClearLastShaderBound ()
	Get/Clear the last Shader bound, called by shaders as they release their graphics resources.
virtual vtkShaderProgram *	GetLastShaderBound ()
void	SetElapsedTime (float val)
virtual void	SetSyncGLSLShaderVersion (bool)
	Set/Get whether the GLSL version macro in the shader must be the same as OpenGL version.
virtual bool	GetSyncGLSLShaderVersion ()
	Set/Get whether the GLSL version macro in the shader must be the same as OpenGL version.
virtual void	SyncGLSLShaderVersionOn ()
	Set/Get whether the GLSL version macro in the shader must be the same as OpenGL version.
virtual void	SyncGLSLShaderVersionOff ()
	Set/Get whether the GLSL version macro in the shader must be the same as OpenGL version.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
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)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
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.
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.
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.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses vtkGarbageCollector or not.

Static Public Member Functions
static vtkOpenGLShaderCache *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkOpenGLShaderCache *	SafeDownCast (vtkObjectBase *o)
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.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
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.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkOpenGLShaderCache ()
	~vtkOpenGLShaderCache () override
virtual unsigned int	ReplaceShaderValues (std::string &VSSource, std::string &FSSource, std::string &GSSource, std::string &TCSSource, std::string &TESSource)
virtual vtkShaderProgram *	GetShaderProgram (const char *vertexCode, const char *fragmentCode, const char *geometryCode, const char *tessControlCode, const char *tessEvalCode)
virtual vtkShaderProgram *	GetShaderProgram (std::map< vtkShader::Type, vtkShader * > shaders)
virtual int	BindShader (vtkShaderProgram *shader)
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.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
virtual void	ObjectFinalize ()
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
Private *	Internal
vtkShaderProgram *	LastShaderBound
int	OpenGLMajorVersion
int	OpenGLMinorVersion
bool	SyncGLSLShaderVersion
float	ElapsedTime
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
std::string	ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

manage Shader Programs within a context

vtkOpenGLShaderCache manages shader program compilation and binding

Tests:

vtkOpenGLShaderCache (Tests)

Definition at line 27 of file vtkOpenGLShaderCache.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkOpenGLShaderCache::Superclass

Definition at line 31 of file vtkOpenGLShaderCache.h.

Constructor & Destructor Documentation

vtkOpenGLShaderCache()

vtkOpenGLShaderCache::vtkOpenGLShaderCache ( )

protected

~vtkOpenGLShaderCache()

vtkOpenGLShaderCache::~vtkOpenGLShaderCache ( )

overrideprotected

Member Function Documentation

New()

static vtkOpenGLShaderCache * vtkOpenGLShaderCache::New ( )

static

IsTypeOf()

static vtkTypeBool vtkOpenGLShaderCache::IsTypeOf ( const char *  type )

static

IsA()

virtual vtkTypeBool vtkOpenGLShaderCache::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.

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkOpenGLShaderCache::NewInstanceInternal ( ) const

protectedvirtual

NewInstance()

vtkOpenGLShaderCache * vtkOpenGLShaderCache::NewInstance

(

)

const

PrintSelf()

void vtkOpenGLShaderCache::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.

SetSyncGLSLShaderVersion()

virtual void vtkOpenGLShaderCache::SetSyncGLSLShaderVersion ( bool  )

virtual

Set/Get whether the GLSL version macro in the shader must be the same as OpenGL version.

When true, the #version xyz macro is defined such that: x = OpenGLMajorVersion y = OpenGLMinorVersion z = 0

GetSyncGLSLShaderVersion()

virtual bool vtkOpenGLShaderCache::GetSyncGLSLShaderVersion ( )

virtual

Set/Get whether the GLSL version macro in the shader must be the same as OpenGL version.

When true, the #version xyz macro is defined such that: x = OpenGLMajorVersion y = OpenGLMinorVersion z = 0

SyncGLSLShaderVersionOn()

virtual void vtkOpenGLShaderCache::SyncGLSLShaderVersionOn ( )

virtual

Set/Get whether the GLSL version macro in the shader must be the same as OpenGL version.

When true, the #version xyz macro is defined such that: x = OpenGLMajorVersion y = OpenGLMinorVersion z = 0

SyncGLSLShaderVersionOff()

virtual void vtkOpenGLShaderCache::SyncGLSLShaderVersionOff ( )

virtual

Set/Get whether the GLSL version macro in the shader must be the same as OpenGL version.

When true, the #version xyz macro is defined such that: x = OpenGLMajorVersion y = OpenGLMinorVersion z = 0

ReadyShaderProgram() [1/4]

virtual vtkShaderProgram * vtkOpenGLShaderCache::ReadyShaderProgram ( const char *  vertexCode, const char *  fragmentCode, const char *  geometryCode, vtkTransformFeedback *  cap = nullptr  )

virtual

ReadyShaderProgram() [2/4]

virtual vtkShaderProgram * vtkOpenGLShaderCache::ReadyShaderProgram ( const char *  vertexCode, const char *  fragmentCode, const char *  geometryCode, const char *  tessControlCode, const char *  tessEvalCode, vtkTransformFeedback *  cap = nullptr  )

virtual

ReadyShaderProgram() [3/4]

virtual vtkShaderProgram * vtkOpenGLShaderCache::ReadyShaderProgram ( std::map< vtkShader::Type, vtkShader * >  shaders, vtkTransformFeedback *  cap = nullptr  )

virtual

ReadyShaderProgram() [4/4]

virtual vtkShaderProgram * vtkOpenGLShaderCache::ReadyShaderProgram ( vtkShaderProgram *  shader, vtkTransformFeedback *  cap = nullptr  )

virtual

ReleaseCurrentShader()

void vtkOpenGLShaderCache::ReleaseCurrentShader

(

)

Release the current shader.

Basically go back to having no shaders loaded. This is useful for old legacy code that relies on no shaders being loaded.

ReleaseGraphicsResources()

virtual void vtkOpenGLShaderCache::ReleaseGraphicsResources ( vtkWindow *  win )

virtual

Free up any resources being used by the provided shader.

ClearLastShaderBound()

virtual void vtkOpenGLShaderCache::ClearLastShaderBound ( )

inlinevirtual

Get/Clear the last Shader bound, called by shaders as they release their graphics resources.

Definition at line 80 of file vtkOpenGLShaderCache.h.

GetLastShaderBound()

virtual vtkShaderProgram * vtkOpenGLShaderCache::GetLastShaderBound ( )

virtual

SetElapsedTime()

void vtkOpenGLShaderCache::SetElapsedTime ( float  val )

inline

Definition at line 84 of file vtkOpenGLShaderCache.h.

ReplaceShaderValues()

virtual unsigned int vtkOpenGLShaderCache::ReplaceShaderValues ( std::string &  VSSource, std::string &  FSSource, std::string &  GSSource, std::string &  TCSSource, std::string &  TESSource  )

protectedvirtual

GetShaderProgram() [1/2]

virtual vtkShaderProgram * vtkOpenGLShaderCache::GetShaderProgram ( const char *  vertexCode, const char *  fragmentCode, const char *  geometryCode, const char *  tessControlCode, const char *  tessEvalCode  )

protectedvirtual

GetShaderProgram() [2/2]

virtual vtkShaderProgram * vtkOpenGLShaderCache::GetShaderProgram ( std::map< vtkShader::Type, vtkShader * >  shaders )

protectedvirtual

BindShader()

virtual int vtkOpenGLShaderCache::BindShader ( vtkShaderProgram *  shader )

protectedvirtual

Member Data Documentation

Internal

Private* vtkOpenGLShaderCache::Internal

protected

Definition at line 101 of file vtkOpenGLShaderCache.h.

LastShaderBound

vtkShaderProgram* vtkOpenGLShaderCache::LastShaderBound

protected

Definition at line 102 of file vtkOpenGLShaderCache.h.

OpenGLMajorVersion

int vtkOpenGLShaderCache::OpenGLMajorVersion

protected

Definition at line 104 of file vtkOpenGLShaderCache.h.

OpenGLMinorVersion

int vtkOpenGLShaderCache::OpenGLMinorVersion

protected

Definition at line 105 of file vtkOpenGLShaderCache.h.

SyncGLSLShaderVersion

bool vtkOpenGLShaderCache::SyncGLSLShaderVersion

protected

Definition at line 106 of file vtkOpenGLShaderCache.h.

ElapsedTime

float vtkOpenGLShaderCache::ElapsedTime

protected

Definition at line 108 of file vtkOpenGLShaderCache.h.

---

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

• Rendering/OpenGL2/vtkOpenGLShaderCache.h