OpenXR manager graphics implementation. More...

#include <vtkOpenXRManagerGraphics.h>

Inheritance diagram for vtkOpenXRManagerGraphics:

Collaboration diagram for vtkOpenXRManagerGraphics:

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.

vtkOpenXRManagerGraphics *	NewInstance () const

virtual void	SetNumberOfSwapchains (uint32_t viewCount)=0
	Resize the internal vectors storing the color and depth swapchains.

uint32_t	GetChainLength (XrSwapchain swapchain)
	Acquire the number of images in the specified swapchain.

virtual bool	CreateGraphicsBinding (vtkOpenGLRenderWindow *helperWindow)=0
	Create the graphics binding and store it in GraphicsBindings ptr.

virtual const void *	GetGraphicsBinding ()=0
	Return pointer to the backend-specific XrGraphicsBindingXXX structure that is required to create the OpenXR session.

virtual bool	CheckGraphicsRequirements (XrInstance instance, XrSystemId id)=0
	OpenXR requires checking graphics requirements before creating a session.

virtual const char *	GetBackendExtensionName ()=0
	Return the extension name to enable a specific rendering backend.


virtual void	GetColorSwapchainImage (uint32_t eyeIndex, uint32_t imgIndex, void *texture)=0
	Fill `texture` with the swapchain image for the specified eye.

virtual void	GetDepthSwapchainImage (uint32_t eyeIndex, uint32_t imgIndex, void *texture)=0
	Fill `texture` with the swapchain image for the specified eye.


virtual void	EnumerateColorSwapchainImages (XrSwapchain swapchain, uint32_t eyeIndex)=0
	Acquire swapchain images using xrEnumerateSwapchainImages and store them at the specified eye index.

virtual void	EnumerateDepthSwapchainImages (XrSwapchain swapchain, uint32_t eyeIndex)=0
	Acquire swapchain images using xrEnumerateSwapchainImages and store them at the specified eye index.


virtual const std::vector< int64_t > &	GetSupportedColorFormats ()=0
	Return the list of pixel formats supported by VTK.

virtual const std::vector< int64_t > &	GetSupportedDepthFormats ()=0
	Return the list of pixel formats supported by VTK.

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)

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 std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

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.

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 vtkTypeBool	IsTypeOf (const char *type)

static vtkOpenXRManagerGraphics *	SafeDownCast (vtkObjectBase *o)

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

	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.

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 *)

virtual void	ObjectFinalize ()

	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

Detailed Description

OpenXR manager graphics implementation.

Abstract class that defines the rendering backend used by vtkOpenXRManager. It handles creation and management of the OpenXR rendering resources, based on the rendering backend implemented by subclasses.

See also: vtkOpenXRManagerOpenGLGraphics vtkOpenXRManagerD3DGraphics

Definition at line 28 of file vtkOpenXRManagerGraphics.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkOpenXRManagerGraphics::Superclass

Definition at line 31 of file vtkOpenXRManagerGraphics.h.

Constructor & Destructor Documentation

◆ vtkOpenXRManagerGraphics()

vtkOpenXRManagerGraphics::vtkOpenXRManagerGraphics ( )

protecteddefault

◆ ~vtkOpenXRManagerGraphics()

vtkOpenXRManagerGraphics::~vtkOpenXRManagerGraphics ( )

overrideprotecteddefault

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

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

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkOpenXRManagerGraphics::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented in vtkOpenXRManagerOpenGLGraphics, and vtkOpenXRManagerD3DGraphics.

◆ NewInstance()

vtkOpenXRManagerGraphics * vtkOpenXRManagerGraphics::NewInstance ( ) const

◆ SetNumberOfSwapchains()

virtual void vtkOpenXRManagerGraphics::SetNumberOfSwapchains ( uint32_t viewCount )

pure virtual

Resize the internal vectors storing the color and depth swapchains.

Implemented in vtkOpenXRManagerOpenGLGraphics, and vtkOpenXRManagerD3DGraphics.

◆ GetColorSwapchainImage()

virtual void vtkOpenXRManagerGraphics::GetColorSwapchainImage	(	uint32_t	eyeIndex,
		uint32_t	imgIndex,
		void *	texture
	)

pure virtual

Fill texture with the swapchain image for the specified eye.

The image index should be obtained beforehand using xrAcquireSwapchainImage.

Implemented in vtkOpenXRManagerOpenGLGraphics, and vtkOpenXRManagerD3DGraphics.

◆ GetDepthSwapchainImage()

virtual void vtkOpenXRManagerGraphics::GetDepthSwapchainImage	(	uint32_t	eyeIndex,
		uint32_t	imgIndex,
		void *	texture
	)

pure virtual

Fill texture with the swapchain image for the specified eye.

The image index should be obtained beforehand using xrAcquireSwapchainImage.

Implemented in vtkOpenXRManagerOpenGLGraphics, and vtkOpenXRManagerD3DGraphics.

◆ EnumerateColorSwapchainImages()

virtual void vtkOpenXRManagerGraphics::EnumerateColorSwapchainImages	(	XrSwapchain	swapchain,
		uint32_t	eyeIndex
	)

pure virtual

Acquire swapchain images using xrEnumerateSwapchainImages and store them at the specified eye index.

Implemented in vtkOpenXRManagerOpenGLGraphics, and vtkOpenXRManagerD3DGraphics.

◆ EnumerateDepthSwapchainImages()

virtual void vtkOpenXRManagerGraphics::EnumerateDepthSwapchainImages	(	XrSwapchain	swapchain,
		uint32_t	eyeIndex
	)

pure virtual

Acquire swapchain images using xrEnumerateSwapchainImages and store them at the specified eye index.

Implemented in vtkOpenXRManagerOpenGLGraphics, and vtkOpenXRManagerD3DGraphics.

◆ GetChainLength()

uint32_t vtkOpenXRManagerGraphics::GetChainLength ( XrSwapchain swapchain )

Acquire the number of images in the specified swapchain.

◆ GetSupportedColorFormats()

virtual const std::vector< int64_t > & vtkOpenXRManagerGraphics::GetSupportedColorFormats ( )

pure virtual

Return the list of pixel formats supported by VTK.

The first pixel format in the list that is also supported by the runtime will be picked for rendering.

Implemented in vtkOpenXRManagerOpenGLGraphics, and vtkOpenXRManagerD3DGraphics.

◆ GetSupportedDepthFormats()

virtual const std::vector< int64_t > & vtkOpenXRManagerGraphics::GetSupportedDepthFormats ( )

pure virtual

Return the list of pixel formats supported by VTK.

The first pixel format in the list that is also supported by the runtime will be picked for rendering.

Implemented in vtkOpenXRManagerOpenGLGraphics, and vtkOpenXRManagerD3DGraphics.

◆ CreateGraphicsBinding()

virtual bool vtkOpenXRManagerGraphics::CreateGraphicsBinding ( vtkOpenGLRenderWindow * helperWindow )

pure virtual

Create the graphics binding and store it in GraphicsBindings ptr.

It points to a XrGraphicsBindingXXX structure, depending on the desired rendering backend.

Precondition: helperWindow must be initialized

Implemented in vtkOpenXRManagerOpenGLGraphics, and vtkOpenXRManagerD3DGraphics.

◆ GetGraphicsBinding()

virtual const void * vtkOpenXRManagerGraphics::GetGraphicsBinding ( )

pure virtual

Return pointer to the backend-specific XrGraphicsBindingXXX structure that is required to create the OpenXR session.

Implemented in vtkOpenXRManagerOpenGLGraphics, and vtkOpenXRManagerD3DGraphics.

◆ CheckGraphicsRequirements()

virtual bool vtkOpenXRManagerGraphics::CheckGraphicsRequirements	(	XrInstance	instance,
		XrSystemId	id
	)

pure virtual

OpenXR requires checking graphics requirements before creating a session.

This uses a function pointer loaded with the selected graphics API extension. /pre The XR instance and system id must be initialized

Implemented in vtkOpenXRManagerOpenGLGraphics, and vtkOpenXRManagerD3DGraphics.

◆ GetBackendExtensionName()

virtual const char * vtkOpenXRManagerGraphics::GetBackendExtensionName ( )

pure virtual

Return the extension name to enable a specific rendering backend.

Implemented in vtkOpenXRManagerOpenGLGraphics, and vtkOpenXRManagerD3DGraphics.

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

Rendering/OpenXR/vtkOpenXRManagerGraphics.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkOpenXRManagerGraphics()

◆ ~vtkOpenXRManagerGraphics()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ SetNumberOfSwapchains()

◆ GetColorSwapchainImage()

◆ GetDepthSwapchainImage()

◆ EnumerateColorSwapchainImages()

◆ EnumerateDepthSwapchainImages()

◆ GetChainLength()

◆ GetSupportedColorFormats()

◆ GetSupportedDepthFormats()

◆ CreateGraphicsBinding()

◆ GetGraphicsBinding()

◆ CheckGraphicsRequirements()

◆ GetBackendExtensionName()