Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrBoundary2DFB

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

Provides additional context of a spatial entity representing a room.
Description

This structure is used by the GetSpaceBoundary2DFB function to provide the application with the XrVector2f vertices representing the a spatial entity with a boundary.

Valid Usage (Implicit)
See Also

XrVector2f, GetSpaceBoundary2DFB

Layout


struct XrBoundary2DFB {
    XrStructureType type;
    void const * next;
    uint32_t vertexCapacityInput;
    uint32_t vertexCountOutput;
    XrVector2f * vertices;
}

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
TYPE

The struct member offsets.

public static final int
VERTEXCAPACITYINPUT

The struct member offsets.

public static final int
VERTEXCOUNTOUTPUT

The struct member offsets.

public static final int
VERTICES

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
XrBoundary2DFB(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrBoundary2DFB
calloc()

Returns a new XrBoundary2DFB instance allocated with memCalloc.

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

Returns a new XrBoundary2DFB.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrBoundary2DFB instance allocated with BufferUtils.

public static XrBoundary2DFB
create(long address)

Returns a new XrBoundary2DFB instance for the specified memory address.

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

Returns a new XrBoundary2DFB.Buffer instance allocated with BufferUtils.

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

Create a XrBoundary2DFB.Buffer instance at the specified memory.

public static XrBoundary2DFB
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static XrBoundary2DFB
malloc()

Returns a new XrBoundary2DFB instance allocated with memAlloc.

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

Returns a new XrBoundary2DFB.Buffer instance allocated with memAlloc.

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

Returns a new XrBoundary2DFB instance allocated on the specified MemoryStack.

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

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

public long
next()

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

public XrBoundary2DFB
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
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public static int
nvertexCapacityInput(long struct)

Unsafe version of vertexCapacityInput.

public static void
nvertexCapacityInput(long struct, int value)

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

public static int
nvertexCountOutput(long struct)

Unsafe version of vertexCountOutput.

public static void
nvertexCountOutput(long struct, int value)

Unsafe version of vertexCountOutput.

public static XrVector2f.Buffer
nvertices(long struct)

Unsafe version of vertices.

public static void
nvertices(long struct, XrVector2f.Buffer value)

Unsafe version of vertices.

public XrBoundary2DFB
set(int type, long next, int vertexCapacityInput, int vertexCountOutput, XrVector2f.Buffer vertices)

Initializes this struct with the specified values.

public XrBoundary2DFB

Returns:

this struct
set
(XrBoundary2DFB
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
type()

the XrStructureType of this structure.

public XrBoundary2DFB
type(int value)

Sets the specified value to the type field.

public XrBoundary2DFB
type$Default()

Sets the TYPE_BOUNDARY_2D_FB value to the type field.

public int
vertexCapacityInput()

the capacity of the vertices array, in number of vertices, or 0 to indicate a request to retrieve the required capacity.

public XrBoundary2DFB
vertexCapacityInput(int value)

Sets the specified value to the vertexCapacityInput field.

public int
vertexCountOutput()

the count of XrVector2f written, or the required capacity in the case that vertexCapacityInput is insufficient.

public XrBoundary2DFB
vertexCountOutput(int value)

Sets the specified value to the vertexCountOutput field.

public XrVector2f.Buffer
vertices()

a pointer to an array of XrVector2f, but can be NULL if vertexCapacityInput is 0.

public XrBoundary2DFB
vertices(XrVector2f.Buffer value)

Sets the address of the specified XrVector2f.Buffer to the vertices field.

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.

TYPEback to summary
public static final int TYPE

The struct member offsets.

VERTEXCAPACITYINPUTback to summary
public static final int VERTEXCAPACITYINPUT

The struct member offsets.

VERTEXCOUNTOUTPUTback to summary
public static final int VERTEXCOUNTOUTPUT

The struct member offsets.

VERTICESback to summary
public static final int VERTICES

The struct member offsets.

Constructor Detail

XrBoundary2DFBback to summary
protected XrBoundary2DFB(long address, ByteBuffer container)
XrBoundary2DFBback to summary
public XrBoundary2DFB(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrBoundary2DFB calloc(MemoryStack stack)

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

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

Returns a new XrBoundary2DFB instance allocated with BufferUtils.

createback to summary
public static XrBoundary2DFB create(long address)

Returns a new XrBoundary2DFB instance for the specified memory address.

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

Returns a new XrBoundary2DFB.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrBoundary2DFB.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrBoundary2DFB createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrBoundary2DFB malloc(MemoryStack stack)

Returns a new XrBoundary2DFB instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Annotations
@NativeType:void const *
nextback to summary
public XrBoundary2DFB 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.

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.

nvertexCapacityInputback to summary
public static int nvertexCapacityInput(long struct)

Unsafe version of vertexCapacityInput.

nvertexCapacityInputback to summary
public static void nvertexCapacityInput(long struct, int value)

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

nvertexCountOutputback to summary
public static int nvertexCountOutput(long struct)

Unsafe version of vertexCountOutput.

nvertexCountOutputback to summary
public static void nvertexCountOutput(long struct, int value)

Unsafe version of vertexCountOutput.

nverticesback to summary
public static XrVector2f.Buffer nvertices(long struct)

Unsafe version of vertices.

Annotations
@Nullable
nverticesback to summary
public static void nvertices(long struct, XrVector2f.Buffer value)

Unsafe version of vertices.

setback to summary
public XrBoundary2DFB set(int type, long next, int vertexCapacityInput, int vertexCountOutput, XrVector2f.Buffer vertices)

Initializes this struct with the specified values.

setback to summary
public XrBoundary2DFB set(XrBoundary2DFB src)

Copies the specified struct data to this struct.

Parameters
src:XrBoundary2DFB

the source struct

Returns:XrBoundary2DFB

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
typeback to summary
public int type()

the XrStructureType of this structure.

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

Sets the specified value to the type field.

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

Sets the TYPE_BOUNDARY_2D_FB value to the type field.

vertexCapacityInputback to summary
public int vertexCapacityInput()

the capacity of the vertices array, in number of vertices, or 0 to indicate a request to retrieve the required capacity.

Annotations
@NativeType:uint32_t
vertexCapacityInputback to summary
public XrBoundary2DFB vertexCapacityInput(int value)

Sets the specified value to the vertexCapacityInput field.

vertexCountOutputback to summary
public int vertexCountOutput()

the count of XrVector2f written, or the required capacity in the case that vertexCapacityInput is insufficient.

Annotations
@NativeType:uint32_t
vertexCountOutputback to summary
public XrBoundary2DFB vertexCountOutput(int value)

Sets the specified value to the vertexCountOutput field.

verticesback to summary
public XrVector2f.Buffer vertices()

a pointer to an array of XrVector2f, but can be NULL if vertexCapacityInput is 0.

Annotations
@Nullable
@NativeType:XrVector2f *
verticesback to summary
public XrBoundary2DFB vertices(XrVector2f.Buffer value)

Sets the address of the specified XrVector2f.Buffer to the vertices field.

org.lwjgl.openxr back to summary

public Class XrBoundary2DFB.Buffer

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

An array of XrBoundary2DFB structs.

Field Summary

Modifier and TypeField and Description
private static final XrBoundary2DFB

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

Returns:

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

public XrBoundary2DFB.Buffer
next(long value)

Sets the specified value to the XrBoundary2DFB#next field.

protected XrBoundary2DFB.Buffer
public int

Returns:

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

public XrBoundary2DFB.Buffer
type(int value)

Sets the specified value to the XrBoundary2DFB#type field.

public XrBoundary2DFB.Buffer
public int

Returns:

the value of the XrBoundary2DFB#vertexCapacityInput field.
vertexCapacityInput
()

public XrBoundary2DFB.Buffer
vertexCapacityInput(int value)

Sets the specified value to the XrBoundary2DFB#vertexCapacityInput field.

public int

Returns:

the value of the XrBoundary2DFB#vertexCountOutput field.
vertexCountOutput
()

public XrBoundary2DFB.Buffer
vertexCountOutput(int value)

Sets the specified value to the XrBoundary2DFB#vertexCountOutput field.

public XrVector2f.Buffer

Returns:

a XrVector2f.Buffer view of the struct array pointed to by the XrBoundary2DFB#vertices field.
vertices
()

public XrBoundary2DFB.Buffer
vertices(XrVector2f.Buffer value)

Sets the address of the specified XrVector2f.Buffer to the XrBoundary2DFB#vertices field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XrBoundary2DFB ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new XrBoundary2DFB.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 XrBoundary2DFB#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 XrBoundary2DFB getElementFactory()

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

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

the value of the XrBoundary2DFB#next field.

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

Sets the specified value to the XrBoundary2DFB#next field.

selfback to summary
protected XrBoundary2DFB.Buffer self()

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

Annotations
@Override
typeback to summary
public int type()
Returns:int

the value of the XrBoundary2DFB#type field.

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

Sets the specified value to the XrBoundary2DFB#type field.

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

Sets the TYPE_BOUNDARY_2D_FB value to the XrBoundary2DFB#type field.

vertexCapacityInputback to summary
public int vertexCapacityInput()
Returns:int

the value of the XrBoundary2DFB#vertexCapacityInput field.

Annotations
@NativeType:uint32_t
vertexCapacityInputback to summary
public XrBoundary2DFB.Buffer vertexCapacityInput(int value)

Sets the specified value to the XrBoundary2DFB#vertexCapacityInput field.

vertexCountOutputback to summary
public int vertexCountOutput()
Returns:int

the value of the XrBoundary2DFB#vertexCountOutput field.

Annotations
@NativeType:uint32_t
vertexCountOutputback to summary
public XrBoundary2DFB.Buffer vertexCountOutput(int value)

Sets the specified value to the XrBoundary2DFB#vertexCountOutput field.

verticesback to summary
public XrVector2f.Buffer vertices()
Returns:XrVector2f.Buffer

a XrVector2f.Buffer view of the struct array pointed to by the XrBoundary2DFB#vertices field.

Annotations
@Nullable
@NativeType:XrVector2f *
verticesback to summary
public XrBoundary2DFB.Buffer vertices(XrVector2f.Buffer value)

Sets the address of the specified XrVector2f.Buffer to the XrBoundary2DFB#vertices field.