Package org.lwjgl.openxr

Class XrShareSpacesRecipientGroupsMETA

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrShareSpacesRecipientGroupsMETA>

org.lwjgl.openxr.XrShareSpacesRecipientGroupsMETA

All Implemented Interfaces:

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

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

Information about the share spaces recipient.

Description

XrShareSpacesRecipientGroupsMETA implements the XrShareSpacesRecipientBaseHeaderMETA base type. Where ShareSpacesMETA specifies that a valid structure based on XrShareSpacesRecipientBaseHeaderMETA is to be passed, a valid XrShareSpacesRecipientGroupsMETA structure may be passed.

Valid Usage (Implicit)

• The XR_META_spatial_entity_group_sharing extension must be enabled prior to using XrShareSpacesRecipientGroupsMETA
• type must be TYPE_SHARE_SPACES_RECIPIENT_GROUPS_META
• next must be NULL or a valid pointer to the next structure in a structure chain
• groups must be a pointer to an array of groupCount XrUuid structures
• The groupCount parameter must be greater than 0

See Also

XrUuid

Layout

 struct XrShareSpacesRecipientGroupsMETA {
     XrStructureType type();
     void const * next();
     uint32_t groupCount();
     XrUuid * groups();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrShareSpacesRecipientGroupsMETA.Buffer	An array of XrShareSpacesRecipientGroupsMETA 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	GROUPCOUNT	The struct member offsets.
static final int	GROUPS	The struct member offsets.
static final int	NEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
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
XrShareSpacesRecipientGroupsMETA(ByteBuffer container)	Creates a XrShareSpacesRecipientGroupsMETA instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrShareSpacesRecipientGroupsMETA	calloc()	Returns a new XrShareSpacesRecipientGroupsMETA instance allocated with memCalloc.
static XrShareSpacesRecipientGroupsMETA.Buffer	calloc(int capacity)	Returns a new XrShareSpacesRecipientGroupsMETA.Buffer instance allocated with memCalloc.
static XrShareSpacesRecipientGroupsMETA.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrShareSpacesRecipientGroupsMETA.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrShareSpacesRecipientGroupsMETA	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrShareSpacesRecipientGroupsMETA instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrShareSpacesRecipientGroupsMETA	create()	Returns a new XrShareSpacesRecipientGroupsMETA instance allocated with BufferUtils.
static XrShareSpacesRecipientGroupsMETA.Buffer	create(int capacity)	Returns a new XrShareSpacesRecipientGroupsMETA.Buffer instance allocated with BufferUtils.
static XrShareSpacesRecipientGroupsMETA	create(long address)	Returns a new XrShareSpacesRecipientGroupsMETA instance for the specified memory address.
static XrShareSpacesRecipientGroupsMETA.Buffer	create(long address, int capacity)	Create a XrShareSpacesRecipientGroupsMETA.Buffer instance at the specified memory.
static XrShareSpacesRecipientGroupsMETA	create(XrShareSpacesRecipientBaseHeaderMETA value)	Downcasts the specified XrShareSpacesRecipientBaseHeaderMETA instance to XrShareSpacesRecipientGroupsMETA.
static XrShareSpacesRecipientGroupsMETA.Buffer	create(XrShareSpacesRecipientBaseHeaderMETA.Buffer value)	Downcasts the specified XrShareSpacesRecipientBaseHeaderMETA.Buffer instance to XrShareSpacesRecipientGroupsMETA.Buffer.
static @Nullable XrShareSpacesRecipientGroupsMETA	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrShareSpacesRecipientGroupsMETA.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	groupCount()	the number of elements in the groups list.
XrUuid.Buffer	groups()	a list of XrUuid defined by the application, which the spaces will be shared with.
XrShareSpacesRecipientGroupsMETA	groups(XrUuid.Buffer value)	Sets the address of the specified XrUuid.Buffer to the groups() field.
static XrShareSpacesRecipientGroupsMETA	malloc()	Returns a new XrShareSpacesRecipientGroupsMETA instance allocated with memAlloc.
static XrShareSpacesRecipientGroupsMETA.Buffer	malloc(int capacity)	Returns a new XrShareSpacesRecipientGroupsMETA.Buffer instance allocated with memAlloc.
static XrShareSpacesRecipientGroupsMETA.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrShareSpacesRecipientGroupsMETA.Buffer instance allocated on the specified MemoryStack.
static XrShareSpacesRecipientGroupsMETA	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrShareSpacesRecipientGroupsMETA instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrShareSpacesRecipientGroupsMETA	next(long value)	Sets the specified value to the next() field.
static int	ngroupCount(long struct)	Unsafe version of groupCount().
static void	ngroupCount(long struct, int value)	Sets the specified value to the groupCount field of the specified struct.
static XrUuid.Buffer	ngroups(long struct)	Unsafe version of groups().
static void	ngroups(long struct, XrUuid.Buffer value)	Unsafe version of groups.
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
XrShareSpacesRecipientGroupsMETA	set(int type, long next, XrUuid.Buffer groups)	Initializes this struct with the specified values.
XrShareSpacesRecipientGroupsMETA	set(XrShareSpacesRecipientGroupsMETA src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrShareSpacesRecipientGroupsMETA	type(int value)	Sets the specified value to the type() field.
XrShareSpacesRecipientGroupsMETA	type$Default()	Sets the TYPE_SHARE_SPACES_RECIPIENT_GROUPS_META 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.

GROUPCOUNT

public static final int GROUPCOUNT

The struct member offsets.

GROUPS

public static final int GROUPS

The struct member offsets.

Constructor Details

XrShareSpacesRecipientGroupsMETA

public XrShareSpacesRecipientGroupsMETA(ByteBuffer container)

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

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.

groupCount

public int groupCount()

the number of elements in the groups list. The maximum supported count in a single request is 16.

groups

public XrUuid.Buffer groups()

a list of XrUuid defined by the application, which the spaces will be shared with.

type

public XrShareSpacesRecipientGroupsMETA type(int value)

Sets the specified value to the type() field.

type$Default

public XrShareSpacesRecipientGroupsMETA type$Default()

Sets the TYPE_SHARE_SPACES_RECIPIENT_GROUPS_META value to the type() field.

next

public XrShareSpacesRecipientGroupsMETA next(long value)

Sets the specified value to the next() field.

groups

public XrShareSpacesRecipientGroupsMETA groups(XrUuid.Buffer value)

Sets the address of the specified XrUuid.Buffer to the groups() field.

set

public XrShareSpacesRecipientGroupsMETA set(int type,
 long next,
 XrUuid.Buffer groups)

Initializes this struct with the specified values.

set

public XrShareSpacesRecipientGroupsMETA set(XrShareSpacesRecipientGroupsMETA src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrShareSpacesRecipientGroupsMETA malloc()

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

calloc

public static XrShareSpacesRecipientGroupsMETA calloc()

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

create

public static XrShareSpacesRecipientGroupsMETA create()

Returns a new XrShareSpacesRecipientGroupsMETA instance allocated with BufferUtils.

create

public static XrShareSpacesRecipientGroupsMETA create(long address)

Returns a new XrShareSpacesRecipientGroupsMETA instance for the specified memory address.

createSafe

public static @Nullable XrShareSpacesRecipientGroupsMETA createSafe(long address)

Like create, but returns null if address is NULL.

create

public static XrShareSpacesRecipientGroupsMETA create(XrShareSpacesRecipientBaseHeaderMETA value)

Downcasts the specified XrShareSpacesRecipientBaseHeaderMETA instance to XrShareSpacesRecipientGroupsMETA.

malloc

public static XrShareSpacesRecipientGroupsMETA.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrShareSpacesRecipientGroupsMETA.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrShareSpacesRecipientGroupsMETA.Buffer create(int capacity)

Returns a new XrShareSpacesRecipientGroupsMETA.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrShareSpacesRecipientGroupsMETA.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

create

public static XrShareSpacesRecipientGroupsMETA.Buffer create(XrShareSpacesRecipientBaseHeaderMETA.Buffer value)

Downcasts the specified XrShareSpacesRecipientBaseHeaderMETA.Buffer instance to XrShareSpacesRecipientGroupsMETA.Buffer.

malloc

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

Returns a new XrShareSpacesRecipientGroupsMETA instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new XrShareSpacesRecipientGroupsMETA.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().

ngroupCount

public static int ngroupCount(long struct)

Unsafe version of groupCount().

ngroups

public static XrUuid.Buffer ngroups(long struct)

Unsafe version of groups().

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.

ngroupCount

public static void ngroupCount(long struct,
 int value)

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

ngroups

public static void ngroups(long struct,
 XrUuid.Buffer value)

Unsafe version of groups.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate