ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Static Private Member Functions
Kitware.VTK.vtkGLSLShader Class Reference

vtkGLSLShader - GLSL Shader More...

Inheritance diagram for Kitware.VTK.vtkGLSLShader:
[legend]
Collaboration diagram for Kitware.VTK.vtkGLSLShader:
[legend]

List of all members.

Public Member Functions

 vtkGLSLShader (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkGLSLShader ()
 *Undocumented Block
override int Compile ()
 Called to compile the shader code. The subclasses must only compile the code in this method. Returns if the compile was successful. Subclasses should compile the code only if it was not already compiled.
uint GetHandle ()
 The vtkGLSLShaderProgram needs the shader handle for attaching.
virtual uint GetProgram ()
 The Shader needs the id of the ShaderProgram to obtain uniform variable locations. This is set by vtkGLSLShaderProgram.
override int IsA (string type)
 *Undocumented Block
new vtkGLSLShader NewInstance ()
 *Undocumented Block
override void ReleaseGraphicsResources (vtkWindow arg0)
 Release any graphics resources that are being consumed by this actor. The parameter window could be used to determine which graphic resources to release.
virtual void SetProgram (uint _arg)
 The Shader needs the id of the ShaderProgram to obtain uniform variable locations. This is set by vtkGLSLShaderProgram.
- Public Member Functions inherited from Kitware.VTK.vtkShader
 vtkShader (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
void AddShaderVariable (string name, int num_of_elements, IntPtr values)
 Methods to add shader variables to this shader. The shader variable type must match with that declared in the Material xml, otherwise, the variable is not made available to the shader.
virtual void Bind ()
 In this method the shader can enable/bind itself. This is applicable only to Cg, since in GLSL, individual shaders in a program can't be enabled/bound.
int GetScope ()
 Returns the scope of the shader i.e. if it's a vertex or fragment shader. (vtkXMLShader::SCOPE_VERTEX or vtkXMLShader::SCOPE_FRAGMENT).
int GetShaderVariable (string name, IntPtr values)
 Methods to get the value of shader variables with the given name. Values must be at least the size of the shader variable (obtained by GetShaderVariableSize(). Returns if the operation was successful.
int GetShaderVariableSize (string name)
 Get number of elements in a Shader variable. Return 0 if failed to find the shader variable.
int GetShaderVariableType (string name)
 Returns the type of a Shader variable with the given name. Return 0 on error.
virtual vtkXMLShader GetXMLShader ()
 Get/Set the XMLShader representation for this shader. A shader is not valid without a XMLShader.
int HasShaderVariable (string name)
 Indicates if a variable by the given name exists.
virtual void PassShaderVariables (vtkActor actor, vtkRenderer ren)
 Called to pass VTK actor/property/light values and other Shader variables over to the shader. This is called by the ShaderProgram during each render.
void SetXMLShader (vtkXMLShader arg0)
 Get/Set the XMLShader representation for this shader. A shader is not valid without a XMLShader.
virtual void Unbind ()
 Called to unbind the shader. As with Bind(), this is only applicable to Cg.
- Public Member Functions inherited from Kitware.VTK.vtkObject
 vtkObject (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkObject ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
uint AddObserver (uint arg0, vtkCommand arg1, float priority)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
uint AddObserver (string arg0, vtkCommand arg1, float priority)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void DebugOff ()
 Turn debugging output off.
virtual void DebugOn ()
 Turn debugging output on.
vtkCommand GetCommand (uint tag)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
byte GetDebug ()
 Get the value of the debug flag.
virtual uint GetMTime ()
 Return this object's modified time.
int HasObserver (uint arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (string arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (uint arg0, IntPtr callData)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (string arg0, IntPtr callData)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void Modified ()
 Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. The modification time is a unique monotonically increasing unsigned long integer.
void RemoveAllObservers ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObserver (vtkCommand arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObserver (uint tag)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (uint arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (string arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void SetDebug (byte debugFlag)
 Set the value of the debug flag. A non-zero value turns debugging on.
override string ToString ()
 Returns the result of calling vtkObject::Print as a C# string.
delegate void vtkObjectEventHandler (vtkObject sender, vtkObjectEventArgs e)
 Generic signature for all vtkObject events.
void RemoveAllHandlersForAllEvents ()
 Call RemoveAllHandlers on each non-null vtkObjectEventRelay. TODO: This method needs to get called by the generated Dispose. Make that happen...
- Public Member Functions inherited from Kitware.VTK.vtkObjectBase
 vtkObjectBase (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkObjectBase ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
virtual void Register (vtkObjectBase o)
 Increase the reference count (mark as used by another object).
virtual void FastDelete ()
 Delete a reference to this object. This version will not invoke garbage collection and can potentially leak the object if it is part of a reference loop. Use this method only when it is known that the object has another reference and would not be collected if a full garbage collection check were done.
string GetClassName ()
 Return the class name as a string. This method is defined in all subclasses of vtkObjectBase with the vtkTypeMacro found in vtkSetGet.h.
int GetReferenceCount ()
 Return the current reference count of this object.
void SetReferenceCount (int arg0)
 Sets the reference count. (This is very dangerous, use with care.)

Static Public Member Functions

static new vtkGLSLShader New ()
 *Undocumented Block
static new int IsTypeOf (string type)
 *Undocumented Block
static new vtkGLSLShader SafeDownCast (vtkObjectBase o)
 *Undocumented Block

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkGLSLShader"
 Automatically generated type registration mechanics.
- Public Attributes inherited from Kitware.VTK.vtkShader
- Public Attributes inherited from Kitware.VTK.vtkObject
- Public Attributes inherited from Kitware.VTK.vtkObjectBase
- Public Attributes inherited from Kitware.VTK.WrappedObject
const string vtkChartsEL_dll = "libKitware.VTK.vtkCharts.Unmanaged.so"
 Export layer functions for 'vtkCharts' are exported from the DLL named by the value of this variable.
const string vtkCommonEL_dll = "libKitware.VTK.vtkCommon.Unmanaged.so"
 Export layer functions for 'vtkCommon' are exported from the DLL named by the value of this variable.
const string vtkFilteringEL_dll = "libKitware.VTK.vtkFiltering.Unmanaged.so"
 Export layer functions for 'vtkFiltering' are exported from the DLL named by the value of this variable.
const string vtkGenericFilteringEL_dll = "libKitware.VTK.vtkGenericFiltering.Unmanaged.so"
 Export layer functions for 'vtkGenericFiltering' are exported from the DLL named by the value of this variable.
const string vtkGeovisEL_dll = "libKitware.VTK.vtkGeovis.Unmanaged.so"
 Export layer functions for 'vtkGeovis' are exported from the DLL named by the value of this variable.
const string vtkGraphicsEL_dll = "libKitware.VTK.vtkGraphics.Unmanaged.so"
 Export layer functions for 'vtkGraphics' are exported from the DLL named by the value of this variable.
const string vtkHybridEL_dll = "libKitware.VTK.vtkHybrid.Unmanaged.so"
 Export layer functions for 'vtkHybrid' are exported from the DLL named by the value of this variable.
const string vtkIOEL_dll = "libKitware.VTK.vtkIO.Unmanaged.so"
 Export layer functions for 'vtkIO' are exported from the DLL named by the value of this variable.
const string vtkImagingEL_dll = "libKitware.VTK.vtkImaging.Unmanaged.so"
 Export layer functions for 'vtkImaging' are exported from the DLL named by the value of this variable.
const string vtkInfovisEL_dll = "libKitware.VTK.vtkInfovis.Unmanaged.so"
 Export layer functions for 'vtkInfovis' are exported from the DLL named by the value of this variable.
const string vtkParallelEL_dll = "libKitware.VTK.vtkParallel.Unmanaged.so"
 Export layer functions for 'vtkParallel' are exported from the DLL named by the value of this variable.
const string vtkRenderingEL_dll = "libKitware.VTK.vtkRendering.Unmanaged.so"
 Export layer functions for 'vtkRendering' are exported from the DLL named by the value of this variable.
const string vtkViewsEL_dll = "libKitware.VTK.vtkViews.Unmanaged.so"
 Export layer functions for 'vtkViews' are exported from the DLL named by the value of this variable.
const string vtkVolumeRenderingEL_dll = "libKitware.VTK.vtkVolumeRendering.Unmanaged.so"
 Export layer functions for 'vtkVolumeRendering' are exported from the DLL named by the value of this variable.
const string vtkWidgetsEL_dll = "libKitware.VTK.vtkWidgets.Unmanaged.so"
 Export layer functions for 'vtkWidgets' are exported from the DLL named by the value of this variable.

Static Public Attributes

static new readonly string MRClassNameKey = "13vtkGLSLShader"
 Automatically generated type registration mechanics.
- Static Public Attributes inherited from Kitware.VTK.vtkShader
- Static Public Attributes inherited from Kitware.VTK.vtkObject
- Static Public Attributes inherited from Kitware.VTK.vtkObjectBase

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Static Private Member Functions

static vtkGLSLShader ()
 Automatically generated type registration mechanics.

Detailed Description

vtkGLSLShader - GLSL Shader

Description vtkGLSLShader is a concrete class that creates and compiles hardware shaders written in the OpenGL Shadering Language (GLSL, OpenGL2.0). While step linking a vertex and a fragment shader is performed by vtkGLSLShaderProgram, all shader parameters are initialized in this class.

.Section vtkOpenGLExtensionManager All OpenGL calls are made through vtkOpenGLExtensionManager.

.Section Supported Basic Shader Types:

Scalar Types uniform float uniform int uniform int – boolean scalar not yet tested

Vector Types: uniform vec{2|3|4} uniform ivec{2|3|4} uniform bvec{2|3|4} – boolean vector not yet tested

Matrix Types: uniform mat{2|3|4}

Texture Samplers: sample1D – Not yet implemented in this cless. sample2D – Not yet implemented in this class. sample3D – Not yet implemented in this class. sampler1DShadow – Not yet implemented in this class. sampler1DShadow – Not yet implemented in this class.

User-Defined structures: uniform struct NOTE: these must be defined and declared outside of the 'main' shader function.

Thanks Shader support in VTK includes key contributions by Gary Templet at Sandia National Labs.


Constructor & Destructor Documentation

static Kitware.VTK.vtkGLSLShader.vtkGLSLShader ( )
staticprivate

Automatically generated type registration mechanics.

Kitware.VTK.vtkGLSLShader.vtkGLSLShader ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Kitware.VTK.vtkGLSLShader.vtkGLSLShader ( )

*Undocumented Block


Member Function Documentation

override int Kitware.VTK.vtkGLSLShader.Compile ( )
virtual

Called to compile the shader code. The subclasses must only compile the code in this method. Returns if the compile was successful. Subclasses should compile the code only if it was not already compiled.

Reimplemented from Kitware.VTK.vtkShader.

override void Kitware.VTK.vtkGLSLShader.Dispose ( bool  disposing)
protected

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkShader.

uint Kitware.VTK.vtkGLSLShader.GetHandle ( )

The vtkGLSLShaderProgram needs the shader handle for attaching.

virtual uint Kitware.VTK.vtkGLSLShader.GetProgram ( )
virtual

The Shader needs the id of the ShaderProgram to obtain uniform variable locations. This is set by vtkGLSLShaderProgram.

override int Kitware.VTK.vtkGLSLShader.IsA ( string  type)
virtual

*Undocumented Block

Reimplemented from Kitware.VTK.vtkShader.

static new int Kitware.VTK.vtkGLSLShader.IsTypeOf ( string  type)
static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkShader.

static new vtkGLSLShader Kitware.VTK.vtkGLSLShader.New ( )
static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkObject.

new vtkGLSLShader Kitware.VTK.vtkGLSLShader.NewInstance ( )

*Undocumented Block

Reimplemented from Kitware.VTK.vtkShader.

override void Kitware.VTK.vtkGLSLShader.ReleaseGraphicsResources ( vtkWindow  arg0)
virtual

Release any graphics resources that are being consumed by this actor. The parameter window could be used to determine which graphic resources to release.

Reimplemented from Kitware.VTK.vtkShader.

static new vtkGLSLShader Kitware.VTK.vtkGLSLShader.SafeDownCast ( vtkObjectBase  o)
static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkShader.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkGLSLShader.SetProgram ( uint  _arg)
virtual

The Shader needs the id of the ShaderProgram to obtain uniform variable locations. This is set by vtkGLSLShaderProgram.


Member Data Documentation

new readonly string Kitware.VTK.vtkGLSLShader.MRClassNameKey = "13vtkGLSLShader"
static

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkShader.

new const string Kitware.VTK.vtkGLSLShader.MRFullTypeName = "Kitware.VTK.vtkGLSLShader"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkShader.


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