Open 3D Engine XR Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
XR::Instance Class Referenceabstract

Inherits XR::Object.

Public Member Functions

 AZ_CLASS_ALLOCATOR (Instance, AZ::SystemAllocator)
 
 AZ_RTTI (Instance, "{1C457924-56A4-444F-BC72-4D31A097BA70}")
 
AZ::RHI::ResultCode Init (AZ::RHI::ValidationMode validationMode)
 
virtual AZ::u32 GetNumPhysicalDevices () const =0
 Get number of physical devices for XR.
 
virtual AZ::RHI::ResultCode GetXRPhysicalDevice (AZ::RHI::XRPhysicalDeviceDescriptor *physicalDeviceDescriptor, int32_t index)=0
 API to retrieve the native physical device for a specific index.
 
- Public Member Functions inherited from XR::Object
 AZ_RTTI (Object, "{74FCA8BF-CBDA-43EB-A378-89F752ED2FCA}")
 
void SetName (const AZ::Name &name)
 Sets the name of the object.
 
const AZ::Name & GetName () const
 Returns the name set on the object by SetName.
 

Protected Attributes

AZ::RHI::ValidationMode m_validationMode = AZ::RHI::ValidationMode::Disabled
 

Member Function Documentation

◆ Init()

AZ::RHI::ResultCode XR::Instance::Init ( AZ::RHI::ValidationMode  validationMode)

Init the back-end instance. It is responsible for figuring out supported layers and extensions and based on that a xr instance is created. It also has logging support based on validation mode.


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