Represents a rectangular prism containing a region of space.

Description

This structure is used for component values that may be fractional (floating-point).

The bounding box is defined by an offset and extent. The offset refers to the coordinate of the minimum corner of the box in the local space of the XrSpace; that is, the corner whose coordinate has the minimum value on each axis. The extent refers to the dimensions of the box along each axis. The maximum corner can therefore be computed as offset extent.

Valid Usage (Implicit)

The XR_FB_scene extension must be enabled prior to using XrRect3DfFB

Layout


struct XrRect3DfFB {
    XrOffset3DfFB offset;
    XrExtent3DfFB extent;
}

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	XrRect3DfFB.Buffer An array of `XrRect3DfFB` structs.

Field Summary

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	EXTENT The struct member offsets.
public static final int	OFFSET The struct member offsets.
public static final int	SIZEOF The struct size in bytes.

Inherited from org.lwjgl.system.Struct:: container DEFAULT_ALIGN_AS DEFAULT_PACK_ALIGNMENT

Constructor Summary

Access	Constructor and Description
protected	XrRect3DfFB(long address, ByteBuffer container)
public	XrRect3DfFB(ByteBuffer container) Creates a `XrRect3DfFB` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public static XrRect3DfFB	calloc() Returns a new `XrRect3DfFB` instance allocated with `memCalloc`.
public static XrRect3DfFB.Buffer	calloc(int the buffer capacity capacity) Returns a new `XrRect3DfFB.Buffer` instance allocated with `memCalloc`.
public static XrRect3DfFB	calloc(MemoryStack the stack from which to allocate stack) Returns a new `XrRect3DfFB` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static XrRect3DfFB.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `XrRect3DfFB.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
protected XrRect3DfFB	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 XrRect3DfFB	create() Returns a new `XrRect3DfFB` instance allocated with `BufferUtils`.
public static XrRect3DfFB	create(long address) Returns a new `XrRect3DfFB` instance for the specified memory address.
public static XrRect3DfFB.Buffer	create(int the buffer capacity capacity) Returns a new `XrRect3DfFB.Buffer` instance allocated with `BufferUtils`.
public static XrRect3DfFB.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `XrRect3DfFB.Buffer` instance at the specified memory.
public static XrRect3DfFB	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static XrRect3DfFB.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public XrExtent3DfFB	extent() the `XrExtent3DfFB` specifying the rectangle extent.
public XrRect3DfFB	extent(XrExtent3DfFB value) Copies the specified `XrExtent3DfFB` to the `extent` field.
public XrRect3DfFB	extent(Consumer<XrExtent3DfFB> consumer) Passes the `extent` field to the specified `Consumer`.
public static XrRect3DfFB	malloc() Returns a new `XrRect3DfFB` instance allocated with `memAlloc`.
public static XrRect3DfFB.Buffer	malloc(int the buffer capacity capacity) Returns a new `XrRect3DfFB.Buffer` instance allocated with `memAlloc`.
public static XrRect3DfFB	malloc(MemoryStack the stack from which to allocate stack) Returns a new `XrRect3DfFB` instance allocated on the specified `MemoryStack`.
public static XrRect3DfFB.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `XrRect3DfFB.Buffer` instance allocated on the specified `MemoryStack`.
public static XrExtent3DfFB	nextent(long struct) Unsafe version of `extent`.
public static void	nextent(long struct, XrExtent3DfFB value) Unsafe version of `extent`.
public static XrOffset3DfFB	noffset(long struct) Unsafe version of `offset`.
public static void	noffset(long struct, XrOffset3DfFB value) Unsafe version of `offset`.
public XrOffset3DfFB	offset() the `XrOffset3DfFB` specifying the rectangle offset.
public XrRect3DfFB	offset(XrOffset3DfFB value) Copies the specified `XrOffset3DfFB` to the `offset` field.
public XrRect3DfFB	offset(Consumer<XrOffset3DfFB> consumer) Passes the `offset` field to the specified `Consumer`.
public XrRect3DfFB	set(XrOffset3DfFB offset, XrExtent3DfFB extent) Initializes this struct with the specified values.
public XrRect3DfFB	Returns: this struct set(XrRect3DfFB 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)`.

Field Detail

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

EXTENT	back to summary
public static final int EXTENT The struct member offsets.

OFFSET	back to summary
public static final int OFFSET The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

Constructor Detail

XrRect3DfFB	back to summary
protected XrRect3DfFB(long address, ByteBuffer container)

XrRect3DfFB back to summary

XrRect3DfFB	back to summary
public XrRect3DfFB(ByteBuffer container) Creates a `XrRect3DfFB` 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.

public XrRect3DfFB(ByteBuffer container)

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

calloc	back to summary
public static XrRect3DfFB calloc() Returns a new `XrRect3DfFB` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

calloc	back to summary
public static XrRect3DfFB.Buffer calloc(int capacity) Returns a new `XrRect3DfFB.Buffer` instance allocated with `memCalloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static XrRect3DfFB.Buffer calloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

calloc back to summary

calloc	back to summary
public static XrRect3DfFB calloc(MemoryStack stack) Returns a new `XrRect3DfFB` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static XrRect3DfFB calloc(MemoryStack stack)

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

Parameters

stack:MemoryStack: the stack from which to allocate

calloc back to summary

calloc	back to summary
public static XrRect3DfFB.Buffer calloc(int capacity, MemoryStack stack) Returns a new `XrRect3DfFB.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

public static XrRect3DfFB.Buffer calloc(int capacity, MemoryStack stack)

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

create back to summary

create	back to summary
protected XrRect3DfFB 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

protected XrRect3DfFB 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

create	back to summary
public static XrRect3DfFB create() Returns a new `XrRect3DfFB` instance allocated with `BufferUtils`.

create	back to summary
public static XrRect3DfFB create(long address) Returns a new `XrRect3DfFB` instance for the specified memory address.

create back to summary

create	back to summary
public static XrRect3DfFB.Buffer create(int capacity) Returns a new `XrRect3DfFB.Buffer` instance allocated with `BufferUtils`. Parameters capacity:int the buffer capacity

public static XrRect3DfFB.Buffer create(int capacity)

Returns a new XrRect3DfFB.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

create	back to summary
public static XrRect3DfFB.Buffer create(long address, int capacity) Create a `XrRect3DfFB.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

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

Create a XrRect3DfFB.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

createSafe back to summary

createSafe	back to summary
public static XrRect3DfFB createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static XrRect3DfFB createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static XrRect3DfFB.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

extent	back to summary
public XrExtent3DfFB extent() the `XrExtent3DfFB` specifying the rectangle extent.

extent	back to summary
public XrRect3DfFB extent(XrExtent3DfFB value) Copies the specified `XrExtent3DfFB` to the `extent` field.

extent	back to summary
public XrRect3DfFB extent(Consumer<XrExtent3DfFB> consumer) Passes the `extent` field to the specified `Consumer`.

malloc	back to summary
public static XrRect3DfFB malloc() Returns a new `XrRect3DfFB` instance allocated with `memAlloc`. The instance must be explicitly freed.

malloc back to summary

malloc	back to summary
public static XrRect3DfFB.Buffer malloc(int capacity) Returns a new `XrRect3DfFB.Buffer` instance allocated with `memAlloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static XrRect3DfFB.Buffer malloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

malloc back to summary

malloc	back to summary
public static XrRect3DfFB malloc(MemoryStack stack) Returns a new `XrRect3DfFB` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static XrRect3DfFB malloc(MemoryStack stack)

Returns a new XrRect3DfFB instance allocated on the specified MemoryStack.

Parameters

stack:MemoryStack: the stack from which to allocate

malloc back to summary

malloc	back to summary
public static XrRect3DfFB.Buffer malloc(int capacity, MemoryStack stack) Returns a new `XrRect3DfFB.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

public static XrRect3DfFB.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

nextent	back to summary
public static XrExtent3DfFB nextent(long struct) Unsafe version of `extent`.

nextent	back to summary
public static void nextent(long struct, XrExtent3DfFB value) Unsafe version of `extent`.

noffset	back to summary
public static XrOffset3DfFB noffset(long struct) Unsafe version of `offset`.

noffset	back to summary
public static void noffset(long struct, XrOffset3DfFB value) Unsafe version of `offset`.

offset	back to summary
public XrOffset3DfFB offset() the `XrOffset3DfFB` specifying the rectangle offset.

offset	back to summary
public XrRect3DfFB offset(XrOffset3DfFB value) Copies the specified `XrOffset3DfFB` to the `offset` field.

offset	back to summary
public XrRect3DfFB offset(Consumer<XrOffset3DfFB> consumer) Passes the `offset` field to the specified `Consumer`.

set	back to summary
public XrRect3DfFB set(XrOffset3DfFB offset, XrExtent3DfFB extent) Initializes this struct with the specified values.

set	back to summary
public XrRect3DfFB set(XrRect3DfFB src) Copies the specified struct data to this struct. Parameters src:XrRect3DfFB the source struct Returns:XrRect3DfFB this struct

set

back to summary

public XrRect3DfFB set(XrRect3DfFB src)

Copies the specified struct data to this struct.

Parameters

src:XrRect3DfFB: the source struct

Returns:XrRect3DfFB

this struct

sizeof back to summary

sizeof	back to summary
public int sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Doc from org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`. Annotations @Override

public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations

@Override

org.lwjgl.openxr back to summary

public Class XrRect3DfFB.Buffer

Class Inheritance

extends StructBuffer<XrRect3DfFB, XrRect3DfFB.Buffer>
implements NativeResource

All Implemented Interfaces

org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of XrRect3DfFB structs.

Field Summary

Modifier and Type	Field and Description
private static final XrRect3DfFB	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `XrRect3DfFB.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 Type	Method and Description
public XrExtent3DfFB	Returns: a `XrExtent3DfFB` view of the `XrRect3DfFB#extent` field. extent()
public XrRect3DfFB.Buffer	extent(XrExtent3DfFB value) Copies the specified `XrExtent3DfFB` to the `XrRect3DfFB#extent` field.
public XrRect3DfFB.Buffer	extent(Consumer<XrExtent3DfFB> consumer) Passes the `XrRect3DfFB#extent` field to the specified `Consumer`.
protected XrRect3DfFB	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public XrOffset3DfFB	Returns: a `XrOffset3DfFB` view of the `XrRect3DfFB#offset` field. offset()
public XrRect3DfFB.Buffer	offset(XrOffset3DfFB value) Copies the specified `XrOffset3DfFB` to the `XrRect3DfFB#offset` field.
public XrRect3DfFB.Buffer	offset(Consumer<XrOffset3DfFB> consumer) Passes the `XrRect3DfFB#offset` field to the specified `Consumer`.
protected XrRect3DfFB.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final XrRect3DfFB ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

Buffer	back to summary
public Buffer(ByteBuffer container) Creates a new `XrRect3DfFB.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 `XrRect3DfFB#SIZEOF`, and its mark will be undefined. The created buffer instance holds a strong reference to the container object.

public Buffer(ByteBuffer container)

Creates a new XrRect3DfFB.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 XrRect3DfFB#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Buffer	back to summary
public Buffer(long address, int cap)

Buffer	back to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

extent	back to summary
public XrExtent3DfFB extent() Returns:XrExtent3DfFB a `XrExtent3DfFB` view of the `XrRect3DfFB#extent` field.

extent	back to summary
public XrRect3DfFB.Buffer extent(XrExtent3DfFB value) Copies the specified `XrExtent3DfFB` to the `XrRect3DfFB#extent` field.

extent	back to summary
public XrRect3DfFB.Buffer extent(Consumer<XrExtent3DfFB> consumer) Passes the `XrRect3DfFB#extent` field to the specified `Consumer`.

getElementFactory	back to summary
protected XrRect3DfFB getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory. Annotations @Override

getElementFactory

back to summary

protected XrRect3DfFB getElementFactory()

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

Annotations

@Override

offset	back to summary
public XrOffset3DfFB offset() Returns:XrOffset3DfFB a `XrOffset3DfFB` view of the `XrRect3DfFB#offset` field.

offset	back to summary
public XrRect3DfFB.Buffer offset(XrOffset3DfFB value) Copies the specified `XrOffset3DfFB` to the `XrRect3DfFB#offset` field.

offset	back to summary
public XrRect3DfFB.Buffer offset(Consumer<XrOffset3DfFB> consumer) Passes the `XrRect3DfFB#offset` field to the specified `Consumer`.

self

back to summary

protected XrRect3DfFB.Buffer self()

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

Annotations

@Override

public Class XrRect3DfFB

Description

Valid Usage (Implicit)

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class XrRect3DfFB.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail