ezEngine  Release 25.03
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 ezHMDInfoGetHmdInfo () const override
 Returns general HMD information.
 
ezXRInputDeviceGetXRInput () const override
 Returns the XR input device.
 
bool SupportsCompanionView () override
 Returns true if a companion window can be passed into CreateActor.
 
ezUniquePtr< ezActorCreateActor (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. More...
 
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
 
ezCameram_pCameraToSynchronize = nullptr
 
ezEnum< ezXRStageSpacem_StageSpace = ezXRStageSpace::Seated
 
ezViewHandle m_hView
 
ezGALTextureHandle m_hColorRT
 
ezGALTextureHandle m_hDepthRT
 
ezWindowOutputTargetXRm_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.


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