Enum OpenXrRuntimeError

pub enum OpenXrRuntimeError {
    LoadEntry {
        message: String,
    },
    EnumerateExtensions {
        result: Result,
    },
    MissingExtension(&'static str),
    InvalidOpenXrName {
        field: &'static str,
        reason: String,
    },
    CreateInstance {
        result: Result,
    },
    InstanceProperties {
        result: Result,
    },
    System {
        result: Result,
    },
    BlendModes {
        result: Result,
    },
    GraphicsRequirements {
        result: Result,
    },
    UnsupportedVulkanVersion {
        requested: Version,
        min: Version,
        max: Version,
    },
    LoadVulkanEntry {
        message: String,
    },
    InvalidVulkanName {
        field: &'static str,
        message: String,
    },
    CreateVulkanInstance {
        result: Result,
    },
    CreateVulkanInstanceVk {
        result: Result,
    },
    VulkanGraphicsDevice {
        result: Result,
    },
    NoGraphicsQueueFamily,
    CreateVulkanDevice {
        result: Result,
    },
    CreateVulkanDeviceVk {
        result: Result,
    },
    CreateCommandPool {
        result: Result,
    },
    AllocateCommandBuffer {
        result: Result,
    },
    BeginCommandBuffer {
        result: Result,
    },
    EndCommandBuffer {
        result: Result,
    },
    QueueSubmit {
        result: Result,
    },
    QueueWaitIdle {
        result: Result,
    },
    CreateSession {
        result: Result,
    },
    CreateViewSpace {
        result: Result,
    },
    LocateViewSpace {
        result: Result,
    },
    CreateReferenceSpace {
        preference: &'static str,
        local_error: Option<Result>,
        stage_error: Option<Result>,
    },
    PollEvent {
        result: Result,
    },
    BeginSession {
        result: Result,
    },
    EndSession {
        result: Result,
    },
    FrameWait {
        result: Result,
    },
    FrameBegin {
        result: Result,
    },
    FrameEnd {
        result: Result,
    },
    CreateActionSet {
        name: &'static str,
        result: Result,
    },
    StringToPath {
        path: &'static str,
        result: Result,
    },
    CreateAction {
        name: &'static str,
        result: Result,
    },
    SuggestInteractionProfileBindings {
        profile: &'static str,
        result: Result,
    },
    NoInteractionProfileBindings,
    AttachActionSets {
        result: Result,
    },
    CreateActionSpace {
        source_name: &'static str,
        result: Result,
    },
    SyncActions {
        result: Result,
    },
    ActionState {
        action: &'static str,
        source_name: &'static str,
        result: Result,
    },
    LocateActionSpace {
        source_name: &'static str,
        result: Result,
    },
    CreateHandTracker {
        source_name: &'static str,
        result: Result,
    },
    LocateHandJoints {
        source_name: &'static str,
        result: Result,
    },
    InvalidSwapchainExtent {
        width: u32,
        height: u32,
    },
    EnumerateSwapchainFormats {
        result: Result,
    },
    UnsupportedSwapchainFormat {
        supported: Vec<u32>,
    },
    CreateSwapchain {
        usage: &'static str,
        result: Result,
    },
    EnumerateSwapchainImages {
        result: Result,
    },
    CreateSwapchainImageView {
        result: Result,
    },
    MissingVulkanMemoryProperties {
        usage: &'static str,
    },
    CreateStagingBuffer {
        usage: &'static str,
        result: Result,
    },
    NoHostVisibleMemoryType {
        usage: &'static str,
    },
    AllocateStagingMemory {
        usage: &'static str,
        result: Result,
    },
    BindStagingMemory {
        usage: &'static str,
        result: Result,
    },
    MapStagingMemory {
        usage: &'static str,
        result: Result,
    },
    SwapchainImageIndexOutOfBounds {
        index: u32,
        len: usize,
    },
    AcquireSwapchainImage {
        result: Result,
    },
    WaitSwapchainImage {
        result: Result,
    },
    ReleaseSwapchainImage {
        result: Result,
    },
    RenderVulkan {
        source: VulkanRendererError,
    },
}

Error returned by the native OpenXR runtime path.

Variants retain the native OpenXR or Vulkan result whenever one is available; configuration and loader failures retain descriptive context instead.

Examples

use ailloli_ui_openxr::OpenXrRuntimeError;
let error = OpenXrRuntimeError::MissingExtension("XR_KHR_vulkan_enable2");
assert!(error.to_string().contains("XR_KHR_vulkan_enable2"));

Variants

LoadEntry

The platform OpenXR loader could not be opened.

Fields

message: String

Loader error text.

EnumerateExtensions

Available extension enumeration failed.

Fields

result: Result

Native OpenXR result code.

MissingExtension(&'static str)

A mandatory runtime extension was unavailable.

InvalidOpenXrName

An application or engine name violated OpenXR byte constraints.

Fields

field: &'static str

Name field being validated.

reason: String

NUL or byte-length violation.

CreateInstance

Instance creation failed.

Fields

result: Result

Native OpenXR result code.

InstanceProperties

Runtime property lookup failed.

Fields

result: Result

Native OpenXR result code.

System

No head-mounted-display system could be obtained.

Fields

result: Result

Native OpenXR result code.

BlendModes

Environment blend-mode enumeration failed.

Fields

result: Result

Native OpenXR result code.

GraphicsRequirements

Vulkan graphics-requirement lookup failed.

Fields

result: Result

Native OpenXR result code.

UnsupportedVulkanVersion

Requested Vulkan API version falls outside the runtime range.

Fields

requested: Version

Vulkan version requested by Ailloli.

min: Version

Minimum version accepted by the runtime.

max: Version

Maximum version accepted by the runtime.

LoadVulkanEntry

The Vulkan loader could not be opened.

Fields

message: String

Loader error text.

InvalidVulkanName

A Vulkan application, engine, or layer name contained an invalid byte.

Fields

field: &'static str

Name field being converted.

message: String

Conversion failure text.

CreateVulkanInstance

OpenXR rejected Vulkan instance creation.

Fields

result: Result

Native OpenXR result code.

CreateVulkanInstanceVk

Vulkan itself rejected instance creation requested through OpenXR.

Fields

result: Result

Native Vulkan result code.

VulkanGraphicsDevice

The runtime’s Vulkan physical-device lookup failed.

Fields

result: Result

Native OpenXR result code.

NoGraphicsQueueFamily

No queue family advertised graphics support.

CreateVulkanDevice

OpenXR rejected Vulkan logical-device creation.

Fields

result: Result

Native OpenXR result code.

CreateVulkanDeviceVk

Vulkan rejected logical-device creation requested through OpenXR.

Fields

result: Result

Native Vulkan result code.

CreateCommandPool

Vulkan command-pool allocation failed.

Fields

result: Result

Native Vulkan result code.

AllocateCommandBuffer

Vulkan command-buffer allocation failed.

Fields

result: Result

Native Vulkan result code.

BeginCommandBuffer

Beginning a one-time Vulkan command buffer failed.

Fields

result: Result

Native Vulkan result code.

EndCommandBuffer

Ending a one-time Vulkan command buffer failed.

Fields

result: Result

Native Vulkan result code.

QueueSubmit

Queue submission of recorded Vulkan work failed.

Fields

result: Result

Native Vulkan result code.

QueueWaitIdle

Waiting for the Vulkan graphics queue to become idle failed.

Fields

result: Result

Native Vulkan result code.

CreateSession

Creating a Vulkan-backed OpenXR session failed.

Fields

result: Result

Native OpenXR result code.

CreateViewSpace

Creating the viewer reference space failed.

Fields

result: Result

Native OpenXR result code.

LocateViewSpace

Locating the viewer reference space failed.

Fields

result: Result

Native OpenXR result code.

CreateReferenceSpace

Neither preferred nor fallback application reference space could be created.

Fields

preference: &'static str

Human-readable requested preference.

local_error: Option<Result>

Failure from the local-space attempt, if attempted.

stage_error: Option<Result>

Failure from the stage-space attempt, if attempted.

PollEvent

Polling the instance event queue failed.

Fields

result: Result

Native OpenXR result code.

BeginSession

Beginning the OpenXR session failed.

Fields

result: Result

Native OpenXR result code.

EndSession

Ending the OpenXR session failed.

Fields

result: Result

Native OpenXR result code.

FrameWait

Waiting for the next predicted display time failed.

Fields

result: Result

Native OpenXR result code.

FrameBegin

Beginning the frame stream failed.

Fields

result: Result

Native OpenXR result code.

FrameEnd

Ending the frame stream or submitting layers failed.

Fields

result: Result

Native OpenXR result code.

CreateActionSet

Creating an OpenXR action set failed.

Fields

name: &'static str

Stable action-set name.

result: Result

Native OpenXR result code.

StringToPath

Converting an OpenXR path string failed.

Fields

path: &'static str

Path string requested by the input binding.

result: Result

Native OpenXR result code.

CreateAction

Creating an input action failed.

Fields

name: &'static str

Stable action name.

result: Result

Native OpenXR result code.

SuggestInteractionProfileBindings

A runtime rejected suggested bindings for an interaction profile.

Fields

profile: &'static str

OpenXR interaction-profile path.

result: Result

Native OpenXR result code.

NoInteractionProfileBindings

Every supported interaction-profile binding suggestion was rejected.

AttachActionSets

Attaching the input action set to the session failed.

Fields

result: Result

Native OpenXR result code.

CreateActionSpace

Creating a pose action space for one source failed.

Fields

source_name: &'static str

Human-readable controller or hand source.

result: Result

Native OpenXR result code.

SyncActions

Synchronizing action state for the current frame failed.

Fields

result: Result

Native OpenXR result code.

ActionState

Reading one action state failed.

Fields

action: &'static str

Action being read.

source_name: &'static str

Controller or hand source being polled.

result: Result

Native OpenXR result code.

LocateActionSpace

Locating a pose action space failed.

Fields

source_name: &'static str

Controller or hand source being located.

result: Result

Native OpenXR result code.

CreateHandTracker

Creating an extension hand tracker failed.

Fields

source_name: &'static str

Left or right hand label.

result: Result

Native OpenXR result code.

LocateHandJoints

Locating hand joints for one frame failed.

Fields

source_name: &'static str

Left or right hand label.

result: Result

Native OpenXR result code.

InvalidSwapchainExtent

Swapchain width or height was zero.

Fields

width: u32

Requested width in pixels.

height: u32

Requested height in pixels.

EnumerateSwapchainFormats

Runtime swapchain-format enumeration failed.

Fields

result: Result

Native OpenXR result code.

UnsupportedSwapchainFormat

None of the runtime formats matched the renderer’s Vulkan formats.

Fields

supported: Vec<u32>

Raw Vulkan format values advertised by the runtime.

CreateSwapchain

Creating an OpenXR swapchain failed.

Fields

usage: &'static str

Human-readable attempted usage flags.

result: Result

Native OpenXR result code.

EnumerateSwapchainImages

Enumerating native Vulkan images for a swapchain failed.

Fields

result: Result

Native OpenXR result code.

CreateSwapchainImageView

Creating a Vulkan view for a swapchain image failed.

Fields

result: Result

Native Vulkan result code.

MissingVulkanMemoryProperties

A staging operation required unavailable Vulkan memory properties.

Fields

usage: &'static str

Staging operation requiring the properties.

CreateStagingBuffer

Creating a Vulkan staging buffer failed.

Fields

usage: &'static str

Staging-buffer purpose.

result: Result

Native Vulkan result code.

NoHostVisibleMemoryType

No memory type was both host-visible and coherent.

Fields

usage: &'static str

Staging-buffer purpose.

AllocateStagingMemory

Vulkan staging-memory allocation failed.

Fields

usage: &'static str

Staging-buffer purpose.

result: Result

Native Vulkan result code.

BindStagingMemory

Binding staging memory to its Vulkan buffer failed.

Fields

usage: &'static str

Staging-buffer purpose.

result: Result

Native Vulkan result code.

MapStagingMemory

Mapping staging memory into host address space failed.

Fields

usage: &'static str

Staging-buffer purpose.

result: Result

Native Vulkan result code.

SwapchainImageIndexOutOfBounds

Runtime returned an image index beyond the enumerated image vector.

Fields

index: u32

Runtime-provided image index.

len: usize

Number of known swapchain images.

AcquireSwapchainImage

Acquiring the next swapchain image failed.

Fields

result: Result

Native OpenXR result code.

WaitSwapchainImage

Waiting for an acquired swapchain image failed or timed out.

Fields

result: Result

Native OpenXR result code.

ReleaseSwapchainImage

Releasing an acquired swapchain image failed.

Fields

result: Result

Native OpenXR result code.

RenderVulkan

Ailloli’s Vulkan renderer rejected setup or frame work.

Fields

source: VulkanRendererError

Underlying renderer failure.

Trait Implementations

impl Debug for OpenXrRuntimeError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for OpenXrRuntimeError

fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for OpenXrRuntimeError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.