Module: OpenXR::ABI

Included in:
API, API
Defined in:
lib/openxr/abi.rb

Overview

The OpenXR application binary interface (ABI).

Defined Under Namespace

Modules: InitializeWithType Classes: XrAction, XrActionCreateInfo, XrActionSet, XrActionSetCreateInfo, XrActionSpaceCreateInfo, XrActionStateBoolean, XrActionStateFloat, XrActionStateGetInfo, XrActionStatePose, XrActionStateVector2f, XrActionSuggestedBinding, XrActionsSyncInfo, XrActiveActionSet, XrApiLayerProperties, XrApplicationInfo, XrBaseStructure, XrBoundSourcesForActionEnumerateInfo, XrColor4f, XrCompositionLayerBaseHeader, XrCompositionLayerCubeKHR, XrCompositionLayerCylinderKHR, XrCompositionLayerDepthInfoKHR, XrCompositionLayerEquirectKHR, XrCompositionLayerProjection, XrCompositionLayerProjectionView, XrCompositionLayerQuad, XrDebugUtilsLabelEXT, XrDebugUtilsMessengerCallbackDataEXT, XrDebugUtilsMessengerCreateInfoEXT, XrDebugUtilsObjectNameInfoEXT, XrEventDataBaseHeader, XrEventDataBuffer, XrEventDataEventsLost, XrEventDataInstanceLossPending, XrEventDataInteractionProfileChanged, XrEventDataMainSessionVisibilityChangedEXTX, XrEventDataPerfSettingsEXT, XrEventDataReferenceSpaceChangePending, XrEventDataSessionStateChanged, XrEventDataVisibilityMaskChangedKHR, XrExtensionProperties, XrExtent2Df, XrExtent2Di, XrEyeGazeSampleTimeEXT, XrFovf, XrFrameBeginInfo, XrFrameEndInfo, XrFrameState, XrFrameWaitInfo, XrHapticActionInfo, XrHapticBaseHeader, XrHapticVibration, XrInputSourceLocalizedNameGetInfo, XrInstance, XrInstanceCreateInfo, XrInstanceProperties, XrInteractionProfileState, XrInteractionProfileSuggestedBinding, XrOffset2Df, XrOffset2Di, XrPosef, XrQuaternionf, XrRect2Df, XrRect2Di, XrReferenceSpaceCreateInfo, XrSession, XrSessionActionSetsAttachInfo, XrSessionBeginInfo, XrSessionCreateInfo, XrSessionCreateInfoOverlayEXTX, XrSpace, XrSpaceLocation, XrSpaceVelocity, XrSpatialAnchorCreateInfoMSFT, XrSpatialAnchorSpaceCreateInfoMSFT, XrSwapchain, XrSwapchainCreateInfo, XrSwapchainImageAcquireInfo, XrSwapchainImageBaseHeader, XrSwapchainImageReleaseInfo, XrSwapchainImageWaitInfo, XrSwapchainSubImage, XrSystemEyeGazeInteractionPropertiesEXT, XrSystemGetInfo, XrSystemGraphicsProperties, XrSystemProperties, XrSystemTrackingProperties, XrVector2f, XrVector3f, XrVector4f, XrView, XrViewConfigurationDepthRangeEXT, XrViewConfigurationProperties, XrViewConfigurationView, XrViewConfigurationViewFovEPIC, XrViewLocateInfo, XrViewState, XrVisibilityMaskKHR

Constant Summary collapse

XR_CURRENT_API_VERSION = 
XR_MAKE_VERSION(1, 0, 8)
XrVersion = 
:uint64
XrFlags64 = 
:uint64
XrSystemId = 
:uint64
XrBool32 = 
:uint32
XrPath = 
:uint64
XrTime = 
:int64
XrDuration = 
:int64
XR_TRUE = 
1
XR_FALSE = 
0
XR_MAX_EXTENSION_NAME_SIZE = 
128
XR_MAX_API_LAYER_NAME_SIZE = 
256
XR_MAX_API_LAYER_DESCRIPTION_SIZE = 
256
XR_MAX_SYSTEM_NAME_SIZE = 
256
XR_MAX_APPLICATION_NAME_SIZE = 
128
XR_MAX_ENGINE_NAME_SIZE = 
128
XR_MAX_RUNTIME_NAME_SIZE = 
128
XR_MAX_PATH_LENGTH = 
256
XR_MAX_STRUCTURE_NAME_SIZE = 
64
XR_MAX_RESULT_STRING_SIZE = 
64
XR_MIN_COMPOSITION_LAYERS_SUPPORTED = 
16
XR_MAX_ACTION_SET_NAME_SIZE = 
64
XR_MAX_LOCALIZED_ACTION_SET_NAME_SIZE = 
128
XR_MAX_ACTION_NAME_SIZE = 
64
XR_MAX_LOCALIZED_ACTION_NAME_SIZE = 
128
XrResult =

enum

:int
XR_SUCCESS = 
0
XR_TIMEOUT_EXPIRED = 
1
XR_SESSION_LOSS_PENDING = 
3
XR_EVENT_UNAVAILABLE = 
4
XR_SPACE_BOUNDS_UNAVAILABLE = 
7
XR_SESSION_NOT_FOCUSED = 
8
XR_FRAME_DISCARDED = 
9
XR_ERROR_VALIDATION_FAILURE = 
-1
XR_ERROR_RUNTIME_FAILURE = 
-2
XR_ERROR_OUT_OF_MEMORY = 
-3
XR_ERROR_API_VERSION_UNSUPPORTED = 
-4
XR_ERROR_INITIALIZATION_FAILED = 
-6
XR_ERROR_FUNCTION_UNSUPPORTED = 
-7
XR_ERROR_FEATURE_UNSUPPORTED = 
-8
XR_ERROR_EXTENSION_NOT_PRESENT = 
-9
XR_ERROR_LIMIT_REACHED = 
-10
XR_ERROR_SIZE_INSUFFICIENT = 
-11
XR_ERROR_HANDLE_INVALID = 
-12
XR_ERROR_INSTANCE_LOST = 
-13
XR_ERROR_SESSION_RUNNING = 
-14
XR_ERROR_SESSION_NOT_RUNNING = 
-16
XR_ERROR_SESSION_LOST = 
-17
XR_ERROR_SYSTEM_INVALID = 
-18
XR_ERROR_PATH_INVALID = 
-19
XR_ERROR_PATH_COUNT_EXCEEDED = 
-20
XR_ERROR_PATH_FORMAT_INVALID = 
-21
XR_ERROR_PATH_UNSUPPORTED = 
-22
XR_ERROR_LAYER_INVALID = 
-23
XR_ERROR_LAYER_LIMIT_EXCEEDED = 
-24
XR_ERROR_SWAPCHAIN_RECT_INVALID = 
-25
XR_ERROR_SWAPCHAIN_FORMAT_UNSUPPORTED = 
-26
XR_ERROR_ACTION_TYPE_MISMATCH = 
-27
XR_ERROR_SESSION_NOT_READY = 
-28
XR_ERROR_SESSION_NOT_STOPPING = 
-29
XR_ERROR_TIME_INVALID = 
-30
XR_ERROR_REFERENCE_SPACE_UNSUPPORTED = 
-31
XR_ERROR_FILE_ACCESS_ERROR = 
-32
XR_ERROR_FILE_CONTENTS_INVALID = 
-33
XR_ERROR_FORM_FACTOR_UNSUPPORTED = 
-34
XR_ERROR_FORM_FACTOR_UNAVAILABLE = 
-35
XR_ERROR_API_LAYER_NOT_PRESENT = 
-36
XR_ERROR_CALL_ORDER_INVALID = 
-37
XR_ERROR_GRAPHICS_DEVICE_INVALID = 
-38
XR_ERROR_POSE_INVALID = 
-39
XR_ERROR_INDEX_OUT_OF_RANGE = 
-40
XR_ERROR_VIEW_CONFIGURATION_TYPE_UNSUPPORTED = 
-41
XR_ERROR_ENVIRONMENT_BLEND_MODE_UNSUPPORTED = 
-42
XR_ERROR_NAME_DUPLICATED = 
-44
XR_ERROR_NAME_INVALID = 
-45
XR_ERROR_ACTIONSET_NOT_ATTACHED = 
-46
XR_ERROR_ACTIONSETS_ALREADY_ATTACHED = 
-47
XR_ERROR_LOCALIZED_NAME_DUPLICATED = 
-48
XR_ERROR_LOCALIZED_NAME_INVALID = 
-49
XR_ERROR_ANDROID_THREAD_SETTINGS_ID_INVALID_KHR = 
-1000003000
XR_ERROR_ANDROID_THREAD_SETTINGS_FAILURE_KHR = 
-1000003001
XR_ERROR_CREATE_SPATIAL_ANCHOR_FAILED_MSFT = 
-1000039001
XR_RESULT_MAX_ENUM = 
0x7FFFFFFF
XrStructureType =

enum

:int
XR_TYPE_UNKNOWN = 
0
XR_TYPE_API_LAYER_PROPERTIES = 
1
XR_TYPE_EXTENSION_PROPERTIES = 
2
XR_TYPE_INSTANCE_CREATE_INFO = 
3
XR_TYPE_SYSTEM_GET_INFO = 
4
XR_TYPE_SYSTEM_PROPERTIES = 
5
XR_TYPE_VIEW_LOCATE_INFO = 
6
XR_TYPE_VIEW = 
7
XR_TYPE_SESSION_CREATE_INFO = 
8
XR_TYPE_SWAPCHAIN_CREATE_INFO = 
9
XR_TYPE_SESSION_BEGIN_INFO = 
10
XR_TYPE_VIEW_STATE = 
11
XR_TYPE_FRAME_END_INFO = 
12
XR_TYPE_HAPTIC_VIBRATION = 
13
XR_TYPE_EVENT_DATA_BUFFER = 
16
XR_TYPE_EVENT_DATA_INSTANCE_LOSS_PENDING = 
17
XR_TYPE_EVENT_DATA_SESSION_STATE_CHANGED = 
18
XR_TYPE_ACTION_STATE_BOOLEAN = 
23
XR_TYPE_ACTION_STATE_FLOAT = 
24
XR_TYPE_ACTION_STATE_VECTOR2F = 
25
XR_TYPE_ACTION_STATE_POSE = 
27
XR_TYPE_ACTION_SET_CREATE_INFO = 
28
XR_TYPE_ACTION_CREATE_INFO = 
29
XR_TYPE_INSTANCE_PROPERTIES = 
32
XR_TYPE_FRAME_WAIT_INFO = 
33
XR_TYPE_COMPOSITION_LAYER_PROJECTION = 
35
XR_TYPE_COMPOSITION_LAYER_QUAD = 
36
XR_TYPE_REFERENCE_SPACE_CREATE_INFO = 
37
XR_TYPE_ACTION_SPACE_CREATE_INFO = 
38
XR_TYPE_EVENT_DATA_REFERENCE_SPACE_CHANGE_PENDING = 
40
XR_TYPE_VIEW_CONFIGURATION_VIEW = 
41
XR_TYPE_SPACE_LOCATION = 
42
XR_TYPE_SPACE_VELOCITY = 
43
XR_TYPE_FRAME_STATE = 
44
XR_TYPE_VIEW_CONFIGURATION_PROPERTIES = 
45
XR_TYPE_FRAME_BEGIN_INFO = 
46
XR_TYPE_COMPOSITION_LAYER_PROJECTION_VIEW = 
48
XR_TYPE_EVENT_DATA_EVENTS_LOST = 
49
XR_TYPE_INTERACTION_PROFILE_SUGGESTED_BINDING = 
51
XR_TYPE_EVENT_DATA_INTERACTION_PROFILE_CHANGED = 
52
XR_TYPE_INTERACTION_PROFILE_STATE = 
53
XR_TYPE_SWAPCHAIN_IMAGE_ACQUIRE_INFO = 
55
XR_TYPE_SWAPCHAIN_IMAGE_WAIT_INFO = 
56
XR_TYPE_SWAPCHAIN_IMAGE_RELEASE_INFO = 
57
XR_TYPE_ACTION_STATE_GET_INFO = 
58
XR_TYPE_HAPTIC_ACTION_INFO = 
59
XR_TYPE_SESSION_ACTION_SETS_ATTACH_INFO = 
60
XR_TYPE_ACTIONS_SYNC_INFO = 
61
XR_TYPE_BOUND_SOURCES_FOR_ACTION_ENUMERATE_INFO = 
62
XR_TYPE_INPUT_SOURCE_LOCALIZED_NAME_GET_INFO = 
63
XR_TYPE_COMPOSITION_LAYER_CUBE_KHR = 
1000006000
XR_TYPE_INSTANCE_CREATE_INFO_ANDROID_KHR = 
1000008000
XR_TYPE_COMPOSITION_LAYER_DEPTH_INFO_KHR = 
1000010000
XR_TYPE_VULKAN_SWAPCHAIN_FORMAT_LIST_CREATE_INFO_KHR = 
1000014000
XR_TYPE_EVENT_DATA_PERF_SETTINGS_EXT = 
1000015000
XR_TYPE_COMPOSITION_LAYER_CYLINDER_KHR = 
1000017000
XR_TYPE_COMPOSITION_LAYER_EQUIRECT_KHR = 
1000018000
XR_TYPE_DEBUG_UTILS_OBJECT_NAME_INFO_EXT = 
1000019000
XR_TYPE_DEBUG_UTILS_MESSENGER_CALLBACK_DATA_EXT = 
1000019001
XR_TYPE_DEBUG_UTILS_MESSENGER_CREATE_INFO_EXT = 
1000019002
XR_TYPE_DEBUG_UTILS_LABEL_EXT = 
1000019003
XR_TYPE_GRAPHICS_BINDING_OPENGL_WIN32_KHR = 
1000023000
XR_TYPE_GRAPHICS_BINDING_OPENGL_XLIB_KHR = 
1000023001
XR_TYPE_GRAPHICS_BINDING_OPENGL_XCB_KHR = 
1000023002
XR_TYPE_GRAPHICS_BINDING_OPENGL_WAYLAND_KHR = 
1000023003
XR_TYPE_SWAPCHAIN_IMAGE_OPENGL_KHR = 
1000023004
XR_TYPE_GRAPHICS_REQUIREMENTS_OPENGL_KHR = 
1000023005
XR_TYPE_GRAPHICS_BINDING_OPENGL_ES_ANDROID_KHR = 
1000024001
XR_TYPE_SWAPCHAIN_IMAGE_OPENGL_ES_KHR = 
1000024002
XR_TYPE_GRAPHICS_REQUIREMENTS_OPENGL_ES_KHR = 
1000024003
XR_TYPE_GRAPHICS_BINDING_VULKAN_KHR = 
1000025000
XR_TYPE_SWAPCHAIN_IMAGE_VULKAN_KHR = 
1000025001
XR_TYPE_GRAPHICS_REQUIREMENTS_VULKAN_KHR = 
1000025002
XR_TYPE_GRAPHICS_BINDING_D3D11_KHR = 
1000027000
XR_TYPE_SWAPCHAIN_IMAGE_D3D11_KHR = 
1000027001
XR_TYPE_GRAPHICS_REQUIREMENTS_D3D11_KHR = 
1000027002
XR_TYPE_GRAPHICS_BINDING_D3D12_KHR = 
1000028000
XR_TYPE_SWAPCHAIN_IMAGE_D3D12_KHR = 
1000028001
XR_TYPE_GRAPHICS_REQUIREMENTS_D3D12_KHR = 
1000028002
XR_TYPE_SYSTEM_EYE_GAZE_INTERACTION_PROPERTIES_EXT = 
1000030000
XR_TYPE_EYE_GAZE_SAMPLE_TIME_EXT = 
1000030001
XR_TYPE_VISIBILITY_MASK_KHR = 
1000031000
XR_TYPE_EVENT_DATA_VISIBILITY_MASK_CHANGED_KHR = 
1000031001
XR_TYPE_SESSION_CREATE_INFO_OVERLAY_EXTX = 
1000033000
XR_TYPE_EVENT_DATA_MAIN_SESSION_VISIBILITY_CHANGED_EXTX = 
1000033003
XR_TYPE_SPATIAL_ANCHOR_CREATE_INFO_MSFT = 
1000039000
XR_TYPE_SPATIAL_ANCHOR_SPACE_CREATE_INFO_MSFT = 
1000039001
XR_TYPE_VIEW_CONFIGURATION_DEPTH_RANGE_EXT = 
1000046000
XR_TYPE_VIEW_CONFIGURATION_VIEW_FOV_EPIC = 
1000059000
XR_STRUCTURE_TYPE_MAX_ENUM = 
0x7FFFFFFF
XrFormFactor =

enum

:int
XR_FORM_FACTOR_HEAD_MOUNTED_DISPLAY = 
1
XR_FORM_FACTOR_HANDHELD_DISPLAY = 
2
XR_FORM_FACTOR_MAX_ENUM = 
0x7FFFFFFF
XrInstanceCreateFlags = 
XrFlags64
XrSessionCreateFlags = 
XrFlags64
XrBaseInStructure = 
XrBaseStructure
XrBaseOutStructure = 
XrBaseStructure

Class Method Summary collapse

Class Method Details

.XR_MAKE_VERSION(major, minor, patch) ⇒ Object

See Also:



28
29
30
 
# File 'lib/openxr/abi.rb', line 28

def self.XR_MAKE_VERSION(major, minor, patch)
  (((major.to_i & 0xffff) << 48) + ((minor.to_i & 0xffff) << 32) + (patch.to_i & 0xffffffff))
end