ezOpenXR Class Reference

Inheritance diagram for ezOpenXR:

Public Member Functions
XrInstance	GetInstance () const
uint64_t	GetSystemId () const
XrSession	GetSession () const
XrViewConfigurationType	GetViewType () const
bool	GetDepthComposition () const
ezOpenXRGraphicsBinding *	GetGraphicsBinding () const
	Returns the graphics binding interface (D3D11, Vulkan, etc.)
virtual bool	IsHmdPresent () const override
	Returns whether an HMD is available. Can be used to decide whether it makes sense to call Initialize at all.
virtual ezResult	Initialize () override
	Initializes the XR system. This can be quite time consuming as it will generally start supporting applications needed to run and start up the HMD if it went to sleep.
virtual void	Deinitialize () override
	Shuts down the XR system again.
virtual bool	IsInitialized () const override
	Returns whether the XR system is initialized.
virtual const ezHMDInfo &	GetHmdInfo () const override
	Returns general HMD information.
virtual ezXRInputDevice &	GetXRInput () const override
	Returns the XR input device.
virtual ezGALTextureHandle	GetCurrentTexture () override
	Called by ezWindowOutputTargetXR::RenderCompanionView Returns the color texture to be used by the companion view if enabled, otherwise an invalid handle.
virtual ezRegisteredWndHandle	CreateXRWindow (ezView *pView, ezGALMSAASampleCount::Enum msaaCount=ezGALMSAASampleCount::None, ezUniquePtr< ezWindowBase > pCompanionWindow=nullptr, ezUniquePtr< ezWindowOutputTargetGAL > pCompanionWindowOutput=nullptr) override
	Creates a XR actor by trying to startup an XR session.
virtual void	OnActorDestroyed () override
	Called when the actor created by 'CreateActor' is destroyed.
virtual bool	SupportsCompanionView () override
	Returns true if a companion window can be passed into CreateActor.
XrSpace	GetBaseSpace () const
Setup
Devices
View
Internal

Friends
class	ezOpenXRInputDevice
class	ezOpenXRSpatialAnchors
class	ezOpenXRHandTracking
class	ezOpenXRRemoting
class	ezGALOpenXRSwapChain

Member Function Documentation

CreateXRWindow()

ezRegisteredWndHandle ezOpenXR::CreateXRWindow ( ezView *  pView, ezGALMSAASampleCount::Enum  msaaCount = ezGALMSAASampleCount::None, ezUniquePtr< ezWindowBase >  pCompanionWindow = nullptr, ezUniquePtr< ezWindowOutputTargetGAL >  pCompanionWindowOutput = nullptr  )

overridevirtual

Creates a XR actor by trying to startup an XR session.

If SupportsCompanionView is true (VR only), a normal window and window output can be passed in. The window will be used to blit the VR output into the window.

Implements ezXRInterface.

Deinitialize()

void ezOpenXR::Deinitialize ( )

overridevirtual

Shuts down the XR system again.

Implements ezXRInterface.

GetCurrentTexture()

ezGALTextureHandle ezOpenXR::GetCurrentTexture ( )

overridevirtual

Called by ezWindowOutputTargetXR::RenderCompanionView Returns the color texture to be used by the companion view if enabled, otherwise an invalid handle.

Implements ezXRInterface.

GetHmdInfo()

const ezHMDInfo & ezOpenXR::GetHmdInfo ( ) const

overridevirtual

Returns general HMD information.

Implements ezXRInterface.

GetXRInput()

ezXRInputDevice & ezOpenXR::GetXRInput ( ) const

overridevirtual

Returns the XR input device.

Implements ezXRInterface.

Initialize()

ezResult ezOpenXR::Initialize ( )

overridevirtual

Initializes the XR system. This can be quite time consuming as it will generally start supporting applications needed to run and start up the HMD if it went to sleep.

Implements ezXRInterface.

IsHmdPresent()

bool ezOpenXR::IsHmdPresent ( ) const

overridevirtual

Returns whether an HMD is available. Can be used to decide whether it makes sense to call Initialize at all.

Implements ezXRInterface.

IsInitialized()

bool ezOpenXR::IsInitialized ( ) const

overridevirtual

Returns whether the XR system is initialized.

Implements ezXRInterface.

OnActorDestroyed()

void ezOpenXR::OnActorDestroyed ( )

overridevirtual

Called when the actor created by 'CreateActor' is destroyed.

Implements ezXRInterface.

SupportsCompanionView()

bool ezOpenXR::SupportsCompanionView ( )

overridevirtual

Returns true if a companion window can be passed into CreateActor.

Implements ezXRInterface.

---

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

• /home/runner/work/ezEngine/ezEngine/Code/EnginePlugins/OpenXRPlugin/OpenXRSingleton.h
• /home/runner/work/ezEngine/ezEngine/Code/EnginePlugins/OpenXRPlugin/OpenXRSingleton.cpp