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

represent GPU shader properties More...

#include <vtkOpenGLShaderProperty.h>

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

Public Types

typedef vtkShaderProperty Superclass
 
typedef std::map< vtkShader::ReplacementSpec, vtkShader::ReplacementValueReplacementMap
 GetAllShaderReplacements returns all user-specified shader replacements. More...
 
- Public Types inherited from vtkShaderProperty
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...
 
vtkOpenGLShaderPropertyNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void DeepCopy (vtkOpenGLShaderProperty *p)
 Assign one property to another. More...
 
void AddVertexShaderReplacement (const std::string &originalValue, bool replaceFirst, const std::string &replacementValue, bool replaceAll) override
 This function enables you to apply your own substitutions to the shader creation process. More...
 
void AddFragmentShaderReplacement (const std::string &originalValue, bool replaceFirst, const std::string &replacementValue, bool replaceAll) override
 
void AddGeometryShaderReplacement (const std::string &originalValue, bool replaceFirst, const std::string &replacementValue, bool replaceAll) override
 
int GetNumberOfShaderReplacements () override
 
std::string GetNthShaderReplacementTypeAsString (vtkIdType index) override
 
void GetNthShaderReplacement (vtkIdType index, std::string &name, bool &replaceFirst, std::string &replacementValue, bool &replaceAll) override
 
void ClearVertexShaderReplacement (const std::string &originalValue, bool replaceFirst) override
 
void ClearFragmentShaderReplacement (const std::string &originalValue, bool replaceFirst) override
 
void ClearGeometryShaderReplacement (const std::string &originalValue, bool replaceFirst) override
 
void ClearAllVertexShaderReplacements () override
 
void ClearAllFragmentShaderReplacements () override
 
void ClearAllGeometryShaderReplacements () override
 
void ClearAllShaderReplacements () override
 
void AddShaderReplacement (vtkShader::Type shaderType, const std::string &originalValue, bool replaceFirst, const std::string &replacementValue, bool replaceAll)
 This function enables you to apply your own substitutions to the shader creation process. More...
 
void ClearShaderReplacement (vtkShader::Type shaderType, const std::string &originalValue, bool replaceFirst)
 
void ClearAllShaderReplacements (vtkShader::Type shaderType)
 
const ReplacementMapGetAllShaderReplacements ()
 
- Public Member Functions inherited from vtkShaderProperty
vtkShaderPropertyNewInstance () const
 
void DeepCopy (vtkShaderProperty *p)
 Assign one property to another. More...
 
vtkMTimeType GetShaderMTime ()
 GetShaderMTime returns the last time a modification was made that affected the code of the shader (either code replacement was changed or one or more uniform variables were added or removed. More...
 
bool HasVertexShaderCode ()
 Allow the program to set the shader codes used directly instead of using the built in templates. More...
 
bool HasFragmentShaderCode ()
 
bool HasGeometryShaderCode ()
 
virtual void SetVertexShaderCode (const char *)
 
virtual char * GetVertexShaderCode ()
 
virtual void SetFragmentShaderCode (const char *)
 
virtual char * GetFragmentShaderCode ()
 
virtual void SetGeometryShaderCode (const char *)
 
virtual char * GetGeometryShaderCode ()
 
virtual vtkUniformsGetFragmentCustomUniforms ()
 The Uniforms object allows to set custom uniform variables that are used in replacement shader code. More...
 
virtual vtkUniformsGetVertexCustomUniforms ()
 
virtual vtkUniformsGetGeometryCustomUniforms ()
 
- 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 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). 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...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkOpenGLShaderPropertySafeDownCast (vtkObjectBase *o)
 
static vtkOpenGLShaderPropertyNew ()
 Construct object with no shader replacements. More...
 
- Static Public Member Functions inherited from vtkShaderProperty
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkShaderPropertySafeDownCast (vtkObjectBase *o)
 
static vtkShaderPropertyNew ()
 Construct object with no shader replacements. More...
 
- 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 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). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
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. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkOpenGLShaderProperty ()
 
 ~vtkOpenGLShaderProperty () override
 
- Protected Member Functions inherited from vtkShaderProperty
 vtkShaderProperty ()
 
 ~vtkShaderProperty () 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 ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

ReplacementMap UserShaderReplacements
 
- Protected Attributes inherited from vtkShaderProperty
char * VertexShaderCode
 
char * FragmentShaderCode
 
char * GeometryShaderCode
 
vtkNew< vtkUniformsFragmentCustomUniforms
 
vtkNew< vtkUniformsVertexCustomUniforms
 
vtkNew< vtkUniformsGeometryCustomUniforms
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- 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

represent GPU shader properties

vtkOpenGLShaderProperty is used to hold user-defined modifications of a GPU shader program used in a mapper.

See also
vtkShaderProperty vtkUniforms vtkOpenGLUniform
Thanks:
Developed by Simon Drouin (sdrou.nosp@m.in2@.nosp@m.bwh.h.nosp@m.arva.nosp@m.rd.ed.nosp@m.u) at Brigham and Women's Hospital.

Definition at line 40 of file vtkOpenGLShaderProperty.h.

Member Typedef Documentation

◆ Superclass

Definition at line 43 of file vtkOpenGLShaderProperty.h.

◆ ReplacementMap

GetAllShaderReplacements returns all user-specified shader replacements.

It is provided for iteration purpuses only (const) and is mainly used by mappers when building the shaders.

Returns
const reference to internal map holding all replacements

Definition at line 102 of file vtkOpenGLShaderProperty.h.

Constructor & Destructor Documentation

◆ vtkOpenGLShaderProperty()

vtkOpenGLShaderProperty::vtkOpenGLShaderProperty ( )
protected

◆ ~vtkOpenGLShaderProperty()

vtkOpenGLShaderProperty::~vtkOpenGLShaderProperty ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkOpenGLShaderProperty::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkShaderProperty.

◆ NewInstance()

vtkOpenGLShaderProperty* vtkOpenGLShaderProperty::NewInstance ( ) const

◆ PrintSelf()

void vtkOpenGLShaderProperty::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 vtkShaderProperty.

◆ New()

static vtkOpenGLShaderProperty* vtkOpenGLShaderProperty::New ( )
static

Construct object with no shader replacements.

◆ DeepCopy()

void vtkOpenGLShaderProperty::DeepCopy ( vtkOpenGLShaderProperty p)

Assign one property to another.

◆ AddVertexShaderReplacement()

void vtkOpenGLShaderProperty::AddVertexShaderReplacement ( const std::string &  originalValue,
bool  replaceFirst,
const std::string &  replacementValue,
bool  replaceAll 
)
overridevirtual

This function enables you to apply your own substitutions to the shader creation process.

The shader code in this class is created by applying a bunch of string replacements to a shader template. Using this function you can apply your own string replacements to add features you desire.

Implements vtkShaderProperty.

◆ AddFragmentShaderReplacement()

void vtkOpenGLShaderProperty::AddFragmentShaderReplacement ( const std::string &  originalValue,
bool  replaceFirst,
const std::string &  replacementValue,
bool  replaceAll 
)
overridevirtual

Implements vtkShaderProperty.

◆ AddGeometryShaderReplacement()

void vtkOpenGLShaderProperty::AddGeometryShaderReplacement ( const std::string &  originalValue,
bool  replaceFirst,
const std::string &  replacementValue,
bool  replaceAll 
)
overridevirtual

Implements vtkShaderProperty.

◆ GetNumberOfShaderReplacements()

int vtkOpenGLShaderProperty::GetNumberOfShaderReplacements ( )
overridevirtual

Implements vtkShaderProperty.

◆ GetNthShaderReplacementTypeAsString()

std::string vtkOpenGLShaderProperty::GetNthShaderReplacementTypeAsString ( vtkIdType  index)
overridevirtual

Implements vtkShaderProperty.

◆ GetNthShaderReplacement()

void vtkOpenGLShaderProperty::GetNthShaderReplacement ( vtkIdType  index,
std::string &  name,
bool &  replaceFirst,
std::string &  replacementValue,
bool &  replaceAll 
)
overridevirtual

Implements vtkShaderProperty.

◆ ClearVertexShaderReplacement()

void vtkOpenGLShaderProperty::ClearVertexShaderReplacement ( const std::string &  originalValue,
bool  replaceFirst 
)
overridevirtual

Implements vtkShaderProperty.

◆ ClearFragmentShaderReplacement()

void vtkOpenGLShaderProperty::ClearFragmentShaderReplacement ( const std::string &  originalValue,
bool  replaceFirst 
)
overridevirtual

Implements vtkShaderProperty.

◆ ClearGeometryShaderReplacement()

void vtkOpenGLShaderProperty::ClearGeometryShaderReplacement ( const std::string &  originalValue,
bool  replaceFirst 
)
overridevirtual

Implements vtkShaderProperty.

◆ ClearAllVertexShaderReplacements()

void vtkOpenGLShaderProperty::ClearAllVertexShaderReplacements ( )
overridevirtual

Implements vtkShaderProperty.

◆ ClearAllFragmentShaderReplacements()

void vtkOpenGLShaderProperty::ClearAllFragmentShaderReplacements ( )
overridevirtual

Implements vtkShaderProperty.

◆ ClearAllGeometryShaderReplacements()

void vtkOpenGLShaderProperty::ClearAllGeometryShaderReplacements ( )
overridevirtual

Implements vtkShaderProperty.

◆ ClearAllShaderReplacements() [1/2]

void vtkOpenGLShaderProperty::ClearAllShaderReplacements ( )
overridevirtual

Implements vtkShaderProperty.

◆ AddShaderReplacement()

void vtkOpenGLShaderProperty::AddShaderReplacement ( vtkShader::Type  shaderType,
const std::string &  originalValue,
bool  replaceFirst,
const std::string &  replacementValue,
bool  replaceAll 
)

This function enables you to apply your own substitutions to the shader creation process.

The shader code in this class is created by applying a bunch of string replacements to a shader template. Using this function you can apply your own string replacements to add features you desire.

◆ ClearShaderReplacement()

void vtkOpenGLShaderProperty::ClearShaderReplacement ( vtkShader::Type  shaderType,
const std::string &  originalValue,
bool  replaceFirst 
)

◆ ClearAllShaderReplacements() [2/2]

void vtkOpenGLShaderProperty::ClearAllShaderReplacements ( vtkShader::Type  shaderType)

◆ GetAllShaderReplacements()

const ReplacementMap& vtkOpenGLShaderProperty::GetAllShaderReplacements ( )
inline

Definition at line 103 of file vtkOpenGLShaderProperty.h.

Member Data Documentation

◆ UserShaderReplacements

ReplacementMap vtkOpenGLShaderProperty::UserShaderReplacements
protected

Definition at line 109 of file vtkOpenGLShaderProperty.h.


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