openxr 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 36abdb32c2a8c74e38219474fe86c86dc85c56d227cac9dd2e8fa5f1ddc9c846
+  data.tar.gz: 93069b7dd05951a389c29a07c74aa8f40ff8426c2af4e499e8643243ed01ddc0
+SHA512:
+  metadata.gz: a8a08e3cd2d31e206514d3e986cd00342504d2a9e1ab4ffcfd8cddc8cf1bb336d15719c19f40ad2cb77524be05e6676789ea8921335998d23fbd7248fd57fb6e
+  data.tar.gz: 0a916f590edb0d5aff013c19b54ea79c4f85cc01e682d0fbc0661708c84139e34366a4bbcf29cbf0c0ee6420faf0994de8629ec2e773933cc7fd902b677575f4

data/AUTHORS

@@ -0,0 +1 @@
+* Arto Bendiken <arto@bendiken.net>

data/CHANGES.md

@@ -0,0 +1,7 @@
+Changelog
+=========
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

data/CREDITS.md

@@ -0,0 +1,2 @@
+Credits
+=======

data/README.md

@@ -0,0 +1,64 @@
+OpenXR for Ruby
+===============
+
+[![Project license](https://img.shields.io/badge/license-Public%20Domain-blue.svg)](https://unlicense.org)
+[![RubyGems gem](https://img.shields.io/gem/v/openxr.svg)](https://rubygems.org/gems/openxr)
+[![Ruby compatibility](https://img.shields.io/badge/ruby-2.7%2B-red)](https://rubygems.org/gems/openxr)
+
+**OpenXR.rb** implements Ruby bindings for [OpenXR](https://www.khronos.org/openxr/)
+[1.0](https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html),
+the open standard and cross-platform API for virtual reality (VR) and
+augmented reality (AR) hardware.
+
+Installation
+------------
+
+    $ gem install openxr
+
+Prerequisites
+-------------
+
+- [Ruby](https://www.ruby-lang.org/en/) 2.7+
+  with [FFI](https://github.com/ffi/ffi/wiki)
+
+- [OpenXR SDK](https://github.com/KhronosGroup/OpenXR-SDK) 1.0.8+
+
+Examples
+--------
+
+### Loading the library
+
+    require 'openxr'
+
+### Listing extensions
+
+    OpenXR::Extension.each do |extension|
+      puts [extension.name, extension.version].join("\t")
+    end
+
+### Creating an instance
+
+    OpenXR::Instance.create($0) do |instance|
+      ...
+    end
+
+Development
+-----------
+
+We recommend Debian 11 (aka [Bullseye](https://www.debian.org/releases/bullseye/))
+as a development environment. If you're on a Mac, you can run Debian in a
+virtual machine using [VMware Fusion](https://www.vmware.com/products/fusion.html)
+or [VirtualBox](https://www.virtualbox.org).
+
+Install the Debian packages for the OpenXR SDK's loader as follows:
+
+    $ apt install libopenxr-loader1
+
+That's the only required package, but find related packages of interest using:
+
+    $ apt search openxr
+
+In addition, you _will_ need an OpenXR runtime for your hardware. In the
+absence of suitable vendor-supplied runtimes, have a look at the open-source
+[Monado](https://monado.freedesktop.org) project which supports many common
+devices.

data/UNLICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <https://unlicense.org/>

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/lib/openxr.rb

@@ -0,0 +1,33 @@
+# This is free and unencumbered software released into the public domain.
+
+module OpenXR; end
+
+require_relative 'openxr/abi'
+require_relative 'openxr/api'
+
+require_relative 'openxr/action'
+require_relative 'openxr/action_set'
+require_relative 'openxr/extension'
+require_relative 'openxr/handle'
+require_relative 'openxr/instance'
+require_relative 'openxr/layer'
+require_relative 'openxr/result'
+require_relative 'openxr/session'
+require_relative 'openxr/space'
+require_relative 'openxr/swapchain'
+require_relative 'openxr/system'
+require_relative 'openxr/version'
+
+module OpenXR
+  ##
+  # @return [Boolean]
+  def self.has_layers?
+    nil # TODO
+  end
+
+  ##
+  # @return [Boolean]
+  def self.has_extensions?
+    !!(Extension.count.nonzero?)
+  end
+end # OpenXR

data/lib/openxr/abi.rb

@@ -0,0 +1,492 @@
+# This is free and unencumbered software released into the public domain.
+
+require 'ffi'
+
+##
+# The OpenXR application binary interface (ABI).
+module OpenXR::ABI
+  ##
+  # @see https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#api-version-numbers-and-semantics
+  def self.XR_MAKE_VERSION(major, minor, patch)
+    (((major.to_i & 0xffff) << 48) + ((minor.to_i & 0xffff) << 32) + (patch.to_i & 0xffffffff))
+  end
+
+  XR_CURRENT_API_VERSION = XR_MAKE_VERSION(1, 0, 8)
+
+  XrVersion  = :uint64
+  XrFlags64  = :uint64
+  XrSystemId = :uint64
+  XrBool32   = :uint32
+  XrPath     = :uint64
+  XrTime     = :int64
+  XrDuration = :int64
+
+  class XrInstance < FFI::Struct
+    layout :handle, :pointer
+  end
+
+  class XrSession < FFI::Struct
+    layout :handle, :pointer
+  end
+
+  class XrSpace < FFI::Struct
+    layout :handle, :pointer
+  end
+
+  class XrAction < FFI::Struct
+    layout :handle, :pointer
+  end
+
+  class XrSwapchain < FFI::Struct
+    layout :handle, :pointer
+  end
+
+  class XrActionSet < FFI::Struct
+    layout :handle, :pointer
+  end
+
+  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                              = :int # enum
+  XR_SUCCESS                            = 0
+  XR_ERROR_VALIDATION_FAILURE           = -1
+  XR_ERROR_RUNTIME_FAILURE              = -2
+  XR_ERROR_HANDLE_INVALID               = -12
+
+  XrStructureType                       = :int # enum
+  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
+
+  XrFormFactor                          = :int # enum
+  XR_FORM_FACTOR_HEAD_MOUNTED_DISPLAY   = 1
+  XR_FORM_FACTOR_HANDHELD_DISPLAY       = 2
+  XR_FORM_FACTOR_MAX_ENUM               = 0x7FFFFFFF
+
+  XrInstanceCreateFlags = XrFlags64
+  XrSessionCreateFlags  = XrFlags64
+
+  class XrBaseStructure < FFI::Struct
+    layout :type,                    XrStructureType,
+           :next,                    :pointer
+  end
+
+  class XrApiLayerProperties < FFI::Struct
+    layout :base,                    XrBaseStructure,
+           :layerName,               [:char, XR_MAX_API_LAYER_NAME_SIZE],
+           :specVersion,             XrVersion,
+           :layerVersion,            :uint32,
+           :description,             [:char, XR_MAX_API_LAYER_DESCRIPTION_SIZE]
+  end
+
+  class XrExtensionProperties < FFI::Struct
+    layout :base,                    XrBaseStructure,
+           :extensionName,           [:char, XR_MAX_EXTENSION_NAME_SIZE],
+           :extensionVersion,        :uint32
+  end
+
+  class XrApplicationInfo < FFI::Struct
+    layout :applicationName,         [:char, XR_MAX_APPLICATION_NAME_SIZE],
+           :applicationVersion,      :uint32,
+           :engineName,              [:char, XR_MAX_ENGINE_NAME_SIZE],
+           :engineVersion,           :uint32,
+           :apiVersion,              XrVersion
+  end
+
+  class XrInstanceCreateInfo < FFI::Struct
+    layout :base,                    XrBaseStructure,
+           :createFlags,             XrInstanceCreateFlags,
+           :applicationInfo,         XrApplicationInfo,
+           :enabledApiLayerCount,    :uint32,
+           :enabledApiLayerNames,    :string,
+           :enabledExtensionCount,   :uint32,
+           :enabledExtensionNames,   :string
+  end
+
+  class XrInstanceProperties < FFI::Struct
+    layout :base,                    XrBaseStructure,
+           :runtimeVersion,          XrVersion,
+           :runtimeName,             [:char, XR_MAX_RUNTIME_NAME_SIZE]
+  end
+
+  class XrEventDataBuffer < FFI::Struct
+    layout :base,                    XrBaseStructure,
+           :varying,                 :uint8
+  end
+
+  class XrSystemGetInfo < FFI::Struct
+    layout :base,                    XrBaseStructure,
+           :formFactor,              XrFormFactor
+  end
+
+  class XrSystemGraphicsProperties < FFI::Struct
+    layout :maxSwapchainImageHeight, :uint32,
+           :maxSwapchainImageWidth,  :uint32,
+           :maxLayerCount,           :uint32
+  end
+
+  class XrSystemTrackingProperties < FFI::Struct
+    layout :orientationTracking,     XrBool32,
+           :positionTracking,        XrBool32
+  end
+
+  class XrSystemProperties < FFI::Struct
+    layout :base,                    XrBaseStructure,
+           :systemId,                XrSystemId,
+           :vendorId,                :uint32,
+           :systemName,              [:char, XR_MAX_SYSTEM_NAME_SIZE],
+           :graphicsProperties,      XrSystemGraphicsProperties,
+           :trackingProperties,      XrSystemTrackingProperties
+  end
+
+  class XrSessionCreateInfo < FFI::Struct
+    layout :base,                    XrBaseStructure,
+           :createFlags,             XrSessionCreateFlags,
+           :systemId,                XrSystemId
+  end
+
+  class XrVector3f < FFI::Struct
+    # TODO
+  end
+
+  class XrSpaceVelocity < FFI::Struct
+    # TODO
+  end
+
+  class XrQuaternionf < FFI::Struct
+    # TODO
+  end
+
+  class XrPosef < FFI::Struct
+    # TODO
+  end
+
+  class XrReferenceSpaceCreateInfo < FFI::Struct
+    # TODO
+  end
+
+  class XrExtent2Df < FFI::Struct
+    # TODO
+  end
+
+  class XrActionSpaceCreateInfo < FFI::Struct
+    # TODO
+  end
+
+  class XrSpaceLocation < FFI::Struct
+    # TODO
+  end
+
+  class XrViewConfigurationProperties < FFI::Struct
+    # TODO
+  end
+
+  class XrViewConfigurationView < FFI::Struct
+    # TODO
+  end
+
+  class XrSwapchainCreateInfo < FFI::Struct
+    # TODO
+  end
+
+  class XrSwapchainImageBaseHeader < FFI::Struct
+    # TODO
+  end
+
+  class XrSwapchainImageAcquireInfo < FFI::Struct
+    # TODO
+  end
+
+  class XrSwapchainImageWaitInfo < FFI::Struct
+    # TODO
+  end
+
+  class XrSwapchainImageReleaseInfo < FFI::Struct
+    # TODO
+  end
+
+  class XrSessionBeginInfo < FFI::Struct
+    # TODO
+  end
+
+  class XrFrameWaitInfo < FFI::Struct
+    # TODO
+  end
+
+  class XrFrameState < FFI::Struct
+    # TODO
+  end
+
+  class XrFrameBeginInfo < FFI::Struct
+    # TODO
+  end
+
+  class XrCompositionLayerBaseHeader < FFI::Struct
+    # TODO
+  end
+
+  class XrFrameEndInfo < FFI::Struct
+    # TODO
+  end
+
+  class XrViewLocateInfo < FFI::Struct
+    # TODO
+  end
+
+  class XrViewState < FFI::Struct
+    # TODO
+  end
+
+  class XrFovf < FFI::Struct
+    # TODO
+  end
+
+  class XrView < FFI::Struct
+    # TODO
+  end
+
+  class XrActionSetCreateInfo < FFI::Struct
+    # TODO
+  end
+
+  class XrActionCreateInfo < FFI::Struct
+    # TODO
+  end
+
+  class XrActionSuggestedBinding < FFI::Struct
+    # TODO
+  end
+
+  class XrInteractionProfileSuggestedBinding < FFI::Struct
+    # TODO
+  end
+
+  class XrSessionActionSetsAttachInfo < FFI::Struct
+    # TODO
+  end
+
+  class XrInteractionProfileState < FFI::Struct
+    # TODO
+  end
+
+  class XrActionStateGetInfo < FFI::Struct
+    # TODO
+  end
+
+  class XrActionStateBoolean < FFI::Struct
+    # TODO
+  end
+
+  class XrActionStateFloat < FFI::Struct
+    # TODO
+  end
+
+  class XrVector2f < FFI::Struct
+    # TODO
+  end
+
+  class XrActionStateVector2f < FFI::Struct
+    # TODO
+  end
+
+  class XrActionStatePose < FFI::Struct
+    # TODO
+  end
+
+  class XrActiveActionSet < FFI::Struct
+    # TODO
+  end
+
+  class XrActionsSyncInfo < FFI::Struct
+    # TODO
+  end
+
+  class XrBoundSourcesForActionEnumerateInfo < FFI::Struct
+    # TODO
+  end
+
+  class XrInputSourceLocalizedNameGetInfo < FFI::Struct
+    # TODO
+  end
+
+  class XrHapticActionInfo < FFI::Struct
+    # TODO
+  end
+
+  class XrHapticBaseHeader < FFI::Struct
+    # TODO
+  end
+
+  XrBaseInStructure  = XrBaseStructure
+  XrBaseOutStructure = XrBaseStructure
+
+  class XrOffset2Di < FFI::Struct
+    # TODO
+  end
+
+  class XrExtent2Di < FFI::Struct
+    # TODO
+  end
+
+  class XrRect2Di < FFI::Struct
+    # TODO
+  end
+
+  class XrSwapchainSubImage < FFI::Struct
+    # TODO
+  end
+
+  class XrCompositionLayerProjectionView < FFI::Struct
+    # TODO
+  end
+
+  class XrCompositionLayerProjection < FFI::Struct
+    # TODO
+  end
+
+  class XrCompositionLayerQuad < FFI::Struct
+    # TODO
+  end
+
+  class XrEventDataBaseHeader < FFI::Struct
+    # TODO
+  end
+
+  class XrEventDataEventsLost < FFI::Struct
+    # TODO
+  end
+
+  class XrEventDataInstanceLossPending < FFI::Struct
+    # TODO
+  end
+
+  class XrEventDataSessionStateChanged < FFI::Struct
+    # TODO
+  end
+
+  class XrEventDataReferenceSpaceChangePending < FFI::Struct
+    # TODO
+  end
+
+  class XrEventDataInteractionProfileChanged < FFI::Struct
+    # TODO
+  end
+
+  class XrHapticVibration < FFI::Struct
+    # TODO
+  end
+
+  class XrOffset2Df < FFI::Struct
+    # TODO
+  end
+
+  class XrRect2Df < FFI::Struct
+    # TODO
+  end
+
+  class XrVector4f < FFI::Struct
+    # TODO
+  end
+
+  class XrColor4f < FFI::Struct
+    # TODO
+  end
+
+  class XrCompositionLayerCubeKHR < FFI::Struct
+    # TODO
+  end
+
+  class XrCompositionLayerDepthInfoKHR < FFI::Struct
+    # TODO
+  end
+
+  class XrCompositionLayerCylinderKHR < FFI::Struct
+    # TODO
+  end
+
+  class XrCompositionLayerEquirectKHR < FFI::Struct
+    # TODO
+  end
+
+  class XrVisibilityMaskKHR < FFI::Struct
+    # TODO
+  end
+
+  class XrEventDataVisibilityMaskChangedKHR < FFI::Struct
+    # TODO
+  end
+
+  class XrEventDataPerfSettingsEXT < FFI::Struct
+    # TODO
+  end
+
+  class XrDebugUtilsObjectNameInfoEXT < FFI::Struct
+    # TODO
+  end
+
+  class XrDebugUtilsLabelEXT < FFI::Struct
+    # TODO
+  end
+
+  class XrDebugUtilsMessengerCallbackDataEXT < FFI::Struct
+    # TODO
+  end
+
+  class XrDebugUtilsMessengerCreateInfoEXT < FFI::Struct
+    # TODO
+  end
+
+  class XrSystemEyeGazeInteractionPropertiesEXT < FFI::Struct
+    # TODO
+  end
+
+  class XrEyeGazeSampleTimeEXT < FFI::Struct
+    # TODO
+  end
+
+  class XrSessionCreateInfoOverlayEXTX < FFI::Struct
+    # TODO
+  end
+
+  class XrEventDataMainSessionVisibilityChangedEXTX < FFI::Struct
+    # TODO
+  end
+
+  class XrSpatialAnchorCreateInfoMSFT < FFI::Struct
+    # TODO
+  end
+
+  class XrSpatialAnchorSpaceCreateInfoMSFT < FFI::Struct
+    # TODO
+  end
+
+  class XrViewConfigurationDepthRangeEXT < FFI::Struct
+    # TODO
+  end
+
+  class XrViewConfigurationViewFovEPIC < FFI::Struct
+    # TODO
+  end
+end # OpenXR::ABI

data/lib/openxr/action.rb

@@ -0,0 +1,12 @@
+# This is free and unencumbered software released into the public domain.
+
+require_relative 'api'
+require_relative 'handle'
+
+##
+# An OpenXR action handle.
+#
+# @see https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#input
+class OpenXR::Action < OpenXR::Handle
+  # TODO
+end # OpenXR::Action

data/lib/openxr/action_set.rb

@@ -0,0 +1,12 @@
+# This is free and unencumbered software released into the public domain.
+
+require_relative 'api'
+require_relative 'handle'
+
+##
+# An OpenXR action set handle.
+#
+# @see https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#input
+class OpenXR::ActionSet < OpenXR::Handle
+  # TODO
+end # OpenXR::ActionSet

data/lib/openxr/api.rb

@@ -0,0 +1,90 @@
+# This is free and unencumbered software released into the public domain.
+
+require_relative 'abi'
+
+require 'ffi'
+
+##
+# The OpenXR application programming interface (API).
+module OpenXR::API
+  extend OpenXR::ABI
+  include OpenXR::ABI
+
+  extend FFI::Library
+
+  ffi_lib ["libopenxr_loader.so.1", "openxr_loader"]
+
+  attach_function :xrAcquireSwapchainImage, [:pointer, :pointer, :pointer], :int
+  attach_function :xrApplyHapticFeedback, [:pointer, :pointer, :pointer], :int
+  attach_function :xrAttachSessionActionSets, [:pointer, :pointer], :int
+  attach_function :xrBeginFrame, [:pointer, :pointer], :int
+  attach_function :xrBeginSession, [:pointer, :pointer], :int
+  attach_function :xrCreateAction, [:pointer, :pointer, :pointer], :int
+  attach_function :xrCreateActionSet, [:pointer, :pointer, :pointer], :int
+  attach_function :xrCreateActionSpace, [:pointer, :pointer, :pointer], :int
+  #attach_function :xrCreateDebugUtilsMessengerEXT, [:pointer, :pointer, :pointer], :int
+  attach_function :xrCreateInstance, [:pointer, :pointer], :int
+  attach_function :xrCreateReferenceSpace, [:pointer, :pointer, :pointer], :int
+  attach_function :xrCreateSession, [:pointer, :pointer, :pointer], :int
+  #attach_function :xrCreateSpatialAnchorMSFT, [:pointer, :pointer, :pointer], :int
+  #attach_function :xrCreateSpatialAnchorSpaceMSFT, [:pointer, :pointer, :pointer], :int
+  attach_function :xrCreateSwapchain, [:pointer, :pointer, :pointer], :int
+  attach_function :xrDestroyAction, [:pointer], :int
+  attach_function :xrDestroyActionSet, [:pointer], :int
+  #attach_function :xrDestroyDebugUtilsMessengerEXT, [:pointer], :int
+  attach_function :xrDestroyInstance, [:pointer], :int
+  attach_function :xrDestroySession, [:pointer], :int
+  attach_function :xrDestroySpace, [:pointer], :int
+  #attach_function :xrDestroySpatialAnchorMSFT, [:pointer], :int
+  attach_function :xrDestroySwapchain, [:pointer], :int
+  attach_function :xrEndFrame, [:pointer, :pointer], :int
+  attach_function :xrEndSession, [:pointer], :int
+  attach_function :xrEnumerateApiLayerProperties, [:uint32, :pointer, :pointer], :int
+  attach_function :xrEnumerateBoundSourcesForAction, [:pointer, :pointer, :uint32, :pointer, :pointer], :int
+  attach_function :xrEnumerateEnvironmentBlendModes, [:pointer, :ulong_long, :int, :uint32, :pointer, :int], :int
+  attach_function :xrEnumerateInstanceExtensionProperties, [:string, :uint32, :pointer, :pointer], :int
+  attach_function :xrEnumerateReferenceSpaces, [:pointer, :uint32, :pointer, :int], :int
+  attach_function :xrEnumerateSwapchainFormats, [:pointer, :uint32, :pointer, :pointer], :int
+  attach_function :xrEnumerateSwapchainImages, [:pointer, :uint32, :pointer, :pointer], :int
+  attach_function :xrEnumerateViewConfigurationViews, [:pointer, :ulong_long, :int, :uint32, :pointer, :pointer], :int
+  attach_function :xrEnumerateViewConfigurations, [:pointer, :ulong_long, :uint32, :pointer, :int], :int
+  attach_function :xrGetActionStateBoolean, [:pointer, :pointer, :pointer], :int
+  attach_function :xrGetActionStateFloat, [:pointer, :pointer, :pointer], :int
+  attach_function :xrGetActionStatePose, [:pointer, :pointer, :pointer], :int
+  attach_function :xrGetActionStateVector2f, [:pointer, :pointer, :pointer], :int
+  attach_function :xrGetCurrentInteractionProfile, [:pointer, :ulong_long, :pointer], :int
+  attach_function :xrGetInputSourceLocalizedName, [:pointer, :pointer, :uint32, :pointer, :string], :int
+  attach_function :xrGetInstanceProcAddr, [:pointer, :string, :pointer], :int
+  attach_function :xrGetInstanceProperties, [:pointer, :pointer], :int
+  attach_function :xrGetReferenceSpaceBoundsRect, [:pointer, :int, :pointer], :int
+  attach_function :xrGetSystem, [:pointer, :pointer, :pointer], :int
+  attach_function :xrGetSystemProperties, [:pointer, :ulong_long, :pointer], :int
+  attach_function :xrGetViewConfigurationProperties, [:pointer, :ulong_long, :int, :pointer], :int
+  #attach_function :xrGetVisibilityMaskKHR, [:pointer, :int, :uint32, :int, :pointer], :int
+  attach_function :xrLocateSpace, [:pointer, :pointer, :long_long, :pointer], :int
+  attach_function :xrLocateViews, [:pointer, :pointer, :pointer, :uint32, :pointer, :pointer], :int
+  attach_function :xrPathToString, [:pointer, :ulong_long, :uint32, :pointer, :string], :int
+  #attach_function :xrPerfSettingsSetPerformanceLevelEXT, [:pointer, :int, :int], :int
+  attach_function :xrPollEvent, [:pointer, :pointer], :int
+  attach_function :xrReleaseSwapchainImage, [:pointer, :pointer], :int
+  attach_function :xrRequestExitSession, [:pointer], :int
+  attach_function :xrResultToString, [:pointer, :int, :pointer], :int
+  #attach_function :xrSessionBeginDebugUtilsLabelRegionEXT, [:pointer, :pointer], :int
+  #attach_function :xrSessionEndDebugUtilsLabelRegionEXT, [:pointer], :int
+  #attach_function :xrSessionInsertDebugUtilsLabelEXT, [:pointer, :pointer], :int
+  #attach_function :xrSetDebugUtilsObjectNameEXT, [:pointer, :pointer], :int
+  #attach_function :xrSetInputDeviceActiveEXT, [:pointer, :ulong_long, :ulong_long, :uint], :int
+  #attach_function :xrSetInputDeviceLocationEXT, [:pointer, :ulong_long, :ulong_long, :pointer, :pointer], :int
+  #attach_function :xrSetInputDeviceStateBoolEXT, [:pointer, :ulong_long, :ulong_long, :uint], :int
+  #attach_function :xrSetInputDeviceStateFloatEXT, [:pointer, :ulong_long, :ulong_long, :float], :int
+  #attach_function :xrSetInputDeviceStateVector2fEXT, [:pointer, :ulong_long, :ulong_long, :pointer], :int
+  attach_function :xrStopHapticFeedback, [:pointer, :pointer], :int
+  attach_function :xrStringToPath, [:pointer, :string, :pointer], :int
+  attach_function :xrStructureTypeToString, [:pointer, :int, :pointer], :int
+  #attach_function :xrSubmitDebugUtilsMessageEXT, [:pointer, :ulong_long, :ulong_long, :pointer], :int
+  attach_function :xrSuggestInteractionProfileBindings, [:pointer, :pointer], :int
+  attach_function :xrSyncActions, [:pointer, :pointer], :int
+  #attach_function :xrThermalGetTemperatureTrendEXT, [:pointer, :int, :int, :pointer, :pointer], :int
+  attach_function :xrWaitFrame, [:pointer, :pointer, :pointer], :int
+  attach_function :xrWaitSwapchainImage, [:pointer, :pointer], :int
+end # OpenXR::API

data/lib/openxr/extension.rb

@@ -0,0 +1,73 @@
+# This is free and unencumbered software released into the public domain.
+
+require_relative 'api'
+require_relative 'result'
+
+require 'ffi'
+
+##
+# An OpenXR instance extension.
+#
+# @see https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#extensions
+class OpenXR::Extension < Struct.new(:name, :version)
+  extend OpenXR::API
+  include OpenXR::API
+
+  ##
+  # @return [Integer]
+  def self.count
+    response = FFI::MemoryPointer.new(:uint32)
+    begin
+      # https://www.khronos.org/registry/OpenXR/specs/1.0/man/html/openxr.html#_xrenumerateinstanceextensionproperties3
+      case result = xrEnumerateInstanceExtensionProperties(nil, 0, response, nil)
+        when XR_SUCCESS then response.read(:uint32)
+        else raise OpenXR::Result.new(result, :xrEnumerateInstanceExtensionProperties)
+      end
+    ensure
+      response&.free
+    end
+  end
+
+  ##
+  # @yield  [extension]
+  # @return [Enumerator]
+  def self.each(&block)
+    return self.to_enum(:each) unless block_given?
+    self.list.each(&block)
+  end
+
+  ##
+  # @return [Array<Extension>]
+  def self.list
+    self.query.values
+  end
+
+  ##
+  # @return [Hash<Symbol, Extension>]
+  def self.query
+    request_count  = self.count
+    response_count = FFI::MemoryPointer.new(:uint32)
+    response_array = FFI::MemoryPointer.new(XrExtensionProperties, request_count)
+    begin
+      request_count.times do |i|
+        XrExtensionProperties.new(response_array[i])[:base][:type] = XR_TYPE_EXTENSION_PROPERTIES
+      end
+
+      # https://www.khronos.org/registry/OpenXR/specs/1.0/man/html/openxr.html#_xrenumerateinstanceextensionproperties3
+      case result = xrEnumerateInstanceExtensionProperties(nil, request_count, response_count, response_array)
+        when XR_SUCCESS
+          response_count.read(:uint32).times.inject({}) do |available, i|
+            response = XrExtensionProperties.new(response_array[i])
+            extension_name = response[:extensionName].to_s.to_sym
+            extension_version = response[:extensionVersion]
+            available[extension_name] = self.new(extension_name, extension_version)
+            available
+          end
+        else raise OpenXR::Result.new(result, :xrEnumerateInstanceExtensionProperties)
+      end
+    ensure
+      response_array&.free
+      response_count&.free
+    end
+  end
+end # OpenXR::Extension

data/lib/openxr/handle.rb

@@ -0,0 +1,15 @@
+# This is free and unencumbered software released into the public domain.
+
+require_relative 'api'
+
+##
+# An OpenXR handle.
+#
+# @see https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#handles
+class OpenXR::Handle
+  ##
+  # @return [void]
+  def destroy!
+    # subclasses MUST implement this
+  end
+end # OpenXR::Handle

data/lib/openxr/instance.rb

@@ -0,0 +1,70 @@
+# This is free and unencumbered software released into the public domain.
+
+require_relative 'api'
+require_relative 'handle'
+require_relative 'result'
+
+##
+# An OpenXR instance handle.
+#
+# @see https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#instance
+class OpenXR::Instance < OpenXR::Handle
+  include OpenXR::API
+
+  ##
+  # @param  [String, #to_s]  app_name
+  # @param  [Integer, #to_i] app_version
+  # @param  [Integer, #to_i] api_version
+  # @yield  [instance]
+  # @return [Object]
+  def self.create(app_name, app_version: nil, api_version: nil, &block)
+    instance = self.new(app_name, app_version: app_version, api_version: api_version)
+    begin
+      block.call(instance) if block_given?
+    ensure
+      instance&.destroy!
+    end
+  end
+
+  ##
+  # @param  [String, #to_s]  app_name
+  # @param  [Integer, #to_i] app_version
+  # @param  [Integer, #to_i] api_version
+  def initialize(app_name, app_version: nil, api_version: nil)
+    @struct = XrInstance.new
+
+    request = XrInstanceCreateInfo.new
+    request[:base][:type] = XR_TYPE_INSTANCE_CREATE_INFO
+    request[:base][:next] = nil
+    request[:createFlags] = 0
+    request[:applicationInfo][:applicationName] = app_name.to_s
+    request[:applicationInfo][:applicationVersion] = (app_version || 0).to_i
+    request[:applicationInfo][:engineName] = "OpenXR.rb"
+    request[:applicationInfo][:engineVersion] = 0
+    request[:applicationInfo][:apiVersion] = (api_version || XR_CURRENT_API_VERSION).to_i
+
+    # https://www.khronos.org/registry/OpenXR/specs/1.0/man/html/openxr.html#_xrcreateinstance3
+    case result = xrCreateInstance(request, @struct)
+      when XR_SUCCESS
+      else raise OpenXR::Result.new(result, :xrCreateInstance) # TODO
+    end
+  end
+
+  #
+  # @return [FFI::Pointer]
+  def handle
+    @struct[:handle]
+  end
+
+  ##
+  # @return [void]
+  def destroy!
+    return if @struct.nil?
+    # https://www.khronos.org/registry/OpenXR/specs/1.0/man/html/openxr.html#_xrdestroyinstance3
+    case result = xrDestroyInstance(@struct[:handle])
+      when XR_SUCCESS then @struct = nil
+      when XR_ERROR_HANDLE_INVALID then raise OpenXR::Result::HandleInvalid.new(:xrDestroyInstance)
+      else raise OpenXR::Result.new(result, :xrDestroyInstance) # unreachable
+    end
+  end
+end # OpenXR::Instance

data/lib/openxr/layer.rb

@@ -0,0 +1,11 @@
+# This is free and unencumbered software released into the public domain.
+
+require_relative 'api'
+
+##
+# An OpenXR API layer.
+#
+# @see https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#api-layers
+class OpenXR::Layer
+  # TODO
+end # OpenXR::Layer

data/lib/openxr/result.rb

@@ -0,0 +1,24 @@
+# This is free and unencumbered software released into the public domain.
+
+require_relative 'api'
+
+##
+# An OpenXR result code.
+#
+# @see https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#return-codes
+class OpenXR::Result < StandardError
+  include OpenXR::API
+
+  attr_reader :result
+
+  def initialize(result, function)
+    @result = result
+    super("#{function} returned #{result}")
+  end
+
+  class HandleInvalid < OpenXR::Result
+    def initialize(function)
+      super(XR_ERROR_HANDLE_INVALID, function)
+    end
+  end
+end # OpenXR::Result

data/lib/openxr/session.rb

@@ -0,0 +1,12 @@
+# This is free and unencumbered software released into the public domain.
+
+require_relative 'api'
+require_relative 'handle'
+
+##
+# An OpenXR session handle.
+#
+# @see https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#session
+class OpenXR::Session < OpenXR::Handle
+  # TODO
+end # OpenXR::Session

data/lib/openxr/space.rb

@@ -0,0 +1,12 @@
+# This is free and unencumbered software released into the public domain.
+
+require_relative 'api'
+require_relative 'handle'
+
+##
+# An OpenXR space handle.
+#
+# @see https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#spaces
+class OpenXR::Space < OpenXR::Handle
+  # TODO
+end # OpenXR::Space

data/lib/openxr/swapchain.rb

@@ -0,0 +1,12 @@
+# This is free and unencumbered software released into the public domain.
+
+require_relative 'api'
+require_relative 'handle'
+
+##
+# An OpenXR swapchain handle.
+#
+# @see https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#rendering
+class OpenXR::Swapchain < OpenXR::Handle
+  # TODO
+end # OpenXR::Swapchain

data/lib/openxr/system.rb

@@ -0,0 +1,82 @@
+# This is free and unencumbered software released into the public domain.
+
+require_relative 'api'
+require_relative 'result'
+
+##
+# An OpenXR system.
+#
+# @see https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#system
+class OpenXR::System
+  extend OpenXR::API
+  include OpenXR::API
+
+  ##
+  # @param  [Instance] instance
+  # @param  [XrFormFactor, #to_i] form_factor
+  # @return [System]
+  # @see    https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#form_factor_description
+  def self.for_form_factor(instance, form_factor)
+    request = XrSystemGetInfo.new
+    request[:base][:type] = XR_TYPE_SYSTEM_GET_INFO
+    request[:formFactor] = form_factor.to_i
+    system_id = FFI::MemoryPointer.new(XrSystemId)
+
+    begin
+      # https://www.khronos.org/registry/OpenXR/specs/1.0/man/html/openxr.html#_xrgetsystem3
+      case result = xrGetSystem(instance.handle, request, system_id)
+        when XR_SUCCESS then self.new(instance, system_id.read(XrSystemId))
+        #when XR_ERROR_FORM_FACTOR_UNAVAILABLE then # TODO
+        else raise OpenXR::Result.new(result, :xrGetSystem)
+      end
+    ensure
+      system_id&.free
+    end
+  end
+
+  # @return [Instance]
+  attr_reader :instance
+
+  # @return [API::XrSystemId]
+  attr_reader :id
+
+  # @return [String]
+  attr_reader :name
+
+  # @return [Integer]
+  attr_reader :vendor_id
+
+  # @return [Hash<Symbol, Integer>]
+  attr_reader :graphics_properties
+
+  # @return [Hash<Symbol, Bool>]
+  attr_reader :tracking_properties
+
+  ##
+  # @param  [Instance] instance
+  # @param  [API::XrSystemId, #to_i] id
+  def initialize(instance, id)
+    @instance = instance
+    @id = id.to_i
+
+    response = XrSystemProperties.new
+    response[:base][:type] = XR_TYPE_SYSTEM_PROPERTIES
+
+    # https://www.khronos.org/registry/OpenXR/specs/1.0/man/html/openxr.html#_xrgetsystemproperties3
+    case result = xrGetSystemProperties(@instance.handle, @id, response)
+      when XR_SUCCESS
+        @name = response[:systemName].to_s
+        @vendor_id = response[:vendorId]
+        @graphics_properties = {
+          :max_swapchain_image_height => response[:graphicsProperties][:maxSwapchainImageHeight],
+          :max_swapchain_image_width => response[:graphicsProperties][:maxSwapchainImageWidth],
+          :max_layer_count => response[:graphicsProperties][:maxLayerCount],
+        }
+        @tracking_properties = {
+          :orientation_tracking => response[:trackingProperties][:orientationTracking] == XR_TRUE,
+          :position_tracking    => response[:trackingProperties][:positionTracking] == XR_TRUE,
+        }
+      else raise OpenXR::Result.new(result, :xrGetSystemProperties)
+    end
+  end
+end # OpenXR::System

data/lib/openxr/version.rb

@@ -0,0 +1,21 @@
+# This is free and unencumbered software released into the public domain.
+
+module OpenXR
+  module VERSION
+    FILE = File.expand_path('../../VERSION', __dir__).freeze
+    STRING = File.read(FILE).chomp.freeze
+    MAJOR, MINOR, TINY, EXTRA = STRING.split('.').map(&:to_i).freeze
+
+    ##
+    # @return [String]
+    def self.to_s() STRING end
+
+    ##
+    # @return [String]
+    def self.to_str() STRING end
+
+    ##
+    # @return [Array(Integer, Integer, Integer)]
+    def self.to_a() [MAJOR, MINOR, TINY].freeze end
+  end # VERSION
+end # OpenXR

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: openxr
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Arto Bendiken
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffidb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+description: |
+  OpenXR.rb implements Ruby bindings for OpenXR 1.0, the open standard and
+  cross-platform API for virtual reality (VR) and augmented reality (AR)
+  hardware.
+email: arto@bendiken.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- AUTHORS
+- CHANGES.md
+- CREDITS.md
+- README.md
+- UNLICENSE
+- VERSION
+- lib/openxr.rb
+- lib/openxr/abi.rb
+- lib/openxr/action.rb
+- lib/openxr/action_set.rb
+- lib/openxr/api.rb
+- lib/openxr/extension.rb
+- lib/openxr/handle.rb
+- lib/openxr/instance.rb
+- lib/openxr/layer.rb
+- lib/openxr/result.rb
+- lib/openxr/session.rb
+- lib/openxr/space.rb
+- lib/openxr/swapchain.rb
+- lib/openxr/system.rb
+- lib/openxr/version.rb
+homepage: https://github.com/dryruby/openxr.rb
+licenses:
+- Unlicense
+metadata:
+  bug_tracker_uri: https://github.com/dryruby/openxr.rb/issues
+  changelog_uri: https://github.com/dryruby/openxr.rb/blob/master/CHANGES.md
+  documentation_uri: https://www.rubydoc.info/github/dryruby/openxr.rb/master
+  homepage_uri: https://github.com/dryruby/openxr.rb
+  source_code_uri: https://github.com/dryruby/openxr.rb
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.2
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: OpenXR bindings for Ruby.
+test_files: []