VTK  9.3.20240329
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkOpenXRManagerD3DGraphics Class Reference

OpenXR manager D3D graphics implementation. More...

#include <vtkOpenXRManagerD3DGraphics.h>

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

Classes

struct  SwapchainImagesD3D
 D3D structure to store swapchain images. More...
 

Public Types

typedef vtkOpenXRManagerGraphics Superclass
 
- Public Types inherited from vtkOpenXRManagerGraphics
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...
 
vtkOpenXRManagerD3DGraphicsNewInstance () const
 
void SetNumberOfSwapchains (uint32_t viewCount) override
 Resize the internal vectors storing the color and depth swapchains. More...
 
bool CreateGraphicsBinding (vtkOpenGLRenderWindow *helperWindow) override
 Fill the pointer to the XrGraphicsBindingD3D11 structure. More...
 
const void * GetGraphicsBinding () override
 Return pointer to the XrGraphicsBindingD3D11 structure required to create the OpenXR session. More...
 
bool CheckGraphicsRequirements (XrInstance instance, XrSystemId id) override
 Verify that the D3D feature levels supported by the runtime match the ones supported by vtkWin32OpenGLDXRenderWindow. More...
 
const char * GetBackendExtensionName () override
 Return the extension name corresponding to the D3D11 rendering backend. More...
 
void GetColorSwapchainImage (uint32_t scIndex, uint32_t imgIndex, void *texture) override
 Fill texture with the D3D Texture2D for the specified eye scIndex. More...
 
void GetDepthSwapchainImage (uint32_t scIndex, uint32_t imgIndex, void *texture) override
 Fill texture with the D3D Texture2D for the specified eye scIndex. More...
 
void EnumerateColorSwapchainImages (XrSwapchain swapchain, uint32_t scIndex) override
 Acquire D3D swapchain images for the specified eye index. More...
 
void EnumerateDepthSwapchainImages (XrSwapchain swapchain, uint32_t scIndex) override
 Acquire D3D swapchain images for the specified eye index. More...
 
const std::vector< int64_t > & GetSupportedColorFormats () override
 Return the list of DXGI_FORMAT supported by vtkWin32OpenGLDXRenderWindow. More...
 
const std::vector< int64_t > & GetSupportedDepthFormats () override
 Return the list of DXGI_FORMAT supported by vtkWin32OpenGLDXRenderWindow. More...
 
- Public Member Functions inherited from vtkOpenXRManagerGraphics
vtkOpenXRManagerGraphicsNewInstance () const
 
uint32_t GetChainLength (XrSwapchain swapchain)
 Acquire the number of images in the specified swapchain. More...
 
- 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...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
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. 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)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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)
 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, 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...
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes. More...
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes. More...
 
- 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...
 
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...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not. More...
 

Static Public Member Functions

static vtkOpenXRManagerD3DGraphicsNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkOpenXRManagerD3DGraphicsSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkOpenXRManagerGraphics
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkOpenXRManagerGraphicsSafeDownCast (vtkObjectBase *o)
 
- 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 (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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
 
 vtkOpenXRManagerD3DGraphics ()
 
 ~vtkOpenXRManagerD3DGraphics () override
 
void EnumerateSwapchainImages (XrSwapchain swapchain, SwapchainImagesD3D &swapchainImages)
 Acquire D3D swapchain images an store them in swapchainImages. More...
 
- Protected Member Functions inherited from vtkOpenXRManagerGraphics
 vtkOpenXRManagerGraphics ()=default
 
 ~vtkOpenXRManagerGraphics () override=default
 
- 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 ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

std::shared_ptr< XrGraphicsBindingD3D11KHR > GraphicsBinding
 
- 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
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

OpenXR manager D3D graphics implementation.

Allow vtkOpenXRManager to use a D3D rendering backend.

Definition at line 26 of file vtkOpenXRManagerD3DGraphics.h.

Member Typedef Documentation

◆ Superclass

Definition at line 31 of file vtkOpenXRManagerD3DGraphics.h.

Constructor & Destructor Documentation

◆ vtkOpenXRManagerD3DGraphics()

vtkOpenXRManagerD3DGraphics::vtkOpenXRManagerD3DGraphics ( )
protected

◆ ~vtkOpenXRManagerD3DGraphics()

vtkOpenXRManagerD3DGraphics::~vtkOpenXRManagerD3DGraphics ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkOpenXRManagerD3DGraphics* vtkOpenXRManagerD3DGraphics::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkOpenXRManagerD3DGraphics::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkOpenXRManagerGraphics.

◆ NewInstance()

vtkOpenXRManagerD3DGraphics* vtkOpenXRManagerD3DGraphics::NewInstance ( ) const

◆ SetNumberOfSwapchains()

void vtkOpenXRManagerD3DGraphics::SetNumberOfSwapchains ( uint32_t  viewCount)
overridevirtual

Resize the internal vectors storing the color and depth swapchains.

Implements vtkOpenXRManagerGraphics.

◆ GetColorSwapchainImage()

void vtkOpenXRManagerD3DGraphics::GetColorSwapchainImage ( uint32_t  scIndex,
uint32_t  imgIndex,
void *  texture 
)
overridevirtual

Fill texture with the D3D Texture2D for the specified eye scIndex.

The image index imgIndex should be obtained beforehand using xrAcquireSwapchainImage.

Implements vtkOpenXRManagerGraphics.

◆ GetDepthSwapchainImage()

void vtkOpenXRManagerD3DGraphics::GetDepthSwapchainImage ( uint32_t  scIndex,
uint32_t  imgIndex,
void *  texture 
)
overridevirtual

Fill texture with the D3D Texture2D for the specified eye scIndex.

The image index imgIndex should be obtained beforehand using xrAcquireSwapchainImage.

Implements vtkOpenXRManagerGraphics.

◆ EnumerateColorSwapchainImages()

void vtkOpenXRManagerD3DGraphics::EnumerateColorSwapchainImages ( XrSwapchain  swapchain,
uint32_t  scIndex 
)
overridevirtual

Acquire D3D swapchain images for the specified eye index.

Implements vtkOpenXRManagerGraphics.

◆ EnumerateDepthSwapchainImages()

void vtkOpenXRManagerD3DGraphics::EnumerateDepthSwapchainImages ( XrSwapchain  swapchain,
uint32_t  scIndex 
)
overridevirtual

Acquire D3D swapchain images for the specified eye index.

Implements vtkOpenXRManagerGraphics.

◆ GetSupportedColorFormats()

const std::vector<int64_t>& vtkOpenXRManagerD3DGraphics::GetSupportedColorFormats ( )
overridevirtual

Return the list of DXGI_FORMAT supported by vtkWin32OpenGLDXRenderWindow.

The first in the list that is also supported by the runtime is picked.

Implements vtkOpenXRManagerGraphics.

◆ GetSupportedDepthFormats()

const std::vector<int64_t>& vtkOpenXRManagerD3DGraphics::GetSupportedDepthFormats ( )
overridevirtual

Return the list of DXGI_FORMAT supported by vtkWin32OpenGLDXRenderWindow.

The first in the list that is also supported by the runtime is picked.

Implements vtkOpenXRManagerGraphics.

◆ CreateGraphicsBinding()

bool vtkOpenXRManagerD3DGraphics::CreateGraphicsBinding ( vtkOpenGLRenderWindow helperWindow)
overridevirtual

Fill the pointer to the XrGraphicsBindingD3D11 structure.

Implements vtkOpenXRManagerGraphics.

◆ GetGraphicsBinding()

const void* vtkOpenXRManagerD3DGraphics::GetGraphicsBinding ( )
inlineoverridevirtual

Return pointer to the XrGraphicsBindingD3D11 structure required to create the OpenXR session.

Implements vtkOpenXRManagerGraphics.

Definition at line 72 of file vtkOpenXRManagerD3DGraphics.h.

◆ CheckGraphicsRequirements()

bool vtkOpenXRManagerD3DGraphics::CheckGraphicsRequirements ( XrInstance  instance,
XrSystemId  id 
)
overridevirtual

Verify that the D3D feature levels supported by the runtime match the ones supported by vtkWin32OpenGLDXRenderWindow.

Implements vtkOpenXRManagerGraphics.

◆ GetBackendExtensionName()

const char* vtkOpenXRManagerD3DGraphics::GetBackendExtensionName ( )
overridevirtual

Return the extension name corresponding to the D3D11 rendering backend.

Implements vtkOpenXRManagerGraphics.

◆ EnumerateSwapchainImages()

void vtkOpenXRManagerD3DGraphics::EnumerateSwapchainImages ( XrSwapchain  swapchain,
SwapchainImagesD3D swapchainImages 
)
protected

Acquire D3D swapchain images an store them in swapchainImages.

Member Data Documentation

◆ GraphicsBinding

std::shared_ptr<XrGraphicsBindingD3D11KHR> vtkOpenXRManagerD3DGraphics::GraphicsBinding
protected

Definition at line 102 of file vtkOpenXRManagerD3DGraphics.h.


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