VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkShaderProperty Class Referenceabstract

represent GPU shader properties More...

#include <vtkShaderProperty.h>

Inheritance diagram for vtkShaderProperty:
[legend]
Collaboration diagram for vtkShaderProperty:
[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...
 
vtkShaderPropertyNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
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 ()
 
virtual void AddVertexShaderReplacement (const std::string &originalValue, bool replaceFirst, const std::string &replacementValue, bool replaceAll)=0
 This function enables you to apply your own substitutions to the shader creation process. More...
 
virtual void AddFragmentShaderReplacement (const std::string &originalValue, bool replaceFirst, const std::string &replacementValue, bool replaceAll)=0
 
virtual void AddGeometryShaderReplacement (const std::string &originalValue, bool replaceFirst, const std::string &replacementValue, bool replaceAll)=0
 
virtual int GetNumberOfShaderReplacements ()=0
 
virtual std::string GetNthShaderReplacementTypeAsString (vtkIdType index)=0
 
virtual void GetNthShaderReplacement (vtkIdType index, std::string &name, bool &replaceFirst, std::string &replacementValue, bool &replaceAll)=0
 
virtual void ClearVertexShaderReplacement (const std::string &originalValue, bool replaceFirst)=0
 
virtual void ClearFragmentShaderReplacement (const std::string &originalValue, bool replaceFirst)=0
 
virtual void ClearGeometryShaderReplacement (const std::string &originalValue, bool replaceFirst)=0
 
virtual void ClearAllVertexShaderReplacements ()=0
 
virtual void ClearAllFragmentShaderReplacements ()=0
 
virtual void ClearAllGeometryShaderReplacements ()=0
 
virtual void ClearAllShaderReplacements ()=0
 
- 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 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 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 CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

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
 

Detailed Description

represent GPU shader properties

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

See also
vtkVolume 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 39 of file vtkShaderProperty.h.

Member Typedef Documentation

◆ Superclass

Definition at line 42 of file vtkShaderProperty.h.

Constructor & Destructor Documentation

◆ vtkShaderProperty()

vtkShaderProperty::vtkShaderProperty ( )
protected

◆ ~vtkShaderProperty()

vtkShaderProperty::~vtkShaderProperty ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented in vtkOpenGLShaderProperty.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkShaderProperty::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented in vtkOpenGLShaderProperty.

◆ NewInstance()

vtkShaderProperty* vtkShaderProperty::NewInstance ( ) const

◆ PrintSelf()

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

Reimplemented in vtkOpenGLShaderProperty.

◆ New()

static vtkShaderProperty* vtkShaderProperty::New ( )
static

Construct object with no shader replacements.

◆ DeepCopy()

void vtkShaderProperty::DeepCopy ( vtkShaderProperty p)

Assign one property to another.

◆ GetShaderMTime()

vtkMTimeType vtkShaderProperty::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.

This timestamp can be used by mappers to determine if the shader must be recompiled. Simply changing the value of an existing uniform variable doesn't affect this timestamp as it doesn't change the shader code.

Returns
timestamp of the last modification

◆ HasVertexShaderCode()

bool vtkShaderProperty::HasVertexShaderCode ( )

Allow the program to set the shader codes used directly instead of using the built in templates.

Be aware, if set, this template will be used for all cases, primitive types, picking etc.

◆ HasFragmentShaderCode()

bool vtkShaderProperty::HasFragmentShaderCode ( )

◆ HasGeometryShaderCode()

bool vtkShaderProperty::HasGeometryShaderCode ( )

◆ SetVertexShaderCode()

virtual void vtkShaderProperty::SetVertexShaderCode ( const char *  )
virtual

◆ GetVertexShaderCode()

virtual char* vtkShaderProperty::GetVertexShaderCode ( )
virtual

◆ SetFragmentShaderCode()

virtual void vtkShaderProperty::SetFragmentShaderCode ( const char *  )
virtual

◆ GetFragmentShaderCode()

virtual char* vtkShaderProperty::GetFragmentShaderCode ( )
virtual

◆ SetGeometryShaderCode()

virtual void vtkShaderProperty::SetGeometryShaderCode ( const char *  )
virtual

◆ GetGeometryShaderCode()

virtual char* vtkShaderProperty::GetGeometryShaderCode ( )
virtual

◆ GetFragmentCustomUniforms()

virtual vtkUniforms* vtkShaderProperty::GetFragmentCustomUniforms ( )
virtual

The Uniforms object allows to set custom uniform variables that are used in replacement shader code.

◆ GetVertexCustomUniforms()

virtual vtkUniforms* vtkShaderProperty::GetVertexCustomUniforms ( )
virtual

◆ GetGeometryCustomUniforms()

virtual vtkUniforms* vtkShaderProperty::GetGeometryCustomUniforms ( )
virtual

◆ AddVertexShaderReplacement()

virtual void vtkShaderProperty::AddVertexShaderReplacement ( const std::string &  originalValue,
bool  replaceFirst,
const std::string &  replacementValue,
bool  replaceAll 
)
pure virtual

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.

Implemented in vtkOpenGLShaderProperty.

◆ AddFragmentShaderReplacement()

virtual void vtkShaderProperty::AddFragmentShaderReplacement ( const std::string &  originalValue,
bool  replaceFirst,
const std::string &  replacementValue,
bool  replaceAll 
)
pure virtual

Implemented in vtkOpenGLShaderProperty.

◆ AddGeometryShaderReplacement()

virtual void vtkShaderProperty::AddGeometryShaderReplacement ( const std::string &  originalValue,
bool  replaceFirst,
const std::string &  replacementValue,
bool  replaceAll 
)
pure virtual

Implemented in vtkOpenGLShaderProperty.

◆ GetNumberOfShaderReplacements()

virtual int vtkShaderProperty::GetNumberOfShaderReplacements ( )
pure virtual

Implemented in vtkOpenGLShaderProperty.

◆ GetNthShaderReplacementTypeAsString()

virtual std::string vtkShaderProperty::GetNthShaderReplacementTypeAsString ( vtkIdType  index)
pure virtual

Implemented in vtkOpenGLShaderProperty.

◆ GetNthShaderReplacement()

virtual void vtkShaderProperty::GetNthShaderReplacement ( vtkIdType  index,
std::string &  name,
bool &  replaceFirst,
std::string &  replacementValue,
bool &  replaceAll 
)
pure virtual

Implemented in vtkOpenGLShaderProperty.

◆ ClearVertexShaderReplacement()

virtual void vtkShaderProperty::ClearVertexShaderReplacement ( const std::string &  originalValue,
bool  replaceFirst 
)
pure virtual

Implemented in vtkOpenGLShaderProperty.

◆ ClearFragmentShaderReplacement()

virtual void vtkShaderProperty::ClearFragmentShaderReplacement ( const std::string &  originalValue,
bool  replaceFirst 
)
pure virtual

Implemented in vtkOpenGLShaderProperty.

◆ ClearGeometryShaderReplacement()

virtual void vtkShaderProperty::ClearGeometryShaderReplacement ( const std::string &  originalValue,
bool  replaceFirst 
)
pure virtual

Implemented in vtkOpenGLShaderProperty.

◆ ClearAllVertexShaderReplacements()

virtual void vtkShaderProperty::ClearAllVertexShaderReplacements ( )
pure virtual

Implemented in vtkOpenGLShaderProperty.

◆ ClearAllFragmentShaderReplacements()

virtual void vtkShaderProperty::ClearAllFragmentShaderReplacements ( )
pure virtual

Implemented in vtkOpenGLShaderProperty.

◆ ClearAllGeometryShaderReplacements()

virtual void vtkShaderProperty::ClearAllGeometryShaderReplacements ( )
pure virtual

Implemented in vtkOpenGLShaderProperty.

◆ ClearAllShaderReplacements()

virtual void vtkShaderProperty::ClearAllShaderReplacements ( )
pure virtual

Implemented in vtkOpenGLShaderProperty.

Member Data Documentation

◆ VertexShaderCode

char* vtkShaderProperty::VertexShaderCode
protected

Definition at line 132 of file vtkShaderProperty.h.

◆ FragmentShaderCode

char* vtkShaderProperty::FragmentShaderCode
protected

Definition at line 133 of file vtkShaderProperty.h.

◆ GeometryShaderCode

char* vtkShaderProperty::GeometryShaderCode
protected

Definition at line 134 of file vtkShaderProperty.h.

◆ FragmentCustomUniforms

vtkNew<vtkUniforms> vtkShaderProperty::FragmentCustomUniforms
protected

Definition at line 136 of file vtkShaderProperty.h.

◆ VertexCustomUniforms

vtkNew<vtkUniforms> vtkShaderProperty::VertexCustomUniforms
protected

Definition at line 137 of file vtkShaderProperty.h.

◆ GeometryCustomUniforms

vtkNew<vtkUniforms> vtkShaderProperty::GeometryCustomUniforms
protected

Definition at line 138 of file vtkShaderProperty.h.


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