Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrSceneOrientedBoxBoundMSFT

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

Describe a scene oriented box bounds.
Description

The runtime must return ERROR_VALIDATION_FAILURE if any component of extents is not finite or less than or equal to zero.

Valid Usage (Implicit)
See Also

XrPosef, XrSceneBoundsMSFT, XrVector3f

Layout


struct XrSceneOrientedBoxBoundMSFT {
    XrPosef pose;
    XrVector3f extents;
}

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
EXTENTS

The struct member offsets.

public static final int
POSE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
XrSceneOrientedBoxBoundMSFT(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrSceneOrientedBoxBoundMSFT
calloc()

Returns a new XrSceneOrientedBoxBoundMSFT instance allocated with memCalloc.

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

Returns a new XrSceneOrientedBoxBoundMSFT.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrSceneOrientedBoxBoundMSFT instance allocated with BufferUtils.

public static XrSceneOrientedBoxBoundMSFT
create(long address)

Returns a new XrSceneOrientedBoxBoundMSFT instance for the specified memory address.

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

Returns a new XrSceneOrientedBoxBoundMSFT.Buffer instance allocated with BufferUtils.

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

Create a XrSceneOrientedBoxBoundMSFT.Buffer instance at the specified memory.

public static XrSceneOrientedBoxBoundMSFT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public XrVector3f
extents()

an XrVector3f defining the edge-to-edge length of the box along each dimension with pose as the center.

public XrSceneOrientedBoxBoundMSFT
extents(XrVector3f value)

Copies the specified XrVector3f to the extents field.

public XrSceneOrientedBoxBoundMSFT
extents(Consumer<XrVector3f> consumer)

Passes the extents field to the specified Consumer.

public static XrSceneOrientedBoxBoundMSFT
malloc()

Returns a new XrSceneOrientedBoxBoundMSFT instance allocated with memAlloc.

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

Returns a new XrSceneOrientedBoxBoundMSFT.Buffer instance allocated with memAlloc.

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

Returns a new XrSceneOrientedBoxBoundMSFT instance allocated on the specified MemoryStack.

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

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

public static XrVector3f
nextents(long struct)

Unsafe version of extents.

public static void
nextents(long struct, XrVector3f value)

Unsafe version of extents.

public static XrPosef
npose(long struct)

Unsafe version of pose.

public static void
npose(long struct, XrPosef value)

Unsafe version of pose.

public XrPosef
pose()

an XrPosef defining the center position and orientation of the oriented bounding box bound within the reference frame of the corresponding XrSceneBoundsMSFT::space.

public XrSceneOrientedBoxBoundMSFT
pose(XrPosef value)

Copies the specified XrPosef to the pose field.

public XrSceneOrientedBoxBoundMSFT
pose(Consumer<XrPosef> consumer)

Passes the pose field to the specified Consumer.

public XrSceneOrientedBoxBoundMSFT
set(XrPosef pose, XrVector3f extents)

Initializes this struct with the specified values.

public XrSceneOrientedBoxBoundMSFT

Returns:

this struct
set
(XrSceneOrientedBoxBoundMSFT
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).
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.

EXTENTSback to summary
public static final int EXTENTS

The struct member offsets.

POSEback to summary
public static final int POSE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

XrSceneOrientedBoxBoundMSFTback to summary
protected XrSceneOrientedBoxBoundMSFT(long address, ByteBuffer container)
XrSceneOrientedBoxBoundMSFTback to summary
public XrSceneOrientedBoxBoundMSFT(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrSceneOrientedBoxBoundMSFT calloc(MemoryStack stack)

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

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

Returns a new XrSceneOrientedBoxBoundMSFT instance allocated with BufferUtils.

createback to summary
public static XrSceneOrientedBoxBoundMSFT create(long address)

Returns a new XrSceneOrientedBoxBoundMSFT instance for the specified memory address.

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

Returns a new XrSceneOrientedBoxBoundMSFT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrSceneOrientedBoxBoundMSFT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrSceneOrientedBoxBoundMSFT createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
extentsback to summary
public XrVector3f extents()

an XrVector3f defining the edge-to-edge length of the box along each dimension with pose as the center.

extentsback to summary
public XrSceneOrientedBoxBoundMSFT extents(XrVector3f value)

Copies the specified XrVector3f to the extents field.

extentsback to summary
public XrSceneOrientedBoxBoundMSFT extents(Consumer<XrVector3f> consumer)

Passes the extents field to the specified Consumer.

mallocback to summary
public static XrSceneOrientedBoxBoundMSFT malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrSceneOrientedBoxBoundMSFT malloc(MemoryStack stack)

Returns a new XrSceneOrientedBoxBoundMSFT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nextentsback to summary
public static XrVector3f nextents(long struct)

Unsafe version of extents.

nextentsback to summary
public static void nextents(long struct, XrVector3f value)

Unsafe version of extents.

nposeback to summary
public static XrPosef npose(long struct)

Unsafe version of pose.

nposeback to summary
public static void npose(long struct, XrPosef value)

Unsafe version of pose.

poseback to summary
public XrPosef pose()

an XrPosef defining the center position and orientation of the oriented bounding box bound within the reference frame of the corresponding XrSceneBoundsMSFT::space.

poseback to summary
public XrSceneOrientedBoxBoundMSFT pose(XrPosef value)

Copies the specified XrPosef to the pose field.

poseback to summary
public XrSceneOrientedBoxBoundMSFT pose(Consumer<XrPosef> consumer)

Passes the pose field to the specified Consumer.

setback to summary
public XrSceneOrientedBoxBoundMSFT set(XrPosef pose, XrVector3f extents)

Initializes this struct with the specified values.

setback to summary
public XrSceneOrientedBoxBoundMSFT set(XrSceneOrientedBoxBoundMSFT src)

Copies the specified struct data to this struct.

Parameters
src:XrSceneOrientedBoxBoundMSFT

the source struct

Returns:XrSceneOrientedBoxBoundMSFT

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
org.lwjgl.openxr back to summary

public Class XrSceneOrientedBoxBoundMSFT.Buffer

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

An array of XrSceneOrientedBoxBoundMSFT structs.

Field Summary

Modifier and TypeField and Description
private static final XrSceneOrientedBoxBoundMSFT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrSceneOrientedBoxBoundMSFT.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
public XrVector3f
public XrSceneOrientedBoxBoundMSFT.Buffer
extents(XrVector3f value)

Copies the specified XrVector3f to the XrSceneOrientedBoxBoundMSFT#extents field.

public XrSceneOrientedBoxBoundMSFT.Buffer
extents(Consumer<XrVector3f> consumer)

Passes the XrSceneOrientedBoxBoundMSFT#extents field to the specified Consumer.

protected XrSceneOrientedBoxBoundMSFT
public XrPosef

Returns:

a XrPosef view of the XrSceneOrientedBoxBoundMSFT#pose field.
pose
()

public XrSceneOrientedBoxBoundMSFT.Buffer
pose(XrPosef value)

Copies the specified XrPosef to the XrSceneOrientedBoxBoundMSFT#pose field.

public XrSceneOrientedBoxBoundMSFT.Buffer
pose(Consumer<XrPosef> consumer)

Passes the XrSceneOrientedBoxBoundMSFT#pose field to the specified Consumer.

protected XrSceneOrientedBoxBoundMSFT.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XrSceneOrientedBoxBoundMSFT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

extentsback to summary
public XrVector3f extents()
Returns:XrVector3f

a XrVector3f view of the XrSceneOrientedBoxBoundMSFT#extents field.

extentsback to summary
public XrSceneOrientedBoxBoundMSFT.Buffer extents(XrVector3f value)

Copies the specified XrVector3f to the XrSceneOrientedBoxBoundMSFT#extents field.

extentsback to summary
public XrSceneOrientedBoxBoundMSFT.Buffer extents(Consumer<XrVector3f> consumer)

Passes the XrSceneOrientedBoxBoundMSFT#extents field to the specified Consumer.

getElementFactoryback to summary
protected XrSceneOrientedBoxBoundMSFT getElementFactory()

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

Annotations
@Override
poseback to summary
public XrPosef pose()
Returns:XrPosef

a XrPosef view of the XrSceneOrientedBoxBoundMSFT#pose field.

poseback to summary
public XrSceneOrientedBoxBoundMSFT.Buffer pose(XrPosef value)

Copies the specified XrPosef to the XrSceneOrientedBoxBoundMSFT#pose field.

poseback to summary
public XrSceneOrientedBoxBoundMSFT.Buffer pose(Consumer<XrPosef> consumer)

Passes the XrSceneOrientedBoxBoundMSFT#pose field to the specified Consumer.

selfback to summary
protected XrSceneOrientedBoxBoundMSFT.Buffer self()

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

Annotations
@Override