xiiDummyXR Class Reference

Inheritance diagram for xiiDummyXR:

Public Member Functions
bool	IsHmdPresent () const override
	Returns whether an HMD is available. Can be used to decide whether it makes sense to call Initialize at all.
xiiResult	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.
void	Deinitialize () override
	Shuts down the XR system again.
bool	IsInitialized () const override
	Returns whether the XR system is initialized.
const xiiHMDInfo &	GetHmdInfo () const override
	Returns general HMD information.
xiiXRInputDevice &	GetXRInput () const override
	Returns the XR input device.
bool	SupportsCompanionView () override
	Returns true if a companion window can be passed into CreateActor.
xiiUniquePtr< xiiActor >	CreateActor (xiiView *pView, xiiEnum< xiiGALMSAASampleCount > msaaCount=xiiGALMSAASampleCount::OneSample, xiiUniquePtr< xiiWindowBase > pCompanionWindow=nullptr, xiiUniquePtr< xiiWindowOutputTargetGAL > pCompanionWindowOutput=nullptr) override
	Creates a XR actor by trying to startup an XR session.
xiiSharedPtr< xiiGALTexture >	GetCurrentTexture () override
	Called by xiiWindowOutputTargetXR::RenderCompanionView Returns the color texture to be used by the companion view if enabled, otherwise an invalid handle.
void	OnActorDestroyed () override
	Called when the actor created by 'CreateActor' is destroyed.
void	GALDeviceEventHandler (const xiiGALDeviceEvent &e)
void	GameApplicationEventHandler (const xiiGameApplicationExecutionEvent &e)
Public Member Functions inherited from xiiXRInterface

Protected Attributes
float	m_fHeadHeight = 1.7f
float	m_fEyeOffset = 0.05f
xiiHMDInfo	m_Info
xiiDummyXRInput	m_Input
bool	m_bInitialized = false
xiiEventSubscriptionID	m_GALdeviceEventsId = 0
xiiEventSubscriptionID	m_ExecutionEventsId = 0
xiiWorld *	m_pWorld = nullptr
xiiCamera *	m_pCameraToSynchronize = nullptr
xiiEnum< xiiXRStageSpace >	m_StageSpace = xiiXRStageSpace::Seated
xiiViewHandle	m_hView
xiiSharedPtr< xiiGALTexture >	m_pColorRT
xiiSharedPtr< xiiGALTexture >	m_pDepthRT
xiiWindowOutputTargetXR *	m_pCompanion = nullptr

Member Function Documentation

CreateActor()

xiiUniquePtr< xiiActor > xiiDummyXR::CreateActor ( xiiView * pView, xiiEnum< xiiGALMSAASampleCount > msaaCount = xiiGALMSAASampleCount::OneSample, xiiUniquePtr< xiiWindowBase > pCompanionWindow = nullptr, xiiUniquePtr< xiiWindowOutputTargetGAL > 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 xiiXRInterface.

Deinitialize()

void xiiDummyXR::Deinitialize ( )

overridevirtual

Shuts down the XR system again.

Implements xiiXRInterface.

GetCurrentTexture()

xiiSharedPtr< xiiGALTexture > xiiDummyXR::GetCurrentTexture ( )

overridevirtual

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

Implements xiiXRInterface.

GetHmdInfo()

const xiiHMDInfo & xiiDummyXR::GetHmdInfo ( ) const

overridevirtual

Returns general HMD information.

Implements xiiXRInterface.

GetXRInput()

xiiXRInputDevice & xiiDummyXR::GetXRInput ( ) const

overridevirtual

Returns the XR input device.

Implements xiiXRInterface.

Initialize()

xiiResult xiiDummyXR::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 xiiXRInterface.

IsHmdPresent()

bool xiiDummyXR::IsHmdPresent ( ) const

overridevirtual

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

Implements xiiXRInterface.

IsInitialized()

bool xiiDummyXR::IsInitialized ( ) const

overridevirtual

Returns whether the XR system is initialized.

Implements xiiXRInterface.

OnActorDestroyed()

void xiiDummyXR::OnActorDestroyed ( )

overridevirtual

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

Implements xiiXRInterface.

SupportsCompanionView()

bool xiiDummyXR::SupportsCompanionView ( )

overridevirtual

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

Implements xiiXRInterface.

---

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

• /home/runner/work/XII/XII/Source/Engine/GameEngine/XR/DummyXR.h
• /home/runner/work/XII/XII/Source/Engine/GameEngine/XR/Implementation/DummyXR.cpp