ezDummyXR Class Reference

Inheritance diagram for ezDummyXR:

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.
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.
void	Deinitialize () override
	Shuts down the XR system again.
bool	IsInitialized () const override
	Returns whether the XR system is initialized.
const ezHMDInfo &	GetHmdInfo () const override
	Returns general HMD information.
ezXRInputDevice &	GetXRInput () const override
	Returns the XR input device.
bool	SupportsCompanionView () override
	Returns true if a companion window can be passed into CreateActor.
ezUniquePtr< ezActor >	CreateActor (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.
ezGALTextureHandle	GetCurrentTexture () override
	Called by ezWindowOutputTargetXR::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 ezGALDeviceEvent &e)
void	GameApplicationEventHandler (const ezGameApplicationExecutionEvent &e)
Setup
Devices
View
Internal

Protected Attributes
float	m_fHeadHeight = 1.7f
float	m_fEyeOffset = 0.05f
ezHMDInfo	m_Info
ezDummyXRInput	m_Input
bool	m_bInitialized = false
ezEventSubscriptionID	m_GALdeviceEventsId = 0
ezEventSubscriptionID	m_ExecutionEventsId = 0
ezCamera *	m_pCameraToSynchronize = nullptr
ezEnum< ezXRStageSpace >	m_StageSpace = ezXRStageSpace::Seated
ezViewHandle	m_hView
ezGALTextureHandle	m_hColorRT
ezGALTextureHandle	m_hDepthRT
ezWindowOutputTargetXR *	m_pCompanion = nullptr

Member Function Documentation

CreateActor()

ezUniquePtr< ezActor > ezDummyXR::CreateActor ( 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 ezDummyXR::Deinitialize ( )

overridevirtual

Shuts down the XR system again.

Implements ezXRInterface.

GetCurrentTexture()

ezGALTextureHandle ezDummyXR::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 & ezDummyXR::GetHmdInfo ( ) const

overridevirtual

Returns general HMD information.

Implements ezXRInterface.

GetXRInput()

ezXRInputDevice & ezDummyXR::GetXRInput ( ) const

overridevirtual

Returns the XR input device.

Implements ezXRInterface.

Initialize()

ezResult ezDummyXR::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 ezDummyXR::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 ezDummyXR::IsInitialized ( ) const

overridevirtual

Returns whether the XR system is initialized.

Implements ezXRInterface.

OnActorDestroyed()

void ezDummyXR::OnActorDestroyed ( )

overridevirtual

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

Implements ezXRInterface.

SupportsCompanionView()

bool ezDummyXR::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/Engine/GameEngine/XR/DummyXR.h
• /home/runner/work/ezEngine/ezEngine/Code/Engine/GameEngine/XR/Implementation/DummyXR.cpp