VTK  9.7.20261119
vtkSlangShaderManager Class Reference

#include <vtkSlangShaderManager.h>

Detailed Description

compile Slang shaders to WGSL with SlangKit

vtkSlangShaderManager compiles Slang source to WGSL and reflects the bindings of the result. When VTK is built without SlangKit (VTK_USE_SLANG is OFF), IsSlangAvailable() returns false and every compile fails with a diagnostic.

GetLastBindings(), GetLastPlan() and GetLastDiagnostics() describe the most recent compile on an instance, so an instance must not be shared by threads that compile at the same time. Use one instance per thread, or hold a lock from a compile until its results have been read.

Tests:
vtkSlangShaderManager (Tests)

Definition at line 34 of file vtkSlangShaderManager.h.

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

Classes

struct  UniformField
struct  Binding
struct  Plan
struct  HostValue

Public Types

enum  PackStatus {
  Packed , NoField , Unsupported , ScalarMismatch ,
  ShapeMismatch
}
typedef vtkObject Superclass
using StringPairs = std::vector<std::pair<std::string, std::string>>

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.
vtkSlangShaderManager * NewInstance () const
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
std::string CompileSourceToWGSL (const std::string &source, const std::vector< std::string > &entryPoints={})
VTK_WRAPEXCLUDE std::string CompileSourceToWGSL (const std::string &source, const std::vector< std::string > &entryPoints, const StringPairs &defines, const std::vector< std::string > &modules, const StringPairs &specializations, const std::vector< std::string > &searchPaths={}, const std::string &label=std::string())
void SetCacheDirectory (const std::string &directory)
VTK_WRAPEXCLUDE const std::vector< Binding > & GetLastBindings () const
VTK_WRAPEXCLUDE Plan GetLastPlan (const std::function< bool(const Binding &)> &hostOwned) const
const std::string & GetLastDiagnostics () const
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 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)
vtkTypeBool InvokeEvent (unsigned long event)
vtkTypeBool InvokeEvent (const char *event)
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
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.
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
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.
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.
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not.

Static Public Member Functions

static vtkSlangShaderManager * New ()
static vtkTypeBool IsTypeOf (const char *type)
static vtkSlangShaderManager * SafeDownCast (vtkObjectBase *o)
static bool IsSlangAvailable ()
static std::vector< std::string > GetLibraryModules ()
static std::string GetLibraryModuleSource (const std::string &name)
static bool WriteLibraryModules (const std::string &directory)
static VTK_WRAPEXCLUDE std::vector< std::uint8_t > BlockBytes (const Plan &plan, size_t block)
static VTK_WRAPEXCLUDE PackStatus Pack (const Plan &plan, size_t block, const std::string &field, const HostValue &value, std::vector< std::uint8_t > &bytes)
static VTK_WRAPEXCLUDE std::vector< std::string > Unmatched (const Plan &plan, const std::vector< std::string > &names)
static VTK_WRAPEXCLUDE std::string GetParameterSchema (const Plan &plan)
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 (vtkTypeBool 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 vtkTypeBool 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
 vtkSlangShaderManager ()
 ~vtkSlangShaderManager () 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 ReportReferences (vtkGarbageCollector *)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Additional Inherited Members

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
static vtkReallocingFunction GetCurrentReallocFunction ()
static vtkFreeingFunction GetCurrentFreeFunction ()
static vtkFreeingFunction GetAlternateFreeFunction ()
Protected Attributes inherited from vtkObject
bool Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
std::string ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
vtkWeakPointerBase ** WeakPointers

Member Typedef Documentation

◆ Superclass

◆ StringPairs

using vtkSlangShaderManager::StringPairs = std::vector<std::pair<std::string, std::string>>

Definition at line 46 of file vtkSlangShaderManager.h.

Member Enumeration Documentation

◆ PackStatus

Enumerator
Packed 
NoField 
Unsupported 
ScalarMismatch 
ShapeMismatch 

Definition at line 141 of file vtkSlangShaderManager.h.

Constructor & Destructor Documentation

◆ vtkSlangShaderManager()

vtkSlangShaderManager::vtkSlangShaderManager ( )
protected

◆ ~vtkSlangShaderManager()

vtkSlangShaderManager::~vtkSlangShaderManager ( )
overrideprotected

Member Function Documentation

◆ New()

vtkSlangShaderManager * vtkSlangShaderManager::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkSlangShaderManager::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()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkSlangShaderManager::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkSlangShaderManager * vtkSlangShaderManager::NewInstance ( ) const

◆ PrintSelf()

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

◆ IsSlangAvailable()

bool vtkSlangShaderManager::IsSlangAvailable ( )
static

◆ CompileSourceToWGSL() [1/2]

std::string vtkSlangShaderManager::CompileSourceToWGSL ( const std::string & source,
const std::vector< std::string > & entryPoints = {} )

◆ CompileSourceToWGSL() [2/2]

VTK_WRAPEXCLUDE std::string vtkSlangShaderManager::CompileSourceToWGSL ( const std::string & source,
const std::vector< std::string > & entryPoints,
const StringPairs & defines,
const std::vector< std::string > & modules,
const StringPairs & specializations,
const std::vector< std::string > & searchPaths = {},
const std::string & label = std::string() )

◆ SetCacheDirectory()

void vtkSlangShaderManager::SetCacheDirectory ( const std::string & directory)

◆ GetLibraryModules()

std::vector< std::string > vtkSlangShaderManager::GetLibraryModules ( )
static

◆ GetLibraryModuleSource()

std::string vtkSlangShaderManager::GetLibraryModuleSource ( const std::string & name)
static

◆ WriteLibraryModules()

bool vtkSlangShaderManager::WriteLibraryModules ( const std::string & directory)
static

◆ GetLastBindings()

VTK_WRAPEXCLUDE const std::vector< Binding > & vtkSlangShaderManager::GetLastBindings ( ) const

◆ GetLastPlan()

VTK_WRAPEXCLUDE Plan vtkSlangShaderManager::GetLastPlan ( const std::function< bool(const Binding &)> & hostOwned) const

◆ BlockBytes()

VTK_WRAPEXCLUDE std::vector< std::uint8_t > vtkSlangShaderManager::BlockBytes ( const Plan & plan,
size_t block )
static

◆ Pack()

VTK_WRAPEXCLUDE PackStatus vtkSlangShaderManager::Pack ( const Plan & plan,
size_t block,
const std::string & field,
const HostValue & value,
std::vector< std::uint8_t > & bytes )
static

◆ Unmatched()

VTK_WRAPEXCLUDE std::vector< std::string > vtkSlangShaderManager::Unmatched ( const Plan & plan,
const std::vector< std::string > & names )
static

◆ GetParameterSchema()

VTK_WRAPEXCLUDE std::string vtkSlangShaderManager::GetParameterSchema ( const Plan & plan)
static

◆ GetLastDiagnostics()

const std::string & vtkSlangShaderManager::GetLastDiagnostics ( ) const

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