Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrSpaceShareInfoFB

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

Describes a request to share some number of spatial entities.
Description

The XrSpaceShareInfoFB structure describes a request to share one or more spatial entities with one or more users.

Valid Usage (Implicit)
See Also

ShareSpacesFB

Layout


struct XrSpaceShareInfoFB {
    XrStructureType type;
    void const * next;
    uint32_t spaceCount;
    XrSpace * spaces;
    uint32_t userCount;
    XrSpaceUserFB * users;
}

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
NEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
SPACECOUNT

The struct member offsets.

public static final int
SPACES

The struct member offsets.

public static final int
TYPE

The struct member offsets.

public static final int
USERCOUNT

The struct member offsets.

public static final int
USERS

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
XrSpaceShareInfoFB(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrSpaceShareInfoFB
calloc()

Returns a new XrSpaceShareInfoFB instance allocated with memCalloc.

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

Returns a new XrSpaceShareInfoFB.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrSpaceShareInfoFB instance allocated with BufferUtils.

public static XrSpaceShareInfoFB
create(long address)

Returns a new XrSpaceShareInfoFB instance for the specified memory address.

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

Returns a new XrSpaceShareInfoFB.Buffer instance allocated with BufferUtils.

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

Create a XrSpaceShareInfoFB.Buffer instance at the specified memory.

public static XrSpaceShareInfoFB
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static XrSpaceShareInfoFB
malloc()

Returns a new XrSpaceShareInfoFB instance allocated with memAlloc.

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

Returns a new XrSpaceShareInfoFB.Buffer instance allocated with memAlloc.

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

Returns a new XrSpaceShareInfoFB instance allocated on the specified MemoryStack.

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

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

public long
next()

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

public XrSpaceShareInfoFB
next(long value)

Sets the specified value to the next field.

public static long
nnext(long struct)

Unsafe version of next.

public static void
nnext(long struct, long value)

Unsafe version of next.

public static int
nspaceCount(long struct)

Unsafe version of spaceCount.

public static void
nspaceCount(long struct, int value)

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

public static PointerBuffer
nspaces(long struct)

Unsafe version of spaces.

public static void
nspaces(long struct, PointerBuffer value)

Unsafe version of spaces.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public static int
nuserCount(long struct)

Unsafe version of userCount.

public static void
nuserCount(long struct, int value)

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

public static PointerBuffer
nusers(long struct)

Unsafe version of users.

public static void
nusers(long struct, PointerBuffer value)

Unsafe version of users.

public XrSpaceShareInfoFB
set(int type, long next, PointerBuffer spaces, PointerBuffer users)

Initializes this struct with the specified values.

public XrSpaceShareInfoFB

Returns:

this struct
set
(XrSpaceShareInfoFB
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 int

Returns:

the value of the spaceCount field.
spaceCount
()

public PointerBuffer

Returns:

a PointerBuffer view of the data pointed to by the spaces field.
spaces
()

public XrSpaceShareInfoFB
spaces(PointerBuffer value)

Sets the address of the specified PointerBuffer to the spaces field.

public int
type()

the XrStructureType of this structure.

public XrSpaceShareInfoFB
type(int value)

Sets the specified value to the type field.

public XrSpaceShareInfoFB
type$Default()

Sets the TYPE_SPACE_SHARE_INFO_FB value to the type field.

public int

Returns:

the value of the userCount field.
userCount
()

public PointerBuffer

Returns:

a PointerBuffer view of the data pointed to by the users field.
users
()

public XrSpaceShareInfoFB
users(PointerBuffer value)

Sets the address of the specified PointerBuffer to the users field.

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.

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.

SPACECOUNTback to summary
public static final int SPACECOUNT

The struct member offsets.

SPACESback to summary
public static final int SPACES

The struct member offsets.

TYPEback to summary
public static final int TYPE

The struct member offsets.

USERCOUNTback to summary
public static final int USERCOUNT

The struct member offsets.

USERSback to summary
public static final int USERS

The struct member offsets.

Constructor Detail

XrSpaceShareInfoFBback to summary
protected XrSpaceShareInfoFB(long address, ByteBuffer container)
XrSpaceShareInfoFBback to summary
public XrSpaceShareInfoFB(ByteBuffer container)

Creates a XrSpaceShareInfoFB 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 XrSpaceShareInfoFB calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrSpaceShareInfoFB calloc(MemoryStack stack)

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

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

Returns a new XrSpaceShareInfoFB instance allocated with BufferUtils.

createback to summary
public static XrSpaceShareInfoFB create(long address)

Returns a new XrSpaceShareInfoFB instance for the specified memory address.

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

Returns a new XrSpaceShareInfoFB.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrSpaceShareInfoFB.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrSpaceShareInfoFB createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrSpaceShareInfoFB malloc(MemoryStack stack)

Returns a new XrSpaceShareInfoFB instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

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 or this extension. spaceCount is the number of elements in the spaces list. spaces is a list containing all spatial entities to be shared. userCount is the number of elements in the users list. users is a list of the users with which the spaces will: be shared.

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

Sets the specified value to the next field.

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.

nspaceCountback to summary
public static int nspaceCount(long struct)

Unsafe version of spaceCount.

nspaceCountback to summary
public static void nspaceCount(long struct, int value)

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

nspacesback to summary
public static PointerBuffer nspaces(long struct)

Unsafe version of spaces.

nspacesback to summary
public static void nspaces(long struct, PointerBuffer value)

Unsafe version of spaces.

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.

nuserCountback to summary
public static int nuserCount(long struct)

Unsafe version of userCount.

nuserCountback to summary
public static void nuserCount(long struct, int value)

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

nusersback to summary
public static PointerBuffer nusers(long struct)

Unsafe version of users.

nusersback to summary
public static void nusers(long struct, PointerBuffer value)

Unsafe version of users.

setback to summary
public XrSpaceShareInfoFB set(int type, long next, PointerBuffer spaces, PointerBuffer users)

Initializes this struct with the specified values.

setback to summary
public XrSpaceShareInfoFB set(XrSpaceShareInfoFB src)

Copies the specified struct data to this struct.

Parameters
src:XrSpaceShareInfoFB

the source struct

Returns:XrSpaceShareInfoFB

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
spaceCountback to summary
public int spaceCount()
Returns:int

the value of the spaceCount field.

Annotations
@NativeType:uint32_t
spacesback to summary
public PointerBuffer spaces()
Returns:PointerBuffer

a PointerBuffer view of the data pointed to by the spaces field.

Annotations
@NativeType:XrSpace *
spacesback to summary
public XrSpaceShareInfoFB spaces(PointerBuffer value)

Sets the address of the specified PointerBuffer to the spaces field.

typeback to summary
public int type()

the XrStructureType of this structure.

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

Sets the specified value to the type field.

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

Sets the TYPE_SPACE_SHARE_INFO_FB value to the type field.

userCountback to summary
public int userCount()
Returns:int

the value of the userCount field.

Annotations
@NativeType:uint32_t
usersback to summary
public PointerBuffer users()
Returns:PointerBuffer

a PointerBuffer view of the data pointed to by the users field.

Annotations
@NativeType:XrSpaceUserFB *
usersback to summary
public XrSpaceShareInfoFB users(PointerBuffer value)

Sets the address of the specified PointerBuffer to the users 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 XrSpaceShareInfoFB.Buffer

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

An array of XrSpaceShareInfoFB structs.

Field Summary

Modifier and TypeField and Description
private static final XrSpaceShareInfoFB

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrSpaceShareInfoFB.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
protected XrSpaceShareInfoFB
public long

Returns:

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

public XrSpaceShareInfoFB.Buffer
next(long value)

Sets the specified value to the XrSpaceShareInfoFB#next field.

protected XrSpaceShareInfoFB.Buffer
public int

Returns:

the value of the spaceCount field.
spaceCount
()

public PointerBuffer

Returns:

a PointerBuffer view of the data pointed to by the spaces field.
spaces
()

public XrSpaceShareInfoFB.Buffer
spaces(PointerBuffer value)

Sets the address of the specified PointerBuffer to the spaces field.

public int

Returns:

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

public XrSpaceShareInfoFB.Buffer
type(int value)

Sets the specified value to the XrSpaceShareInfoFB#type field.

public XrSpaceShareInfoFB.Buffer
public int

Returns:

the value of the userCount field.
userCount
()

public PointerBuffer

Returns:

a PointerBuffer view of the data pointed to by the users field.
users
()

public XrSpaceShareInfoFB.Buffer
users(PointerBuffer value)

Sets the address of the specified PointerBuffer to the users field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XrSpaceShareInfoFB ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

getElementFactoryback to summary
protected XrSpaceShareInfoFB getElementFactory()

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

Annotations
@Override
nextback to summary
public long next()
Returns:long

the value of the XrSpaceShareInfoFB#next field.

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

Sets the specified value to the XrSpaceShareInfoFB#next field.

selfback to summary
protected XrSpaceShareInfoFB.Buffer self()

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

Annotations
@Override
spaceCountback to summary
public int spaceCount()
Returns:int

the value of the spaceCount field.

Annotations
@NativeType:uint32_t
spacesback to summary
public PointerBuffer spaces()
Returns:PointerBuffer

a PointerBuffer view of the data pointed to by the spaces field.

Annotations
@NativeType:XrSpace *
spacesback to summary
public XrSpaceShareInfoFB.Buffer spaces(PointerBuffer value)

Sets the address of the specified PointerBuffer to the spaces field.

typeback to summary
public int type()
Returns:int

the value of the XrSpaceShareInfoFB#type field.

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

Sets the specified value to the XrSpaceShareInfoFB#type field.

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

Sets the TYPE_SPACE_SHARE_INFO_FB value to the XrSpaceShareInfoFB#type field.

userCountback to summary
public int userCount()
Returns:int

the value of the userCount field.

Annotations
@NativeType:uint32_t
usersback to summary
public PointerBuffer users()
Returns:PointerBuffer

a PointerBuffer view of the data pointed to by the users field.

Annotations
@NativeType:XrSpaceUserFB *
usersback to summary
public XrSpaceShareInfoFB.Buffer users(PointerBuffer value)

Sets the address of the specified PointerBuffer to the users field.