Class: OpenXR::Extension

Inherits:

Struct

Object
Struct
OpenXR::Extension

show all

Extended by:: API

Includes:: API

Defined in:: lib/openxr/extension.rb

Overview

An OpenXR instance extension.

Constant Summary

Constants included from ABI

Instance Attribute Summary collapse

#name ⇒ Object

Returns the value of attribute name.
#version ⇒ Object

Returns the value of attribute version.

Class Method Summary collapse

Methods included from ABI

XR_MAKE_VERSION

Instance Attribute Details

#name ⇒ `Object`

Returns the value of attribute name

Returns:

(Object) —

the current value of name



12
13
14

# File 'lib/openxr/extension.rb', line 12

def name
  @name
end

#version ⇒ `Object`

Returns the value of attribute version

Returns:

(Object) —

the current value of version



12
13
14

# File 'lib/openxr/extension.rb', line 12

def version
  @version
end

Class Method Details

.count ⇒ `Integer`

Returns:

(Integer)

Raises:

(Result::Error) —

if ‘:xrEnumerateInstanceExtensionProperties` failed

# File 'lib/openxr/extension.rb', line 19

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.for(result).new(:xrEnumerateInstanceExtensionProperties)
    end
  ensure
    response&.free
  end
end

.each {|extension| ... } ⇒ `Enumerator`

Yields:

(extension)

Returns:

(Enumerator)

# File 'lib/openxr/extension.rb', line 35

def self.each(&block)
  return self.to_enum(:each) unless block_given?
  self.list.each(&block)
end

.list ⇒ `Array<Extension>`

Returns:

(Array<Extension>)



42
43
44

# File 'lib/openxr/extension.rb', line 42

def self.list
  self.query.values
end

.query ⇒ `Hash<Symbol, Extension>`

Returns:

(Hash<Symbol, Extension>)

Raises:

(Result::Error) —

if ‘:xrEnumerateInstanceExtensionProperties` failed

# File 'lib/openxr/extension.rb', line 49

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]).set_type!
    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.for(result).new(:xrEnumerateInstanceExtensionProperties)
    end
  ensure
    response_array&.free
    response_count&.free
  end
end

Class: OpenXR::Extension

Overview

Constant Summary

Constants included from ABI

Instance Attribute Summary collapse

Class Method Summary collapse

Methods included from ABI

Instance Attribute Details

#name ⇒ Object

#version ⇒ Object

Class Method Details

.count ⇒ Integer

.each {|extension| ... } ⇒ Enumerator

.list ⇒ Array<Extension>

.query ⇒ Hash<Symbol, Extension>

#name ⇒ `Object`

#version ⇒ `Object`

.count ⇒ `Integer`

.each {|extension| ... } ⇒ `Enumerator`

.list ⇒ `Array<Extension>`

.query ⇒ `Hash<Symbol, Extension>`