OpenXR manager OpenGL graphics implementation. More...

#include <vtkOpenXRManagerOpenGLGraphics.h>

Inheritance diagram for vtkOpenXRManagerOpenGLGraphics:

Collaboration diagram for vtkOpenXRManagerOpenGLGraphics:

Classes
struct	SwapchainImagesOpenGL
	OpenGL 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.

vtkOpenXRManagerOpenGLGraphics *	NewInstance () const

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

bool	CreateGraphicsBinding (vtkOpenGLRenderWindow *helperWindow) override
	Fill the pointer to the XrGraphicsBindingOpenGL structure.

const void *	GetGraphicsBinding () override
	Return pointer to the XrGraphicsBindingOpenGL structure required to create the OpenXR session.

bool	CheckGraphicsRequirements (XrInstance instance, XrSystemId id) override
	Check OpenGL version supported by the runtime.

const char *	GetBackendExtensionName () override
	Return the extension name corresponding to the OpenGL rendering backend.


void	GetColorSwapchainImage (uint32_t scIndex, uint32_t imgIndex, void *texture) override
	Fill `texture` with the OpenGL texture id for the specified eye `scIndex`.

void	GetDepthSwapchainImage (uint32_t scIndex, uint32_t imgIndex, void *texture) override
	Fill `texture` with the OpenGL texture id for the specified eye `scIndex`.


void	EnumerateColorSwapchainImages (XrSwapchain swapchain, uint32_t scIndex) override
	Acquire OpenGL swapchain images for the specified eye index.

void	EnumerateDepthSwapchainImages (XrSwapchain swapchain, uint32_t scIndex) override
	Acquire OpenGL swapchain images for the specified eye index.


const std::vector< int64_t > &	GetSupportedColorFormats () override
	Return the list of GL formats supported by vtkOpenGLRenderWindow.

const std::vector< int64_t > &	GetSupportedDepthFormats () override
	Return the list of GL formats supported by vtkOpenGLRenderWindow.

Public Member Functions inherited from vtkOpenXRManagerGraphics
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.

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 vtkOpenXRManagerOpenGLGraphics *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkOpenXRManagerOpenGLGraphics *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkOpenXRManagerGraphics
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

	vtkOpenXRManagerOpenGLGraphics ()

	~vtkOpenXRManagerOpenGLGraphics () override

void	EnumerateSwapchainImages (XrSwapchain swapchain, SwapchainImagesOpenGL &swapchainImages)
	Acquire OpenGL swapchain images an store them in `swapchainImages`.

Protected Member Functions inherited from vtkOpenXRManagerGraphics
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 &)

Protected Attributes
std::shared_ptr< XrGraphicsBindingOpenGL >	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 OpenGL graphics implementation.

Allow vtkOpenXRManager to use an OpenGL rendering backend.

Definition at line 33 of file vtkOpenXRManagerOpenGLGraphics.h.

Member Typedef Documentation

◆ Superclass

typedef vtkOpenXRManagerGraphics vtkOpenXRManagerOpenGLGraphics::Superclass

Definition at line 37 of file vtkOpenXRManagerOpenGLGraphics.h.

Constructor & Destructor Documentation

◆ vtkOpenXRManagerOpenGLGraphics()

vtkOpenXRManagerOpenGLGraphics::vtkOpenXRManagerOpenGLGraphics ( )

protected

◆ ~vtkOpenXRManagerOpenGLGraphics()

vtkOpenXRManagerOpenGLGraphics::~vtkOpenXRManagerOpenGLGraphics ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkOpenXRManagerOpenGLGraphics * vtkOpenXRManagerOpenGLGraphics::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkOpenXRManagerOpenGLGraphics::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 vtkOpenXRManagerOpenGLGraphics * vtkOpenXRManagerOpenGLGraphics::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkOpenXRManagerOpenGLGraphics::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkOpenXRManagerGraphics.

◆ NewInstance()

vtkOpenXRManagerOpenGLGraphics * vtkOpenXRManagerOpenGLGraphics::NewInstance ( ) const

◆ SetNumberOfSwapchains()

void vtkOpenXRManagerOpenGLGraphics::SetNumberOfSwapchains ( uint32_t viewCount )

overridevirtual

Resize the internal vectors storing the color and depth swapchains.

Implements vtkOpenXRManagerGraphics.

◆ GetColorSwapchainImage()

void vtkOpenXRManagerOpenGLGraphics::GetColorSwapchainImage	(	uint32_t	scIndex,
		uint32_t	imgIndex,
		void *	texture
	)

overridevirtual

Fill texture with the OpenGL texture id for the specified eye scIndex.

The image index imgIndex should be obtained beforehand using xrAcquireSwapchainImage.

Implements vtkOpenXRManagerGraphics.

◆ GetDepthSwapchainImage()

void vtkOpenXRManagerOpenGLGraphics::GetDepthSwapchainImage	(	uint32_t	scIndex,
		uint32_t	imgIndex,
		void *	texture
	)

overridevirtual

Fill texture with the OpenGL texture id for the specified eye scIndex.

The image index imgIndex should be obtained beforehand using xrAcquireSwapchainImage.

Implements vtkOpenXRManagerGraphics.

◆ EnumerateColorSwapchainImages()

void vtkOpenXRManagerOpenGLGraphics::EnumerateColorSwapchainImages	(	XrSwapchain	swapchain,
		uint32_t	scIndex
	)

overridevirtual

Acquire OpenGL swapchain images for the specified eye index.

Implements vtkOpenXRManagerGraphics.

◆ EnumerateDepthSwapchainImages()

void vtkOpenXRManagerOpenGLGraphics::EnumerateDepthSwapchainImages	(	XrSwapchain	swapchain,
		uint32_t	scIndex
	)

overridevirtual

Acquire OpenGL swapchain images for the specified eye index.

Implements vtkOpenXRManagerGraphics.

◆ GetSupportedColorFormats()

const std::vector< int64_t > & vtkOpenXRManagerOpenGLGraphics::GetSupportedColorFormats ( )

overridevirtual

Return the list of GL formats supported by vtkOpenGLRenderWindow.

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

Implements vtkOpenXRManagerGraphics.

◆ GetSupportedDepthFormats()

const std::vector< int64_t > & vtkOpenXRManagerOpenGLGraphics::GetSupportedDepthFormats ( )

overridevirtual

Return the list of GL formats supported by vtkOpenGLRenderWindow.

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

Implements vtkOpenXRManagerGraphics.

◆ CreateGraphicsBinding()

bool vtkOpenXRManagerOpenGLGraphics::CreateGraphicsBinding ( vtkOpenGLRenderWindow * helperWindow )

overridevirtual

Fill the pointer to the XrGraphicsBindingOpenGL structure.

Implements vtkOpenXRManagerGraphics.

◆ GetGraphicsBinding()

const void * vtkOpenXRManagerOpenGLGraphics::GetGraphicsBinding ( )

inlineoverridevirtual

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

Implements vtkOpenXRManagerGraphics.

Definition at line 78 of file vtkOpenXRManagerOpenGLGraphics.h.

◆ CheckGraphicsRequirements()

bool vtkOpenXRManagerOpenGLGraphics::CheckGraphicsRequirements	(	XrInstance	instance,
		XrSystemId	id
	)

overridevirtual

Check OpenGL version supported by the runtime.

Implements vtkOpenXRManagerGraphics.

◆ GetBackendExtensionName()

const char * vtkOpenXRManagerOpenGLGraphics::GetBackendExtensionName ( )

overridevirtual

Return the extension name corresponding to the OpenGL rendering backend.

Implements vtkOpenXRManagerGraphics.

◆ EnumerateSwapchainImages()

void vtkOpenXRManagerOpenGLGraphics::EnumerateSwapchainImages	(	XrSwapchain	swapchain,
		SwapchainImagesOpenGL &	swapchainImages
	)

protected

Acquire OpenGL swapchain images an store them in swapchainImages.

Member Data Documentation

◆ GraphicsBinding

std::shared_ptr<XrGraphicsBindingOpenGL> vtkOpenXRManagerOpenGLGraphics::GraphicsBinding

protected

Definition at line 107 of file vtkOpenXRManagerOpenGLGraphics.h.

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

Rendering/OpenXR/vtkOpenXRManagerOpenGLGraphics.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkOpenXRManagerOpenGLGraphics()

◆ ~vtkOpenXRManagerOpenGLGraphics()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ SetNumberOfSwapchains()

◆ GetColorSwapchainImage()

◆ GetDepthSwapchainImage()

◆ EnumerateColorSwapchainImages()

◆ EnumerateDepthSwapchainImages()

◆ GetSupportedColorFormats()

◆ GetSupportedDepthFormats()

◆ CreateGraphicsBinding()

◆ GetGraphicsBinding()

◆ CheckGraphicsRequirements()

◆ GetBackendExtensionName()

◆ EnumerateSwapchainImages()

Member Data Documentation

◆ GraphicsBinding