openxr 0.3.0 → 0.4.0

checksums.yaml

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

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/lib/openxr/abi.rb

@@ -5,6 +5,24 @@ require 'ffi'
 ##
 # The OpenXR application binary interface (ABI).
 module OpenXR::ABI
+  # @private
+  module InitializeWithType
+    def self.included(klass)
+      ##
+      # @param  [FFI::AbstractMemory] pointer
+      def initialize(pointer = nil)
+        super(pointer)
+        self.set_type! if pointer.nil?
+      end
+
+      ##
+      # @return [void]
+      def set_type!
+        self[:base][:type] = self.class.const_get(:TYPE)
+      end
+    end
+  end
+
   ##
   # @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)
@@ -64,21 +82,155 @@ module OpenXR::ABI
   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
+  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                       = :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
+  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                          = :int # enum
   XR_FORM_FACTOR_HEAD_MOUNTED_DISPLAY   = 1
@@ -94,6 +246,8 @@ module OpenXR::ABI
   end
 
   class XrApiLayerProperties < FFI::Struct
+    TYPE = XR_TYPE_API_LAYER_PROPERTIES
+    include InitializeWithType
     layout :base,                    XrBaseStructure,
            :layerName,               [:char, XR_MAX_API_LAYER_NAME_SIZE],
            :specVersion,             XrVersion,
@@ -102,6 +256,8 @@ module OpenXR::ABI
   end
 
   class XrExtensionProperties < FFI::Struct
+    TYPE = XR_TYPE_EXTENSION_PROPERTIES
+    include InitializeWithType
     layout :base,                    XrBaseStructure,
            :extensionName,           [:char, XR_MAX_EXTENSION_NAME_SIZE],
            :extensionVersion,        :uint32
@@ -116,6 +272,8 @@ module OpenXR::ABI
   end
 
   class XrInstanceCreateInfo < FFI::Struct
+    TYPE = XR_TYPE_INSTANCE_CREATE_INFO
+    include InitializeWithType
     layout :base,                    XrBaseStructure,
            :createFlags,             XrInstanceCreateFlags,
            :applicationInfo,         XrApplicationInfo,
@@ -126,17 +284,23 @@ module OpenXR::ABI
   end
 
   class XrInstanceProperties < FFI::Struct
+    TYPE = XR_TYPE_INSTANCE_PROPERTIES
+    include InitializeWithType
     layout :base,                    XrBaseStructure,
            :runtimeVersion,          XrVersion,
            :runtimeName,             [:char, XR_MAX_RUNTIME_NAME_SIZE]
   end
 
   class XrEventDataBuffer < FFI::Struct
+    TYPE = XR_TYPE_EVENT_DATA_BUFFER
+    include InitializeWithType
     layout :base,                    XrBaseStructure,
            :varying,                 :uint8
   end
 
   class XrSystemGetInfo < FFI::Struct
+    TYPE = XR_TYPE_SYSTEM_GET_INFO
+    include InitializeWithType
     layout :base,                    XrBaseStructure,
            :formFactor,              XrFormFactor
   end
@@ -153,6 +317,8 @@ module OpenXR::ABI
   end
 
   class XrSystemProperties < FFI::Struct
+    TYPE = XR_TYPE_SYSTEM_PROPERTIES
+    include InitializeWithType
     layout :base,                    XrBaseStructure,
            :systemId,                XrSystemId,
            :vendorId,                :uint32,
@@ -162,6 +328,8 @@ module OpenXR::ABI
   end
 
   class XrSessionCreateInfo < FFI::Struct
+    TYPE = XR_TYPE_SESSION_CREATE_INFO
+    include InitializeWithType
     layout :base,                    XrBaseStructure,
            :createFlags,             XrSessionCreateFlags,
            :systemId,                XrSystemId

data/lib/openxr/extension.rb

@@ -15,13 +15,14 @@ class OpenXR::Extension < Struct.new(:name, :version)
 
   ##
   # @return [Integer]
+  # @raise  [Result::Error] if `:xrEnumerateInstanceExtensionProperties` failed
   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)
+        else raise OpenXR::Result.for(result).new(:xrEnumerateInstanceExtensionProperties)
       end
     ensure
       response&.free
@@ -44,13 +45,14 @@ class OpenXR::Extension < Struct.new(:name, :version)
 
   ##
   # @return [Hash<Symbol, Extension>]
+  # @raise  [Result::Error] if `:xrEnumerateInstanceExtensionProperties` failed
   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
+        XrExtensionProperties.new(response_array[i]).set_type!
       end
 
       # https://www.khronos.org/registry/OpenXR/specs/1.0/man/html/openxr.html#_xrenumerateinstanceextensionproperties3
@@ -63,7 +65,7 @@ class OpenXR::Extension < Struct.new(:name, :version)
             available[extension_name] = self.new(extension_name, extension_version)
             available
           end
-        else raise OpenXR::Result.new(result, :xrEnumerateInstanceExtensionProperties)
+        else raise OpenXR::Result.for(result).new(:xrEnumerateInstanceExtensionProperties)
       end
     ensure
       response_array&.free

data/lib/openxr/instance.rb

@@ -30,6 +30,7 @@ class OpenXR::Instance < OpenXR::Handle
   # @param  [String, #to_s]  app_name
   # @param  [Integer, #to_i] app_version
   # @param  [Integer, #to_i] api_version
+  # @raise  [Result::Error] if `xrCreateInstance` failed
   def initialize(app_name, app_version: nil, api_version: nil)
     @struct = XrInstance.new
 
@@ -46,7 +47,7 @@ class OpenXR::Instance < OpenXR::Handle
     # 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
+      else raise OpenXR::Result.for(result).new(:xrCreateInstance)
     end
   end
 
@@ -58,13 +59,13 @@ class OpenXR::Instance < OpenXR::Handle
 
   ##
   # @return [void]
+  # @raise  [Result::Error] if `xrDestroyInstance` failed
   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
+      else raise OpenXR::Result.for(result).new(:xrDestroyInstance) # unreachable
     end
   end
 end # OpenXR::Instance

data/lib/openxr/result.rb

@@ -9,15 +9,49 @@ require_relative 'api'
 class OpenXR::Result < StandardError
   include OpenXR::API
 
+  # @return [Integer]
   attr_reader :result
 
-  def initialize(result, function)
-    @result = result
-    super("#{function} returned #{result}")
+  # @return [Symbol]
+  attr_reader :function
+
+  ##
+  # @param  [Integer] result
+  # @return [Class]
+  def self.for(result)
+    case result
+      # https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#fundamentals-successcodes
+      when XR_SUCCESS then Success
+      when XR_TIMEOUT_EXPIRED then Success
+      when XR_SESSION_LOSS_PENDING then Success
+      when XR_EVENT_UNAVAILABLE then Success
+      when XR_SPACE_BOUNDS_UNAVAILABLE then Success
+      when XR_SESSION_NOT_FOCUSED then Success
+      when XR_FRAME_DISCARDED then Success
+      # https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#fundamentals-errorcodes
+      when XR_ERROR_HANDLE_INVALID then HandleInvalid
+      #when XR_ERROR_FORM_FACTOR_UNAVAILABLE then # TODO
+      else self
+    end
+  end
+
+  ##
+  # @param  [Integer, #to_i] result
+  # @param  [Symbol] function
+  def initialize(result, function = nil)
+    @result = result.to_i
+    @function = function
+    super(@function ? "#{@function} returned #{@result}" : @result.to_s)
   end
 
-  class HandleInvalid < OpenXR::Result
-    def initialize(function)
+  class Success < OpenXR::Result; end
+
+  class Error < OpenXR::Result; end
+
+  class HandleInvalid < Error
+    ##
+    # @param  [Symbol] function
+    def initialize(function = nil)
       super(XR_ERROR_HANDLE_INVALID, function)
     end
   end

data/lib/openxr/session.rb

@@ -2,11 +2,59 @@
 
 require_relative 'api'
 require_relative 'handle'
+require_relative 'result'
 
 ##
 # An OpenXR session handle.
 #
 # @see https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#session
 class OpenXR::Session < OpenXR::Handle
-  # TODO
+  extend OpenXR::API
+  include OpenXR::API
+
+  # @return [Instance]
+  attr_reader :instance
+
+  # @return [System]
+  attr_reader :system
+
+  ##
+  # @param  [System]
+  # @param  [XrGraphicsBinding] graphics_binding
+  # @raise  [Result::Error] if `xrCreateSession` failed
+  def initialize(system, graphics_binding = nil)
+    @instance = system.instance
+    @system   = system
+    @struct   = XrSession.new
+
+    # https://www.khronos.org/registry/OpenXR/specs/1.0/man/html/openxr.html#_xrsessioncreateinfo3
+    request = XrSessionCreateInfo.new
+    request[:base][:next] = graphics_binding
+    request[:createFlags] = 0
+    request[:systemId] = system.id
+
+    # https://www.khronos.org/registry/OpenXR/specs/1.0/man/html/openxr.html#_xrcreatesession3
+    case result = xrCreateSession(instance.handle, request, @struct)
+      when XR_SUCCESS
+      else raise OpenXR::Result.for(result).new(:xrCreateSession)
+    end
+  end
+
+  #
+  # @return [FFI::Pointer]
+  def handle
+    @struct[:handle]
+  end
+
+  ##
+  # @return [void]
+  # @raise  [Result::Error] if `xrDestroySession` failed
+  def destroy!
+    return if @struct.nil?
+    # https://www.khronos.org/registry/OpenXR/specs/1.0/man/html/openxr.html#_xrdestroysession3
+    case result = xrDestroySession(@struct[:handle])
+      when XR_SUCCESS then @struct = nil
+      else raise OpenXR::Result.for(result).new(:xrDestroySession) # unreachable
+    end
+  end
 end # OpenXR::Session

data/lib/openxr/system.rb

@@ -14,11 +14,11 @@ class OpenXR::System
   ##
   # @param  [Instance] instance
   # @param  [XrFormFactor, #to_i] form_factor
-  # @return [System]
+  # @return [System] if the form factor is supported
+  # @raise  [Result::Error] if `xrGetSystem` failed
   # @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)
 
@@ -26,8 +26,8 @@ class OpenXR::System
       # 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)
+        when XR_ERROR_FORM_FACTOR_UNAVAILABLE then nil
+        else raise OpenXR::Result.for(result).new(:xrGetSystem)
       end
     ensure
       system_id&.free
@@ -55,12 +55,12 @@ class OpenXR::System
   ##
   # @param  [Instance] instance
   # @param  [API::XrSystemId, #to_i] id
+  # @raise  [Result::Error] if `xrGetSystemProperties` failed
   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)
@@ -76,7 +76,7 @@ class OpenXR::System
           :orientation_tracking => response[:trackingProperties][:orientationTracking] == XR_TRUE,
           :position_tracking    => response[:trackingProperties][:positionTracking] == XR_TRUE,
         }
-      else raise OpenXR::Result.new(result, :xrGetSystemProperties)
+      else raise OpenXR::Result.for(result).new(:xrGetSystemProperties)
     end
   end
 end # OpenXR::System

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openxr
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Arto Bendiken