plDummyXR Class Reference

Inheritance diagram for plDummyXR:

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.
plResult	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 plHMDInfo &	GetHmdInfo () const override
	Returns general HMD information.
plXRInputDevice &	GetXRInput () const override
	Returns the XR input device.
bool	SupportsCompanionView () override
	Returns true if a companion window can be passed into CreateActor.
plUniquePtr< plActor >	CreateActor (plView *pView, plGALMSAASampleCount::Enum msaaCount=plGALMSAASampleCount::None, plUniquePtr< plWindowBase > pCompanionWindow=nullptr, plUniquePtr< plWindowOutputTargetGAL > pCompanionWindowOutput=nullptr) override
	Creates a XR actor by trying to startup an XR session.
plGALTextureHandle	GetCurrentTexture () override
	Called by plWindowOutputTargetXR::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 plGALDeviceEvent &e)
void	GameApplicationEventHandler (const plGameApplicationExecutionEvent &e)
Setup
Devices
View
Internal

Protected Attributes
float	m_fHeadHeight = 1.7f
float	m_fEyeOffset = 0.05f
plHMDInfo	m_Info
plDummyXRInput	m_Input
bool	m_bInitialized = false
plEventSubscriptionID	m_GALdeviceEventsId = 0
plEventSubscriptionID	m_ExecutionEventsId = 0
plWorld *	m_pWorld = nullptr
plCamera *	m_pCameraToSynchronize = nullptr
plEnum< plXRStageSpace >	m_StageSpace = plXRStageSpace::Seated
plViewHandle	m_hView
plGALTextureHandle	m_hColorRT
plGALTextureHandle	m_hDepthRT
plWindowOutputTargetXR *	m_pCompanion = nullptr

Member Function Documentation

CreateActor()

plUniquePtr< plActor > plDummyXR::CreateActor ( plView * pView, plGALMSAASampleCount::Enum msaaCount = plGALMSAASampleCount::None, plUniquePtr< plWindowBase > pCompanionWindow = nullptr, plUniquePtr< plWindowOutputTargetGAL > 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 plXRInterface.

Deinitialize()

void plDummyXR::Deinitialize ( )

overridevirtual

Shuts down the XR system again.

Implements plXRInterface.

GetCurrentTexture()

plGALTextureHandle plDummyXR::GetCurrentTexture ( )

overridevirtual

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

Implements plXRInterface.

GetHmdInfo()

const plHMDInfo & plDummyXR::GetHmdInfo ( ) const

overridevirtual

Returns general HMD information.

Implements plXRInterface.

GetXRInput()

plXRInputDevice & plDummyXR::GetXRInput ( ) const

overridevirtual

Returns the XR input device.

Implements plXRInterface.

Initialize()

plResult plDummyXR::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 plXRInterface.

IsHmdPresent()

bool plDummyXR::IsHmdPresent ( ) const

overridevirtual

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

Implements plXRInterface.

IsInitialized()

bool plDummyXR::IsInitialized ( ) const

overridevirtual

Returns whether the XR system is initialized.

Implements plXRInterface.

OnActorDestroyed()

void plDummyXR::OnActorDestroyed ( )

overridevirtual

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

Implements plXRInterface.

SupportsCompanionView()

bool plDummyXR::SupportsCompanionView ( )

overridevirtual

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

Implements plXRInterface.

---

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

• Code/Engine/GameEngine/XR/DummyXR.h
• Code/Engine/GameEngine/XR/Implementation/DummyXR.cpp