Open 3D Engine OpenXRVk Gem API Reference  24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
OpenXRVk::Instance Class Referencefinal

#include <OpenXRVkInstance.h>

Inherits XR::Instance, AZ::Vulkan::InstanceRequirementBus::Handler, AZ::Vulkan::DeviceRequirementBus::Handler, and AZ::Vulkan::InstanceNotificationBus::Handler.

Public Member Functions

 AZ_CLASS_ALLOCATOR (Instance, AZ::SystemAllocator)
 
 AZ_RTTI (Instance, "{1A62DF32-2909-431C-A938-B1E841A50768}", XR::Instance)
 
AZ::u32 GetNumPhysicalDevices () const override
 
AZ::RHI::ResultCode GetXRPhysicalDevice (AZ::RHI::XRPhysicalDeviceDescriptor *physicalDeviceDescriptor, int32_t index) override
 
XR::StringList GetInstanceExtensionNames (const char *layerName=nullptr) const
 Enumerate supported extension names.
 
XR::StringList GetInstanceLayerNames () const
 Enumerate supported layer names.
 
void LogViewConfigurations ()
 Enumerate and log view configurations.
 
void LogEnvironmentBlendMode (XrViewConfigurationType type)
 Enumerate and log environment blend mode.
 
XrInstance GetXRInstance () const
 Get the XRInstance.
 
XrSystemId GetXRSystemId () const
 Get System id.
 
VkInstance GetNativeInstance () const
 Get native VkInstance.
 
XrEnvironmentBlendMode GetEnvironmentBlendMode () const
 Get XR environment blend mode.
 
XrViewConfigurationType GetViewConfigType () const
 Get XR configuration type.
 
uint32_t GetViewCount () const
 

Static Public Member Functions

static XR::Ptr< Instance > Create ()
 

Protected Member Functions

void CollectAdditionalRequiredInstanceExtensions (AZStd::vector< AZStd::string > &extensions) override
 
void CollectMinMaxVulkanAPIVersions (AZStd::vector< uint32_t > &min, AZStd::vector< uint32_t > &max) override
 
void CollectAdditionalRequiredDeviceExtensions (AZStd::vector< AZStd::string > &extensions) override
 
void FilterSupportedDevices (AZStd::vector< VkPhysicalDevice > &supportedDevices) override
 
virtual void OnInstanceCreated ([[maybe_unused]] VkInstance instance)
 
virtual void OnInstanceDestroyed ()
 

Detailed Description

Vulkan specific XR instance back-end class that will help manage XR specific vulkan native objects

Member Function Documentation

◆ GetViewCount()

uint32_t OpenXRVk::Instance::GetViewCount ( ) const

Get the number of views (aka eyes) according to the current XrViewConfigurationType.

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