VTK
9.1.0
|
represent GPU shader properties More...
#include <vtkOpenGLShaderProperty.h>
Public Types | |
typedef vtkShaderProperty | Superclass |
typedef std::map< vtkShader::ReplacementSpec, vtkShader::ReplacementValue > | ReplacementMap |
GetAllShaderReplacements returns all user-specified shader replacements. | |
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. | |
vtkOpenGLShaderProperty * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
void | DeepCopy (vtkOpenGLShaderProperty *p) |
Assign one property to another. | |
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. | |
void | AddFragmentShaderReplacement (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. | |
void | AddGeometryShaderReplacement (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. | |
int | GetNumberOfShaderReplacements () override |
This function enables you to apply your own substitutions to the shader creation process. | |
std::string | GetNthShaderReplacementTypeAsString (vtkIdType index) override |
This function enables you to apply your own substitutions to the shader creation process. | |
void | GetNthShaderReplacement (vtkIdType index, std::string &name, bool &replaceFirst, std::string &replacementValue, bool &replaceAll) override |
This function enables you to apply your own substitutions to the shader creation process. | |
void | ClearVertexShaderReplacement (const std::string &originalValue, bool replaceFirst) override |
This function enables you to apply your own substitutions to the shader creation process. | |
void | ClearFragmentShaderReplacement (const std::string &originalValue, bool replaceFirst) override |
This function enables you to apply your own substitutions to the shader creation process. | |
void | ClearGeometryShaderReplacement (const std::string &originalValue, bool replaceFirst) override |
This function enables you to apply your own substitutions to the shader creation process. | |
void | ClearAllVertexShaderReplacements () override |
This function enables you to apply your own substitutions to the shader creation process. | |
void | ClearAllFragmentShaderReplacements () override |
This function enables you to apply your own substitutions to the shader creation process. | |
void | ClearAllGeometryShaderReplacements () override |
This function enables you to apply your own substitutions to the shader creation process. | |
void | ClearAllShaderReplacements () override |
This function enables you to apply your own substitutions to the shader creation process. | |
const ReplacementMap & | GetAllShaderReplacements () |
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. | |
void | ClearShaderReplacement (vtkShader::Type shaderType, const std::string &originalValue, bool replaceFirst) |
This function enables you to apply your own substitutions to the shader creation process. | |
void | ClearAllShaderReplacements (vtkShader::Type shaderType) |
This function enables you to apply your own substitutions to the shader creation process. | |
Public Member Functions inherited from vtkShaderProperty | |
virtual vtkTypeBool | IsA (const char *type) |
Return 1 if this class is the same type of (or a subclass of) the named class. | |
vtkShaderProperty * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
void | DeepCopy (vtkShaderProperty *p) |
Assign one property to another. | |
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. | |
bool | HasVertexShaderCode () |
Allow the program to set the shader codes used directly instead of using the built in templates. | |
bool | HasFragmentShaderCode () |
Allow the program to set the shader codes used directly instead of using the built in templates. | |
bool | HasGeometryShaderCode () |
Allow the program to set the shader codes used directly instead of using the built in templates. | |
virtual void | SetVertexShaderCode (const char *) |
Allow the program to set the shader codes used directly instead of using the built in templates. | |
virtual char * | GetVertexShaderCode () |
Allow the program to set the shader codes used directly instead of using the built in templates. | |
virtual void | SetFragmentShaderCode (const char *) |
Allow the program to set the shader codes used directly instead of using the built in templates. | |
virtual char * | GetFragmentShaderCode () |
Allow the program to set the shader codes used directly instead of using the built in templates. | |
virtual void | SetGeometryShaderCode (const char *) |
Allow the program to set the shader codes used directly instead of using the built in templates. | |
virtual char * | GetGeometryShaderCode () |
Allow the program to set the shader codes used directly instead of using the built in templates. | |
virtual vtkUniforms * | GetFragmentCustomUniforms () |
The Uniforms object allows to set custom uniform variables that are used in replacement shader code. | |
virtual vtkUniforms * | GetVertexCustomUniforms () |
The Uniforms object allows to set custom uniform variables that are used in replacement shader code. | |
virtual vtkUniforms * | GetGeometryCustomUniforms () |
The Uniforms object allows to set custom uniform variables that are used in replacement shader code. | |
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) |
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. | |
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. | |
int | InvokeEvent (unsigned long event, void *callData) |
This method invokes an event and return whether the event was aborted or not. | |
int | InvokeEvent (const char *event, void *callData) |
This method invokes an event and return whether the event was aborted or not. | |
Public Member Functions inherited from vtkObjectBase | |
const char * | GetClassName () const |
Return the class name as a string. | |
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. | |
virtual 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. | |
Static Public Member Functions | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkOpenGLShaderProperty * | SafeDownCast (vtkObjectBase *o) |
static vtkOpenGLShaderProperty * | New () |
Construct object with no shader replacements. | |
Static Public Member Functions inherited from vtkShaderProperty | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkShaderProperty * | SafeDownCast (vtkObjectBase *o) |
static vtkShaderProperty * | New () |
Construct object with no shader replacements. | |
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 (int 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 int | 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 |
vtkOpenGLShaderProperty () | |
~vtkOpenGLShaderProperty () override | |
Protected Member Functions inherited from vtkShaderProperty | |
virtual vtkObjectBase * | NewInstanceInternal () 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. | |
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 *) |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Protected Attributes | |
ReplacementMap | UserShaderReplacements |
Protected Attributes inherited from vtkShaderProperty | |
char * | VertexShaderCode |
char * | FragmentShaderCode |
char * | GeometryShaderCode |
vtkNew< vtkUniforms > | FragmentCustomUniforms |
vtkNew< vtkUniforms > | VertexCustomUniforms |
vtkNew< vtkUniforms > | GeometryCustomUniforms |
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 () |
represent GPU shader properties
vtkOpenGLShaderProperty is used to hold user-defined modifications of a GPU shader program used in a mapper.
Definition at line 40 of file vtkOpenGLShaderProperty.h.
Definition at line 43 of file vtkOpenGLShaderProperty.h.
typedef std::map<vtkShader::ReplacementSpec, vtkShader::ReplacementValue> vtkOpenGLShaderProperty::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.
Definition at line 102 of file vtkOpenGLShaderProperty.h.
|
protected |
|
overrideprotected |
|
static |
|
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.
|
static |
|
protectedvirtual |
Reimplemented from vtkShaderProperty.
vtkOpenGLShaderProperty * vtkOpenGLShaderProperty::NewInstance | ( | ) | const |
|
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.
|
static |
Construct object with no shader replacements.
void vtkOpenGLShaderProperty::DeepCopy | ( | vtkOpenGLShaderProperty * | p | ) |
Assign one property to another.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
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.
void vtkOpenGLShaderProperty::ClearShaderReplacement | ( | vtkShader::Type | shaderType, |
const std::string & | originalValue, | ||
bool | replaceFirst | ||
) |
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.
void vtkOpenGLShaderProperty::ClearAllShaderReplacements | ( | vtkShader::Type | shaderType | ) |
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.
|
inline |
Definition at line 103 of file vtkOpenGLShaderProperty.h.
|
protected |
Definition at line 109 of file vtkOpenGLShaderProperty.h.