Documentation
¶
Overview ¶
OpenXR uses an action system similar to Godots Input map system to bind inputs and outputs on various types of XR controllers to named actions. OpenXR specifies more detail on these inputs and outputs than Godot supports.
Another important distinction is that OpenXR offers no control over these bindings. The bindings we register are suggestions, it is up to the XR runtime to offer users the ability to change these bindings. This allows the XR runtime to fill in the gaps if new hardware becomes available.
The action map therefore needs to be loaded at startup and can't be changed afterwards. This resource is a container for the entire action map.
Index ¶
- type Advanced
- type Any
- type Extension
- type ID
- type Instance
- func (self Instance) ActionSets() []OpenXRActionSet.Instance
- func (self Instance) AddActionSet(action_set OpenXRActionSet.Instance)
- func (self Instance) AddInteractionProfile(interaction_profile OpenXRInteractionProfile.Instance)
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsOpenXRActionMap() Instance
- func (self Instance) AsRefCounted() [1]gd.RefCounted
- func (self Instance) AsResource() Resource.Instance
- func (self Instance) CreateDefaultActionSets()
- func (self Instance) FindActionSet(name string) OpenXRActionSet.Instance
- func (self Instance) FindInteractionProfile(name string) OpenXRInteractionProfile.Instance
- func (self Instance) GetActionSet(idx int) OpenXRActionSet.Instance
- func (self Instance) GetActionSetCount() int
- func (self Instance) GetInteractionProfile(idx int) OpenXRInteractionProfile.Instance
- func (self Instance) GetInteractionProfileCount() int
- func (self Instance) ID() ID
- func (self Instance) InteractionProfiles() []OpenXRInteractionProfile.Instance
- func (self Instance) RemoveActionSet(action_set OpenXRActionSet.Instance)
- func (self Instance) RemoveInteractionProfile(interaction_profile OpenXRInteractionProfile.Instance)
- func (self Instance) SetActionSets(value []OpenXRActionSet.Instance)
- func (self Instance) SetInteractionProfiles(value []OpenXRInteractionProfile.Instance)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) Virtual(name string) reflect.Value
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Advanced ¶
type Advanced = class
Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.
type Extension ¶
Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension
func (*Extension[T]) AsOpenXRActionMap ¶
func (*Extension[T]) AsRefCounted ¶
func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
func (*Extension[T]) AsResource ¶
type ID ¶
ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.
type Instance ¶
type Instance [1]gdclass.OpenXRActionMap
Instance of the class with convieniently typed arguments and results.
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func (Instance) ActionSets ¶
func (self Instance) ActionSets() []OpenXRActionSet.Instance
func (Instance) AddActionSet ¶
func (self Instance) AddActionSet(action_set OpenXRActionSet.Instance)
Add an action set.
func (Instance) AddInteractionProfile ¶
func (self Instance) AddInteractionProfile(interaction_profile OpenXRInteractionProfile.Instance)
Add an interaction profile.
func (Instance) AsOpenXRActionMap ¶
func (Instance) AsRefCounted ¶
func (self Instance) AsRefCounted() [1]gd.RefCounted
func (Instance) AsResource ¶
func (Instance) CreateDefaultActionSets ¶
func (self Instance) CreateDefaultActionSets()
Setup this action set with our default actions.
func (Instance) FindActionSet ¶
func (self Instance) FindActionSet(name string) OpenXRActionSet.Instance
Retrieve an action set by name.
func (Instance) FindInteractionProfile ¶
func (self Instance) FindInteractionProfile(name string) OpenXRInteractionProfile.Instance
Find an interaction profile by its name (path).
func (Instance) GetActionSet ¶
func (self Instance) GetActionSet(idx int) OpenXRActionSet.Instance
Retrieve the action set at this index.
func (Instance) GetActionSetCount ¶
Retrieve the number of actions sets in our action map.
func (Instance) GetInteractionProfile ¶
func (self Instance) GetInteractionProfile(idx int) OpenXRInteractionProfile.Instance
Get the interaction profile at this index.
func (Instance) GetInteractionProfileCount ¶
Retrieve the number of interaction profiles in our action map.
func (Instance) InteractionProfiles ¶
func (self Instance) InteractionProfiles() []OpenXRInteractionProfile.Instance
func (Instance) RemoveActionSet ¶
func (self Instance) RemoveActionSet(action_set OpenXRActionSet.Instance)
Remove an action set.
func (Instance) RemoveInteractionProfile ¶
func (self Instance) RemoveInteractionProfile(interaction_profile OpenXRInteractionProfile.Instance)
Remove an interaction profile.
func (Instance) SetActionSets ¶
func (self Instance) SetActionSets(value []OpenXRActionSet.Instance)
func (Instance) SetInteractionProfiles ¶
func (self Instance) SetInteractionProfiles(value []OpenXRInteractionProfile.Instance)
Source Files