Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrInteractionProfileSuggestedBinding

extends Struct<XrInteractionProfileSuggestedBinding>
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 bindings for a interaction profile.
Valid Usage (Implicit)
See Also

XrActionSuggestedBinding, SuggestInteractionProfileBindings

Layout


struct XrInteractionProfileSuggestedBinding {
    XrStructureType type;
    void const * next;
    XrPath interactionProfile;
    uint32_t countSuggestedBindings;
    XrActionSuggestedBinding const * suggestedBindings;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
COUNTSUGGESTEDBINDINGS

The struct member offsets.

public static final int
INTERACTIONPROFILE

The struct member offsets.

public static final int
NEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
SUGGESTEDBINDINGS

The struct member offsets.

public static final int
TYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
XrInteractionProfileSuggestedBinding(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrInteractionProfileSuggestedBinding
calloc()

Returns a new XrInteractionProfileSuggestedBinding instance allocated with memCalloc.

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

Returns a new XrInteractionProfileSuggestedBinding.Buffer instance allocated with memCalloc.

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

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

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

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

public int
countSuggestedBindings()

the number of suggested bindings in the array pointed to by suggestedBindings.

protected XrInteractionProfileSuggestedBinding
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 XrInteractionProfileSuggestedBinding
create()

Returns a new XrInteractionProfileSuggestedBinding instance allocated with BufferUtils.

public static XrInteractionProfileSuggestedBinding
create(long address)

Returns a new XrInteractionProfileSuggestedBinding instance for the specified memory address.

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

Returns a new XrInteractionProfileSuggestedBinding.Buffer instance allocated with BufferUtils.

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

Create a XrInteractionProfileSuggestedBinding.Buffer instance at the specified memory.

public static XrInteractionProfileSuggestedBinding
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long
interactionProfile()

the XrPath of an interaction profile.

public XrInteractionProfileSuggestedBinding
interactionProfile(long value)

Sets the specified value to the interactionProfile field.

public static XrInteractionProfileSuggestedBinding
malloc()

Returns a new XrInteractionProfileSuggestedBinding instance allocated with memAlloc.

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

Returns a new XrInteractionProfileSuggestedBinding.Buffer instance allocated with memAlloc.

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

Returns a new XrInteractionProfileSuggestedBinding instance allocated on the specified MemoryStack.

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

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

public static int
ncountSuggestedBindings(long struct)

Unsafe version of countSuggestedBindings.

public static void
ncountSuggestedBindings(long struct, int value)

Sets the specified value to the countSuggestedBindings field of the specified struct.

public long
next()

NULL or a pointer to the next structure in a structure chain.

public XrInteractionProfileSuggestedBinding
next(long value)

Sets the specified value to the next field.

public XrInteractionProfileSuggestedBinding
next(XrBindingModificationsKHR value)

Prepends the specified XrBindingModificationsKHR value to the next chain.

public static long
ninteractionProfile(long struct)

Unsafe version of interactionProfile.

public static void
ninteractionProfile(long struct, long value)

Unsafe version of interactionProfile.

public static long
nnext(long struct)

Unsafe version of next.

public static void
nnext(long struct, long value)

Unsafe version of next.

public static XrActionSuggestedBinding.Buffer
nsuggestedBindings(long struct)

Unsafe version of suggestedBindings.

public static void
public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public XrInteractionProfileSuggestedBinding
set(int type, long next, long interactionProfile, XrActionSuggestedBinding.Buffer suggestedBindings)

Initializes this struct with the specified values.

public XrInteractionProfileSuggestedBinding

Returns:

this struct
set
(XrInteractionProfileSuggestedBinding
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 XrActionSuggestedBinding.Buffer
suggestedBindings()

a pointer to an array of XrActionSuggestedBinding structures that define all of the application’s suggested bindings for the specified interaction profile.

public XrInteractionProfileSuggestedBinding
public int
type()

the XrStructureType of this structure.

public XrInteractionProfileSuggestedBinding
type(int value)

Sets the specified value to the type field.

public XrInteractionProfileSuggestedBinding
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

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

COUNTSUGGESTEDBINDINGSback to summary
public static final int COUNTSUGGESTEDBINDINGS

The struct member offsets.

INTERACTIONPROFILEback to summary
public static final int INTERACTIONPROFILE

The struct member offsets.

NEXTback to summary
public static final int NEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

SUGGESTEDBINDINGSback to summary
public static final int SUGGESTEDBINDINGS

The struct member offsets.

TYPEback to summary
public static final int TYPE

The struct member offsets.

Constructor Detail

XrInteractionProfileSuggestedBindingback to summary
protected XrInteractionProfileSuggestedBinding(long address, ByteBuffer container)
XrInteractionProfileSuggestedBindingback to summary
public XrInteractionProfileSuggestedBinding(ByteBuffer container)

Creates a XrInteractionProfileSuggestedBinding 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

callocback to summary
public static XrInteractionProfileSuggestedBinding calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrInteractionProfileSuggestedBinding calloc(MemoryStack stack)

Returns a new XrInteractionProfileSuggestedBinding 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 XrInteractionProfileSuggestedBinding.Buffer calloc(int capacity, MemoryStack stack)

Returns a new XrInteractionProfileSuggestedBinding.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

countSuggestedBindingsback to summary
public int countSuggestedBindings()

the number of suggested bindings in the array pointed to by suggestedBindings.

Annotations
@NativeType:uint32_t
createback to summary
protected XrInteractionProfileSuggestedBinding 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 XrInteractionProfileSuggestedBinding create()

Returns a new XrInteractionProfileSuggestedBinding instance allocated with BufferUtils.

createback to summary
public static XrInteractionProfileSuggestedBinding create(long address)

Returns a new XrInteractionProfileSuggestedBinding instance for the specified memory address.

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

Returns a new XrInteractionProfileSuggestedBinding.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrInteractionProfileSuggestedBinding.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrInteractionProfileSuggestedBinding createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
interactionProfileback to summary
public long interactionProfile()

the XrPath of an interaction profile.

Annotations
@NativeType:XrPath
interactionProfileback to summary
public XrInteractionProfileSuggestedBinding interactionProfile(long value)

Sets the specified value to the interactionProfile field.

mallocback to summary
public static XrInteractionProfileSuggestedBinding malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrInteractionProfileSuggestedBinding malloc(MemoryStack stack)

Returns a new XrInteractionProfileSuggestedBinding instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

ncountSuggestedBindingsback to summary
public static int ncountSuggestedBindings(long struct)

Unsafe version of countSuggestedBindings.

ncountSuggestedBindingsback to summary
public static void ncountSuggestedBindings(long struct, int value)

Sets the specified value to the countSuggestedBindings field of the specified struct.

nextback to summary
public long next()

NULL or a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR.

Annotations
@NativeType:void const *
nextback to summary
public XrInteractionProfileSuggestedBinding next(long value)

Sets the specified value to the next field.

nextback to summary
public XrInteractionProfileSuggestedBinding next(XrBindingModificationsKHR value)

Prepends the specified XrBindingModificationsKHR value to the next chain.

ninteractionProfileback to summary
public static long ninteractionProfile(long struct)

Unsafe version of interactionProfile.

ninteractionProfileback to summary
public static void ninteractionProfile(long struct, long value)

Unsafe version of interactionProfile.

nnextback to summary
public static long nnext(long struct)

Unsafe version of next.

nnextback to summary
public static void nnext(long struct, long value)

Unsafe version of next.

nsuggestedBindingsback to summary
public static XrActionSuggestedBinding.Buffer nsuggestedBindings(long struct)

Unsafe version of suggestedBindings.

nsuggestedBindingsback to summary
public static void nsuggestedBindings(long struct, XrActionSuggestedBinding.Buffer value)

Unsafe version of suggestedBindings.

ntypeback to summary
public static int ntype(long struct)

Unsafe version of type.

ntypeback to summary
public static void ntype(long struct, int value)

Unsafe version of type.

setback to summary
public XrInteractionProfileSuggestedBinding set(int type, long next, long interactionProfile, XrActionSuggestedBinding.Buffer suggestedBindings)

Initializes this struct with the specified values.

setback to summary
public XrInteractionProfileSuggestedBinding set(XrInteractionProfileSuggestedBinding src)

Copies the specified struct data to this struct.

Parameters
src:XrInteractionProfileSuggestedBinding

the source struct

Returns:XrInteractionProfileSuggestedBinding

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
suggestedBindingsback to summary
public XrActionSuggestedBinding.Buffer suggestedBindings()

a pointer to an array of XrActionSuggestedBinding structures that define all of the application’s suggested bindings for the specified interaction profile.

Annotations
@NativeType:XrActionSuggestedBinding const *
suggestedBindingsback to summary
public XrInteractionProfileSuggestedBinding suggestedBindings(XrActionSuggestedBinding.Buffer value)

Sets the address of the specified XrActionSuggestedBinding.Buffer to the suggestedBindings field.

typeback to summary
public int type()

the XrStructureType of this structure.

Annotations
@NativeType:XrStructureType
typeback to summary
public XrInteractionProfileSuggestedBinding type(int value)

Sets the specified value to the type field.

type$Defaultback to summary
public XrInteractionProfileSuggestedBinding type$Default()

Sets the TYPE_INTERACTION_PROFILE_SUGGESTED_BINDING value to the type field.

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 XrInteractionProfileSuggestedBinding.Buffer

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

An array of XrInteractionProfileSuggestedBinding structs.

Field Summary

Modifier and TypeField and Description
private static final XrInteractionProfileSuggestedBinding

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrInteractionProfileSuggestedBinding.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 int
protected XrInteractionProfileSuggestedBinding
public long
public XrInteractionProfileSuggestedBinding.Buffer
interactionProfile(long value)

Sets the specified value to the XrInteractionProfileSuggestedBinding#interactionProfile field.

public long

Returns:

the value of the XrInteractionProfileSuggestedBinding#next field.
next
()

public XrInteractionProfileSuggestedBinding.Buffer
next(long value)

Sets the specified value to the XrInteractionProfileSuggestedBinding#next field.

public XrInteractionProfileSuggestedBinding.Buffer
next(XrBindingModificationsKHR value)

Prepends the specified XrBindingModificationsKHR value to the next chain.

protected XrInteractionProfileSuggestedBinding.Buffer
public XrActionSuggestedBinding.Buffer
public XrInteractionProfileSuggestedBinding.Buffer
public int

Returns:

the value of the XrInteractionProfileSuggestedBinding#type field.
type
()

public XrInteractionProfileSuggestedBinding.Buffer
type(int value)

Sets the specified value to the XrInteractionProfileSuggestedBinding#type field.

public XrInteractionProfileSuggestedBinding.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XrInteractionProfileSuggestedBinding ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new XrInteractionProfileSuggestedBinding.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 XrInteractionProfileSuggestedBinding#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

countSuggestedBindingsback to summary
public int countSuggestedBindings()
Returns:int

the value of the XrInteractionProfileSuggestedBinding#countSuggestedBindings field.

Annotations
@NativeType:uint32_t
getElementFactoryback to summary
protected XrInteractionProfileSuggestedBinding getElementFactory()

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

Annotations
@Override
interactionProfileback to summary
public long interactionProfile()
Returns:long

the value of the XrInteractionProfileSuggestedBinding#interactionProfile field.

Annotations
@NativeType:XrPath
interactionProfileback to summary
public XrInteractionProfileSuggestedBinding.Buffer interactionProfile(long value)

Sets the specified value to the XrInteractionProfileSuggestedBinding#interactionProfile field.

nextback to summary
public long next()
Returns:long

the value of the XrInteractionProfileSuggestedBinding#next field.

Annotations
@NativeType:void const *
nextback to summary
public XrInteractionProfileSuggestedBinding.Buffer next(long value)

Sets the specified value to the XrInteractionProfileSuggestedBinding#next field.

nextback to summary
public XrInteractionProfileSuggestedBinding.Buffer next(XrBindingModificationsKHR value)

Prepends the specified XrBindingModificationsKHR value to the next chain.

selfback to summary
protected XrInteractionProfileSuggestedBinding.Buffer self()

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

Annotations
@Override
suggestedBindingsback to summary
public XrActionSuggestedBinding.Buffer suggestedBindings()
Returns:XrActionSuggestedBinding.Buffer

a XrActionSuggestedBinding.Buffer view of the struct array pointed to by the XrInteractionProfileSuggestedBinding#suggestedBindings field.

Annotations
@NativeType:XrActionSuggestedBinding const *
suggestedBindingsback to summary
public XrInteractionProfileSuggestedBinding.Buffer suggestedBindings(XrActionSuggestedBinding.Buffer value)

Sets the address of the specified XrActionSuggestedBinding.Buffer to the XrInteractionProfileSuggestedBinding#suggestedBindings field.

typeback to summary
public int type()
Returns:int

the value of the XrInteractionProfileSuggestedBinding#type field.

Annotations
@NativeType:XrStructureType
typeback to summary
public XrInteractionProfileSuggestedBinding.Buffer type(int value)

Sets the specified value to the XrInteractionProfileSuggestedBinding#type field.

type$Defaultback to summary
public XrInteractionProfileSuggestedBinding.Buffer type$Default()

Sets the TYPE_INTERACTION_PROFILE_SUGGESTED_BINDING value to the XrInteractionProfileSuggestedBinding#type field.