Package org.lwjgl.openxr

Class XrInteractionProfileSuggestedBinding

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrInteractionProfileSuggestedBinding>

org.lwjgl.openxr.XrInteractionProfileSuggestedBinding

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class XrInteractionProfileSuggestedBinding
extends org.lwjgl.system.Struct<XrInteractionProfileSuggestedBinding>
implements org.lwjgl.system.NativeResource

Suggested bindings for a interaction profile.

Valid Usage (Implicit)

• type must be TYPE_INTERACTION_PROFILE_SUGGESTED_BINDING
• next must be NULL or a valid pointer to the next structure in a structure chain. See also: XrBindingModificationsKHR
• suggestedBindings must be a pointer to an array of countSuggestedBindings valid XrActionSuggestedBinding structures
• The countSuggestedBindings parameter must be greater than 0

See Also

XrActionSuggestedBinding, SuggestInteractionProfileBindings

Layout

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrInteractionProfileSuggestedBinding.Buffer	An array of XrInteractionProfileSuggestedBinding structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	COUNTSUGGESTEDBINDINGS	The struct member offsets.
static final int	INTERACTIONPROFILE	The struct member offsets.
static final int	NEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	SUGGESTEDBINDINGS	The struct member offsets.
static final int	TYPE	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
XrInteractionProfileSuggestedBinding(ByteBuffer container)	Creates a XrInteractionProfileSuggestedBinding instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrInteractionProfileSuggestedBinding	calloc()	Returns a new XrInteractionProfileSuggestedBinding instance allocated with memCalloc.
static XrInteractionProfileSuggestedBinding.Buffer	calloc(int capacity)	Returns a new XrInteractionProfileSuggestedBinding.Buffer instance allocated with memCalloc.
static XrInteractionProfileSuggestedBinding.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrInteractionProfileSuggestedBinding.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrInteractionProfileSuggestedBinding	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrInteractionProfileSuggestedBinding instance allocated on the specified MemoryStack and initializes all its bits to zero.
int	countSuggestedBindings()	the number of suggested bindings in the array pointed to by suggestedBindings.
static XrInteractionProfileSuggestedBinding	create()	Returns a new XrInteractionProfileSuggestedBinding instance allocated with BufferUtils.
static XrInteractionProfileSuggestedBinding.Buffer	create(int capacity)	Returns a new XrInteractionProfileSuggestedBinding.Buffer instance allocated with BufferUtils.
static XrInteractionProfileSuggestedBinding	create(long address)	Returns a new XrInteractionProfileSuggestedBinding instance for the specified memory address.
static XrInteractionProfileSuggestedBinding.Buffer	create(long address, int capacity)	Create a XrInteractionProfileSuggestedBinding.Buffer instance at the specified memory.
static @Nullable XrInteractionProfileSuggestedBinding	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrInteractionProfileSuggestedBinding.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	interactionProfile()	the XrPath of an interaction profile.
XrInteractionProfileSuggestedBinding	interactionProfile(long value)	Sets the specified value to the interactionProfile() field.
static XrInteractionProfileSuggestedBinding	malloc()	Returns a new XrInteractionProfileSuggestedBinding instance allocated with memAlloc.
static XrInteractionProfileSuggestedBinding.Buffer	malloc(int capacity)	Returns a new XrInteractionProfileSuggestedBinding.Buffer instance allocated with memAlloc.
static XrInteractionProfileSuggestedBinding.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrInteractionProfileSuggestedBinding.Buffer instance allocated on the specified MemoryStack.
static XrInteractionProfileSuggestedBinding	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrInteractionProfileSuggestedBinding instance allocated on the specified MemoryStack.
static int	ncountSuggestedBindings(long struct)	Unsafe version of countSuggestedBindings().
static void	ncountSuggestedBindings(long struct, int value)	Sets the specified value to the countSuggestedBindings field of the specified struct.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrInteractionProfileSuggestedBinding	next(long value)	Sets the specified value to the next() field.
XrInteractionProfileSuggestedBinding	next(XrBindingModificationsKHR value)	Prepends the specified XrBindingModificationsKHR value to the next chain.
static long	ninteractionProfile(long struct)	Unsafe version of interactionProfile().
static void	ninteractionProfile(long struct, long value)	Unsafe version of interactionProfile.
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static XrActionSuggestedBinding.Buffer	nsuggestedBindings(long struct)	Unsafe version of suggestedBindings().
static void	nsuggestedBindings(long struct, XrActionSuggestedBinding.Buffer value)	Unsafe version of suggestedBindings.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
XrInteractionProfileSuggestedBinding	set(int type, long next, long interactionProfile, XrActionSuggestedBinding.Buffer suggestedBindings)	Initializes this struct with the specified values.
XrInteractionProfileSuggestedBinding	set(XrInteractionProfileSuggestedBinding src)	Copies the specified struct data to this struct.
int	sizeof()
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.
XrInteractionProfileSuggestedBinding	suggestedBindings(XrActionSuggestedBinding.Buffer value)	Sets the address of the specified XrActionSuggestedBinding.Buffer to the suggestedBindings() field.
int	type()	the XrStructureType of this structure.
XrInteractionProfileSuggestedBinding	type(int value)	Sets the specified value to the type() field.
XrInteractionProfileSuggestedBinding	type$Default()	Sets the TYPE_INTERACTION_PROFILE_SUGGESTED_BINDING value to the type() field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

TYPE

public static final int TYPE

The struct member offsets.

NEXT

public static final int NEXT

The struct member offsets.

INTERACTIONPROFILE

public static final int INTERACTIONPROFILE

The struct member offsets.

COUNTSUGGESTEDBINDINGS

public static final int COUNTSUGGESTEDBINDINGS

The struct member offsets.

SUGGESTEDBINDINGS

public static final int SUGGESTEDBINDINGS

The struct member offsets.

Constructor Details

XrInteractionProfileSuggestedBinding

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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<XrInteractionProfileSuggestedBinding>

type

public int type()

the XrStructureType of this structure.

next

public long next()

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

interactionProfile

public long interactionProfile()

the XrPath of an interaction profile.

countSuggestedBindings

public int countSuggestedBindings()

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

suggestedBindings

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.

type

public XrInteractionProfileSuggestedBinding type(int value)

Sets the specified value to the type() field.

type$Default

public XrInteractionProfileSuggestedBinding type$Default()

Sets the TYPE_INTERACTION_PROFILE_SUGGESTED_BINDING value to the type() field.

next

public XrInteractionProfileSuggestedBinding next(long value)

Sets the specified value to the next() field.

next

public XrInteractionProfileSuggestedBinding next(XrBindingModificationsKHR value)

Prepends the specified XrBindingModificationsKHR value to the next chain.

interactionProfile

public XrInteractionProfileSuggestedBinding interactionProfile(long value)

Sets the specified value to the interactionProfile() field.

suggestedBindings

public XrInteractionProfileSuggestedBinding suggestedBindings(XrActionSuggestedBinding.Buffer value)

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

set

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

Initializes this struct with the specified values.

set

public XrInteractionProfileSuggestedBinding set(XrInteractionProfileSuggestedBinding src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrInteractionProfileSuggestedBinding malloc()

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

calloc

public static XrInteractionProfileSuggestedBinding calloc()

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

create

public static XrInteractionProfileSuggestedBinding create()

Returns a new XrInteractionProfileSuggestedBinding instance allocated with BufferUtils.

create

public static XrInteractionProfileSuggestedBinding create(long address)

Returns a new XrInteractionProfileSuggestedBinding instance for the specified memory address.

createSafe

public static @Nullable XrInteractionProfileSuggestedBinding createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrInteractionProfileSuggestedBinding.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrInteractionProfileSuggestedBinding.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrInteractionProfileSuggestedBinding.Buffer create(int capacity)

Returns a new XrInteractionProfileSuggestedBinding.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrInteractionProfileSuggestedBinding.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static XrInteractionProfileSuggestedBinding malloc(org.lwjgl.system.MemoryStack stack)

Returns a new XrInteractionProfileSuggestedBinding instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static XrInteractionProfileSuggestedBinding calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static XrInteractionProfileSuggestedBinding.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static XrInteractionProfileSuggestedBinding.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

ntype

public static int ntype(long struct)

Unsafe version of type().

nnext

public static long nnext(long struct)

Unsafe version of next().

ninteractionProfile

public static long ninteractionProfile(long struct)

Unsafe version of interactionProfile().

ncountSuggestedBindings

public static int ncountSuggestedBindings(long struct)

Unsafe version of countSuggestedBindings().

nsuggestedBindings

public static XrActionSuggestedBinding.Buffer nsuggestedBindings(long struct)

Unsafe version of suggestedBindings().

ntype

public static void ntype(long struct,
 int value)

Unsafe version of type.

nnext

public static void nnext(long struct,
 long value)

Unsafe version of next.

ninteractionProfile

public static void ninteractionProfile(long struct,
 long value)

Unsafe version of interactionProfile.

ncountSuggestedBindings

public static void ncountSuggestedBindings(long struct,
 int value)

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

nsuggestedBindings

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

Unsafe version of suggestedBindings.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate