Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrSceneFrustumBoundMSFT

extends Struct<XrSceneFrustumBoundMSFT>
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 frustum bounds.
Description

The runtime must return ERROR_VALIDATION_FAILURE if farDistance is less than or equal to zero. The runtime must return ERROR_VALIDATION_FAILURE if the fov angles are not between between -π/2 and π/2 exclusively.

Valid Usage (Implicit)
See Also

XrFovf, XrPosef, XrSceneBoundsMSFT

Layout


struct XrSceneFrustumBoundMSFT {
    XrPosef pose;
    XrFovf fov;
    float farDistance;
}

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
FARDISTANCE

The struct member offsets.

public static final int
FOV

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
XrSceneFrustumBoundMSFT(long address, ByteBuffer container)

public
XrSceneFrustumBoundMSFT(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrSceneFrustumBoundMSFT
calloc()

Returns a new XrSceneFrustumBoundMSFT instance allocated with memCalloc.

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

Returns a new XrSceneFrustumBoundMSFT.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrSceneFrustumBoundMSFT instance allocated with BufferUtils.

public static XrSceneFrustumBoundMSFT
create(long address)

Returns a new XrSceneFrustumBoundMSFT instance for the specified memory address.

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

Returns a new XrSceneFrustumBoundMSFT.Buffer instance allocated with BufferUtils.

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

Create a XrSceneFrustumBoundMSFT.Buffer instance at the specified memory.

public static XrSceneFrustumBoundMSFT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public float
farDistance()

the positive distance of the far plane of the frustum bound along the -Z direction of the frustum bound space.

public XrSceneFrustumBoundMSFT
farDistance(float value)

Sets the specified value to the farDistance field.

public XrFovf
fov()

an XrFovf for the four sides of the frustum bound where angleLeft and angleRight are along the X axis and angleUp and angleDown are along the Y axis of the frustum bound space.

public XrSceneFrustumBoundMSFT
fov(XrFovf value)

Copies the specified XrFovf to the fov field.

public XrSceneFrustumBoundMSFT
fov(Consumer<XrFovf> consumer)

Passes the fov field to the specified Consumer.

public static XrSceneFrustumBoundMSFT
malloc()

Returns a new XrSceneFrustumBoundMSFT instance allocated with memAlloc.

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

Returns a new XrSceneFrustumBoundMSFT.Buffer instance allocated with memAlloc.

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

Returns a new XrSceneFrustumBoundMSFT instance allocated on the specified MemoryStack.

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

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

public static float
nfarDistance(long struct)

Unsafe version of farDistance.

public static void
nfarDistance(long struct, float value)

Unsafe version of farDistance.

public static XrFovf
nfov(long struct)

Unsafe version of fov.

public static void
nfov(long struct, XrFovf value)

Unsafe version of fov.

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 position and orientation of the tip of the frustum bound within the reference frame of the corresponding XrSceneBoundsMSFT::space.

public XrSceneFrustumBoundMSFT
pose(XrPosef value)

Copies the specified XrPosef to the pose field.

public XrSceneFrustumBoundMSFT
pose(Consumer<XrPosef> consumer)

Passes the pose field to the specified Consumer.

public XrSceneFrustumBoundMSFT
set(XrPosef pose, XrFovf fov, float farDistance)

Initializes this struct with the specified values.

public XrSceneFrustumBoundMSFT

Returns:

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

FARDISTANCEback to summary
public static final int FARDISTANCE

The struct member offsets.

FOVback to summary
public static final int FOV

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

XrSceneFrustumBoundMSFTback to summary
protected XrSceneFrustumBoundMSFT(long address, ByteBuffer container)
XrSceneFrustumBoundMSFTback to summary
public XrSceneFrustumBoundMSFT(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrSceneFrustumBoundMSFT calloc(MemoryStack stack)

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

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

Returns a new XrSceneFrustumBoundMSFT instance allocated with BufferUtils.

createback to summary
public static XrSceneFrustumBoundMSFT create(long address)

Returns a new XrSceneFrustumBoundMSFT instance for the specified memory address.

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

Returns a new XrSceneFrustumBoundMSFT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrSceneFrustumBoundMSFT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrSceneFrustumBoundMSFT createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
farDistanceback to summary
public float farDistance()

the positive distance of the far plane of the frustum bound along the -Z direction of the frustum bound space.

farDistanceback to summary
public XrSceneFrustumBoundMSFT farDistance(float value)

Sets the specified value to the farDistance field.

fovback to summary
public XrFovf fov()

an XrFovf for the four sides of the frustum bound where angleLeft and angleRight are along the X axis and angleUp and angleDown are along the Y axis of the frustum bound space.

fovback to summary
public XrSceneFrustumBoundMSFT fov(XrFovf value)

Copies the specified XrFovf to the fov field.

fovback to summary
public XrSceneFrustumBoundMSFT fov(Consumer<XrFovf> consumer)

Passes the fov field to the specified Consumer.

mallocback to summary
public static XrSceneFrustumBoundMSFT malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrSceneFrustumBoundMSFT malloc(MemoryStack stack)

Returns a new XrSceneFrustumBoundMSFT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nfarDistanceback to summary
public static float nfarDistance(long struct)

Unsafe version of farDistance.

nfarDistanceback to summary
public static void nfarDistance(long struct, float value)

Unsafe version of farDistance.

nfovback to summary
public static XrFovf nfov(long struct)

Unsafe version of fov.

nfovback to summary
public static void nfov(long struct, XrFovf value)

Unsafe version of fov.

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 position and orientation of the tip of the frustum bound within the reference frame of the corresponding XrSceneBoundsMSFT::space.

poseback to summary
public XrSceneFrustumBoundMSFT pose(XrPosef value)

Copies the specified XrPosef to the pose field.

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

Passes the pose field to the specified Consumer.

setback to summary
public XrSceneFrustumBoundMSFT set(XrPosef pose, XrFovf fov, float farDistance)

Initializes this struct with the specified values.

setback to summary
public XrSceneFrustumBoundMSFT set(XrSceneFrustumBoundMSFT src)

Copies the specified struct data to this struct.

Parameters
src:XrSceneFrustumBoundMSFT

the source struct

Returns:XrSceneFrustumBoundMSFT

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 XrSceneFrustumBoundMSFT.Buffer

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

An array of XrSceneFrustumBoundMSFT structs.

Field Summary

Modifier and TypeField and Description
private static final XrSceneFrustumBoundMSFT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrSceneFrustumBoundMSFT.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 float

Returns:

the value of the XrSceneFrustumBoundMSFT#farDistance field.
farDistance
()

public XrSceneFrustumBoundMSFT.Buffer
farDistance(float value)

Sets the specified value to the XrSceneFrustumBoundMSFT#farDistance field.

public XrFovf

Returns:

a XrFovf view of the XrSceneFrustumBoundMSFT#fov field.
fov
()

public XrSceneFrustumBoundMSFT.Buffer
fov(XrFovf value)

Copies the specified XrFovf to the XrSceneFrustumBoundMSFT#fov field.

public XrSceneFrustumBoundMSFT.Buffer
fov(Consumer<XrFovf> consumer)

Passes the XrSceneFrustumBoundMSFT#fov field to the specified Consumer.

protected XrSceneFrustumBoundMSFT
public XrPosef

Returns:

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

public XrSceneFrustumBoundMSFT.Buffer
pose(XrPosef value)

Copies the specified XrPosef to the XrSceneFrustumBoundMSFT#pose field.

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

Passes the XrSceneFrustumBoundMSFT#pose field to the specified Consumer.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final XrSceneFrustumBoundMSFT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

farDistanceback to summary
public float farDistance()
Returns:float

the value of the XrSceneFrustumBoundMSFT#farDistance field.

farDistanceback to summary
public XrSceneFrustumBoundMSFT.Buffer farDistance(float value)

Sets the specified value to the XrSceneFrustumBoundMSFT#farDistance field.

fovback to summary
public XrFovf fov()
Returns:XrFovf

a XrFovf view of the XrSceneFrustumBoundMSFT#fov field.

fovback to summary
public XrSceneFrustumBoundMSFT.Buffer fov(XrFovf value)

Copies the specified XrFovf to the XrSceneFrustumBoundMSFT#fov field.

fovback to summary
public XrSceneFrustumBoundMSFT.Buffer fov(Consumer<XrFovf> consumer)

Passes the XrSceneFrustumBoundMSFT#fov field to the specified Consumer.

getElementFactoryback to summary
protected XrSceneFrustumBoundMSFT getElementFactory()

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

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

a XrPosef view of the XrSceneFrustumBoundMSFT#pose field.

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

Copies the specified XrPosef to the XrSceneFrustumBoundMSFT#pose field.

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

Passes the XrSceneFrustumBoundMSFT#pose field to the specified Consumer.

selfback to summary
protected XrSceneFrustumBoundMSFT.Buffer self()

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

Annotations
@Override