Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrActionSuggestedBinding

extends Struct<XrActionSuggestedBinding>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Suggested binding for a single action.
Valid Usage (Implicit)
See Also

XrInteractionProfileSuggestedBinding, SuggestInteractionProfileBindings

Layout


struct XrActionSuggestedBinding {
    XrAction action;
    XrPath binding;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ACTION

The struct member offsets.

public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
BINDING

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
XrActionSuggestedBinding(long address, ByteBuffer container)

public
XrActionSuggestedBinding(ByteBuffer container)

Creates a XrActionSuggestedBinding instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public long
action()

the XrAction handle for an action

public XrActionSuggestedBinding
action(XrAction value)

Sets the specified value to the action field.

public long
binding()

the XrPath of a binding for the action specified in action.

public XrActionSuggestedBinding
binding(long value)

Sets the specified value to the binding field.

public static XrActionSuggestedBinding
calloc()

Returns a new XrActionSuggestedBinding instance allocated with memCalloc.

public static XrActionSuggestedBinding.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new XrActionSuggestedBinding.Buffer instance allocated with memCalloc.

public static XrActionSuggestedBinding
calloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new XrActionSuggestedBinding instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static XrActionSuggestedBinding.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new XrActionSuggestedBinding.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

protected XrActionSuggestedBinding
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static XrActionSuggestedBinding
create()

Returns a new XrActionSuggestedBinding instance allocated with BufferUtils.

public static XrActionSuggestedBinding
create(long address)

Returns a new XrActionSuggestedBinding instance for the specified memory address.

public static XrActionSuggestedBinding.Buffer
create(int
the buffer capacity
capacity
)

Returns a new XrActionSuggestedBinding.Buffer instance allocated with BufferUtils.

public static XrActionSuggestedBinding.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a XrActionSuggestedBinding.Buffer instance at the specified memory.

public static XrActionSuggestedBinding
createSafe(long address)

Like create, but returns null if address is NULL.

public static XrActionSuggestedBinding.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public static XrActionSuggestedBinding
malloc()

Returns a new XrActionSuggestedBinding instance allocated with memAlloc.

public static XrActionSuggestedBinding.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new XrActionSuggestedBinding.Buffer instance allocated with memAlloc.

public static XrActionSuggestedBinding
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new XrActionSuggestedBinding instance allocated on the specified MemoryStack.

public static XrActionSuggestedBinding.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new XrActionSuggestedBinding.Buffer instance allocated on the specified MemoryStack.

public static long
naction(long struct)

Unsafe version of action.

public static void
naction(long struct, XrAction value)

Unsafe version of action.

public static long
nbinding(long struct)

Unsafe version of binding.

public static void
nbinding(long struct, long value)

Unsafe version of binding.

public XrActionSuggestedBinding
set(XrAction action, long binding)

Initializes this struct with the specified values.

public XrActionSuggestedBinding

Returns:

this struct
set
(XrActionSuggestedBinding
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ACTIONback to summary
public static final int ACTION

The struct member offsets.

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

BINDINGback to summary
public static final int BINDING

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

XrActionSuggestedBindingback to summary
protected XrActionSuggestedBinding(long address, ByteBuffer container)
XrActionSuggestedBindingback to summary
public XrActionSuggestedBinding(ByteBuffer container)

Creates a XrActionSuggestedBinding instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.

The created instance holds a strong reference to the container object.

Method Detail

actionback to summary
public long action()

the XrAction handle for an action

Annotations
@NativeType:XrAction
actionback to summary
public XrActionSuggestedBinding action(XrAction value)

Sets the specified value to the action field.

bindingback to summary
public long binding()

the XrPath of a binding for the action specified in action. This path is any top level user path plus input source path, for example pathname:/user/hand/right/input/trigger/click. See suggested bindings for more details.

Annotations
@NativeType:XrPath
bindingback to summary
public XrActionSuggestedBinding binding(long value)

Sets the specified value to the binding field.

callocback to summary
public static XrActionSuggestedBinding calloc()

Returns a new XrActionSuggestedBinding instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static XrActionSuggestedBinding.Buffer calloc(int capacity)

Returns a new XrActionSuggestedBinding.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrActionSuggestedBinding calloc(MemoryStack stack)

Returns a new XrActionSuggestedBinding instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static XrActionSuggestedBinding.Buffer calloc(int capacity, MemoryStack stack)

Returns a new XrActionSuggestedBinding.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

createback to summary
protected XrActionSuggestedBinding create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static XrActionSuggestedBinding create()

Returns a new XrActionSuggestedBinding instance allocated with BufferUtils.

createback to summary
public static XrActionSuggestedBinding create(long address)

Returns a new XrActionSuggestedBinding instance for the specified memory address.

createback to summary
public static XrActionSuggestedBinding.Buffer create(int capacity)

Returns a new XrActionSuggestedBinding.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static XrActionSuggestedBinding.Buffer create(long address, int capacity)

Create a XrActionSuggestedBinding.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrActionSuggestedBinding createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static XrActionSuggestedBinding.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static XrActionSuggestedBinding malloc()

Returns a new XrActionSuggestedBinding instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static XrActionSuggestedBinding.Buffer malloc(int capacity)

Returns a new XrActionSuggestedBinding.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrActionSuggestedBinding malloc(MemoryStack stack)

Returns a new XrActionSuggestedBinding instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static XrActionSuggestedBinding.Buffer malloc(int capacity, MemoryStack stack)

Returns a new XrActionSuggestedBinding.Buffer instance allocated on the specified MemoryStack.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nactionback to summary
public static long naction(long struct)

Unsafe version of action.

nactionback to summary
public static void naction(long struct, XrAction value)

Unsafe version of action.

nbindingback to summary
public static long nbinding(long struct)

Unsafe version of binding.

nbindingback to summary
public static void nbinding(long struct, long value)

Unsafe version of binding.

setback to summary
public XrActionSuggestedBinding set(XrAction action, long binding)

Initializes this struct with the specified values.

setback to summary
public XrActionSuggestedBinding set(XrActionSuggestedBinding src)

Copies the specified struct data to this struct.

Parameters
src:XrActionSuggestedBinding

the source struct

Returns:XrActionSuggestedBinding

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.openxr back to summary

public Class XrActionSuggestedBinding.Buffer

extends StructBuffer<XrActionSuggestedBinding, XrActionSuggestedBinding.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of XrActionSuggestedBinding structs.

Field Summary

Modifier and TypeField and Description
private static final XrActionSuggestedBinding

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrActionSuggestedBinding.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public long

Returns:

the value of the XrActionSuggestedBinding#action field.
action
()

public XrActionSuggestedBinding.Buffer
action(XrAction value)

Sets the specified value to the XrActionSuggestedBinding#action field.

public long

Returns:

the value of the XrActionSuggestedBinding#binding field.
binding
()

public XrActionSuggestedBinding.Buffer
binding(long value)

Sets the specified value to the XrActionSuggestedBinding#binding field.

protected XrActionSuggestedBinding
protected XrActionSuggestedBinding.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XrActionSuggestedBinding ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new XrActionSuggestedBinding.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by XrActionSuggestedBinding#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

actionback to summary
public long action()
Returns:long

the value of the XrActionSuggestedBinding#action field.

Annotations
@NativeType:XrAction
actionback to summary
public XrActionSuggestedBinding.Buffer action(XrAction value)

Sets the specified value to the XrActionSuggestedBinding#action field.

bindingback to summary
public long binding()
Returns:long

the value of the XrActionSuggestedBinding#binding field.

Annotations
@NativeType:XrPath
bindingback to summary
public XrActionSuggestedBinding.Buffer binding(long value)

Sets the specified value to the XrActionSuggestedBinding#binding field.

getElementFactoryback to summary
protected XrActionSuggestedBinding getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
selfback to summary
protected XrActionSuggestedBinding.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override