OpenXRDpadBindingModifier

package
v0.0.0-...-357ca8a Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 20, 2025 License: MIT Imports: 28 Imported by: 0

Documentation

Overview

The DPad binding modifier converts an axis input to a dpad output, emulating a DPad. New input paths for each dpad direction will be added to the interaction profile. When bound to actions the DPad emulation will be activated. You should not combine dpad inputs with normal inputs in the same action set for the same control, this will result in an error being returned when suggested bindings are submitted to OpenXR.

See XR_EXT_dpad_binding for in-depth details.

Note: If the DPad binding modifier extension is enabled, all dpad binding paths will be available in the action map. Adding the modifier to an interaction profile allows you to further customize the behavior.

Index

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 Any

type Any interface {
	gd.IsClass
	AsOpenXRDpadBindingModifier() Instance
}

type Extension

type Extension[T gdclass.Interface] struct{ gdclass.Extension[T, Instance] }

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]) AsObject

func (self *Extension[T]) AsObject() [1]gd.Object

func (*Extension[T]) AsOpenXRBindingModifier

func (self *Extension[T]) AsOpenXRBindingModifier() OpenXRBindingModifier.Instance

func (*Extension[T]) AsOpenXRDpadBindingModifier

func (self *Extension[T]) AsOpenXRDpadBindingModifier() Instance

func (*Extension[T]) AsOpenXRIPBindingModifier

func (self *Extension[T]) AsOpenXRIPBindingModifier() OpenXRIPBindingModifier.Instance

func (*Extension[T]) AsRefCounted

func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted

func (*Extension[T]) AsResource

func (self *Extension[T]) AsResource() Resource.Instance

type ID

type ID Object.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.

func (ID) Instance

func (id ID) Instance() (Instance, bool)

type Instance

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 New

func New() Instance

func (Instance) ActionSet

func (self Instance) ActionSet() OpenXRActionSet.Instance

Action set for which this dpad binding modifier is active.

func (Instance) AsObject

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsOpenXRBindingModifier

func (self Instance) AsOpenXRBindingModifier() OpenXRBindingModifier.Instance

func (Instance) AsOpenXRDpadBindingModifier

func (self Instance) AsOpenXRDpadBindingModifier() Instance

func (Instance) AsOpenXRIPBindingModifier

func (self Instance) AsOpenXRIPBindingModifier() OpenXRIPBindingModifier.Instance

func (Instance) AsRefCounted

func (self Instance) AsRefCounted() [1]gd.RefCounted

func (Instance) AsResource

func (self Instance) AsResource() Resource.Instance

func (Instance) CenterRegion

func (self Instance) CenterRegion() Float.X

Center region in which our center position of our dpad return true.

func (Instance) ID

func (self Instance) ID() ID

func (Instance) InputPath

func (self Instance) InputPath() string

Input path for this dpad binding modifier.

func (Instance) IsSticky

func (self Instance) IsSticky() bool

If false, when the joystick enters a new dpad zone this becomes true.

If true, when the joystick remains in active dpad zone, this remains true even if we overlap with another zone.

func (Instance) OffHaptic

func (self Instance) OffHaptic() OpenXRHapticBase.Instance

Haptic pulse to emit when the user releases the input.

func (Instance) OnHaptic

func (self Instance) OnHaptic() OpenXRHapticBase.Instance

Haptic pulse to emit when the user presses the input.

func (Instance) SetActionSet

func (self Instance) SetActionSet(value OpenXRActionSet.Instance)

SetActionSet sets the property returned by [GetActionSet].

func (Instance) SetCenterRegion

func (self Instance) SetCenterRegion(value Float.X)

SetCenterRegion sets the property returned by [GetCenterRegion].

func (Instance) SetInputPath

func (self Instance) SetInputPath(value string)

SetInputPath sets the property returned by [GetInputPath].

func (Instance) SetIsSticky

func (self Instance) SetIsSticky(value bool)

SetIsSticky sets the property returned by [GetIsSticky].

func (*Instance) SetObject

func (self *Instance) SetObject(obj [1]gd.Object) bool

func (Instance) SetOffHaptic

func (self Instance) SetOffHaptic(value OpenXRHapticBase.Instance)

SetOffHaptic sets the property returned by [GetOffHaptic].

func (Instance) SetOnHaptic

func (self Instance) SetOnHaptic(value OpenXRHapticBase.Instance)

SetOnHaptic sets the property returned by [GetOnHaptic].

func (Instance) SetThreshold

func (self Instance) SetThreshold(value Float.X)

SetThreshold sets the property returned by [GetThreshold].

func (Instance) SetThresholdReleased

func (self Instance) SetThresholdReleased(value Float.X)

SetThresholdReleased sets the property returned by [GetThresholdReleased].

func (Instance) SetWedgeAngle

func (self Instance) SetWedgeAngle(value Angle.Radians)

SetWedgeAngle sets the property returned by [GetWedgeAngle].

func (Instance) Threshold

func (self Instance) Threshold() Float.X

When our input value is equal or larger than this value, our dpad in that direction becomes true. It stays true until it falls under the ThresholdReleased value.

func (Instance) ThresholdReleased

func (self Instance) ThresholdReleased() Float.X

When our input value falls below this, our output becomes false.

func (Instance) Virtual

func (self Instance) Virtual(name string) reflect.Value

func (Instance) WedgeAngle

func (self Instance) WedgeAngle() Angle.Radians

The angle of each wedge that identifies the 4 directions of the emulated dpad.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL