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

manage Shader Programs within a context More...

#include <vtkOpenGLShaderCache.h>

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

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. More...
 
vtkOpenGLShaderCacheNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual vtkShaderProgramReadyShaderProgram (const char *vertexCode, const char *fragmentCode, const char *geometryCode, vtkTransformFeedback *cap=nullptr)
 
virtual vtkShaderProgramReadyShaderProgram (std::map< vtkShader::Type, vtkShader * > shaders, vtkTransformFeedback *cap=nullptr)
 
virtual vtkShaderProgramReadyShaderProgram (vtkShaderProgram *shader, vtkTransformFeedback *cap=nullptr)
 
void ReleaseCurrentShader ()
 Release the current shader. More...
 
virtual void ReleaseGraphicsResources (vtkWindow *win)
 Free up any resources being used by the provided shader. More...
 
virtual void ClearLastShaderBound ()
 Get/Clear the last Shader bound, called by shaders as they release their graphics resources. More...
 
virtual vtkShaderProgramGetLastShaderBound ()
 
void SetElapsedTime (float val)
 
- 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 

Static Public Member Functions

static vtkOpenGLShaderCacheNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkOpenGLShaderCacheSafeDownCast (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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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
 
 vtkOpenGLShaderCache ()
 
 ~vtkOpenGLShaderCache () override
 
virtual unsigned int ReplaceShaderValues (std::string &VSSource, std::string &FSSource, std::string &GSSource)
 
virtual vtkShaderProgramGetShaderProgram (const char *vertexCode, const char *fragmentCode, const char *geometryCode)
 
virtual vtkShaderProgramGetShaderProgram (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. More...
 
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

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

Detailed Description

manage Shader Programs within a context

vtkOpenGLShaderCache manages shader program compilation and binding

Definition at line 35 of file vtkOpenGLShaderCache.h.

Member Typedef Documentation

◆ Superclass

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

◆ ReadyShaderProgram() [1/3]

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

◆ ReadyShaderProgram() [2/3]

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

◆ ReadyShaderProgram() [3/3]

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 72 of file vtkOpenGLShaderCache.h.

◆ GetLastShaderBound()

virtual vtkShaderProgram* vtkOpenGLShaderCache::GetLastShaderBound ( )
virtual

◆ SetElapsedTime()

void vtkOpenGLShaderCache::SetElapsedTime ( float  val)
inline

Definition at line 76 of file vtkOpenGLShaderCache.h.

◆ ReplaceShaderValues()

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

◆ GetShaderProgram() [1/2]

virtual vtkShaderProgram* vtkOpenGLShaderCache::GetShaderProgram ( const char *  vertexCode,
const char *  fragmentCode,
const char *  geometryCode 
)
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 92 of file vtkOpenGLShaderCache.h.

◆ LastShaderBound

vtkShaderProgram* vtkOpenGLShaderCache::LastShaderBound
protected

Definition at line 94 of file vtkOpenGLShaderCache.h.

◆ OpenGLMajorVersion

int vtkOpenGLShaderCache::OpenGLMajorVersion
protected

Definition at line 96 of file vtkOpenGLShaderCache.h.

◆ OpenGLMinorVersion

int vtkOpenGLShaderCache::OpenGLMinorVersion
protected

Definition at line 97 of file vtkOpenGLShaderCache.h.

◆ ElapsedTime

float vtkOpenGLShaderCache::ElapsedTime
protected

Definition at line 99 of file vtkOpenGLShaderCache.h.


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