Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrSceneSphereBoundMSFT

extends Struct<XrSceneSphereBoundMSFT>
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 sphere bounds.
Description

The runtime must return ERROR_VALIDATION_FAILURE if radius is not a finite positive value.

Valid Usage (Implicit)
See Also

XrSceneBoundsMSFT, XrVector3f

Layout


struct XrSceneSphereBoundMSFT {
    XrVector3f center;
    float radius;
}

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
CENTER

The struct member offsets.

public static final int
RADIUS

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

public
XrSceneSphereBoundMSFT(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrSceneSphereBoundMSFT
calloc()

Returns a new XrSceneSphereBoundMSFT instance allocated with memCalloc.

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

Returns a new XrSceneSphereBoundMSFT.Buffer instance allocated with memCalloc.

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

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

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

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

public XrVector3f
center()

an XrVector3f representing the center of the sphere bound within the reference frame of the corresponding XrSceneBoundsMSFT::space.

public XrSceneSphereBoundMSFT
center(XrVector3f value)

Copies the specified XrVector3f to the center field.

public XrSceneSphereBoundMSFT
center(Consumer<XrVector3f> consumer)

Passes the center field to the specified Consumer.

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

Returns a new XrSceneSphereBoundMSFT instance allocated with BufferUtils.

public static XrSceneSphereBoundMSFT
create(long address)

Returns a new XrSceneSphereBoundMSFT instance for the specified memory address.

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

Returns a new XrSceneSphereBoundMSFT.Buffer instance allocated with BufferUtils.

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

Create a XrSceneSphereBoundMSFT.Buffer instance at the specified memory.

public static XrSceneSphereBoundMSFT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static XrSceneSphereBoundMSFT
malloc()

Returns a new XrSceneSphereBoundMSFT instance allocated with memAlloc.

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

Returns a new XrSceneSphereBoundMSFT.Buffer instance allocated with memAlloc.

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

Returns a new XrSceneSphereBoundMSFT instance allocated on the specified MemoryStack.

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

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

public static XrVector3f
ncenter(long struct)

Unsafe version of center.

public static void
ncenter(long struct, XrVector3f value)

Unsafe version of center.

public static float
nradius(long struct)

Unsafe version of radius.

public static void
nradius(long struct, float value)

Unsafe version of radius.

public float
radius()

the finite positive radius of the sphere bound.

public XrSceneSphereBoundMSFT
radius(float value)

Sets the specified value to the radius field.

public XrSceneSphereBoundMSFT
set(XrVector3f center, float radius)

Initializes this struct with the specified values.

public XrSceneSphereBoundMSFT

Returns:

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

CENTERback to summary
public static final int CENTER

The struct member offsets.

RADIUSback to summary
public static final int RADIUS

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

XrSceneSphereBoundMSFTback to summary
protected XrSceneSphereBoundMSFT(long address, ByteBuffer container)
XrSceneSphereBoundMSFTback to summary
public XrSceneSphereBoundMSFT(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrSceneSphereBoundMSFT calloc(MemoryStack stack)

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

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

centerback to summary
public XrVector3f center()

an XrVector3f representing the center of the sphere bound within the reference frame of the corresponding XrSceneBoundsMSFT::space.

centerback to summary
public XrSceneSphereBoundMSFT center(XrVector3f value)

Copies the specified XrVector3f to the center field.

centerback to summary
public XrSceneSphereBoundMSFT center(Consumer<XrVector3f> consumer)

Passes the center field to the specified Consumer.

createback to summary
protected XrSceneSphereBoundMSFT 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 XrSceneSphereBoundMSFT create()

Returns a new XrSceneSphereBoundMSFT instance allocated with BufferUtils.

createback to summary
public static XrSceneSphereBoundMSFT create(long address)

Returns a new XrSceneSphereBoundMSFT instance for the specified memory address.

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

Returns a new XrSceneSphereBoundMSFT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrSceneSphereBoundMSFT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrSceneSphereBoundMSFT createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrSceneSphereBoundMSFT malloc(MemoryStack stack)

Returns a new XrSceneSphereBoundMSFT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

ncenterback to summary
public static XrVector3f ncenter(long struct)

Unsafe version of center.

ncenterback to summary
public static void ncenter(long struct, XrVector3f value)

Unsafe version of center.

nradiusback to summary
public static float nradius(long struct)

Unsafe version of radius.

nradiusback to summary
public static void nradius(long struct, float value)

Unsafe version of radius.

radiusback to summary
public float radius()

the finite positive radius of the sphere bound.

radiusback to summary
public XrSceneSphereBoundMSFT radius(float value)

Sets the specified value to the radius field.

setback to summary
public XrSceneSphereBoundMSFT set(XrVector3f center, float radius)

Initializes this struct with the specified values.

setback to summary
public XrSceneSphereBoundMSFT set(XrSceneSphereBoundMSFT src)

Copies the specified struct data to this struct.

Parameters
src:XrSceneSphereBoundMSFT

the source struct

Returns:XrSceneSphereBoundMSFT

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

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

An array of XrSceneSphereBoundMSFT structs.

Field Summary

Modifier and TypeField and Description
private static final XrSceneSphereBoundMSFT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

Returns:

a XrVector3f view of the XrSceneSphereBoundMSFT#center field.
center
()

public XrSceneSphereBoundMSFT.Buffer
center(XrVector3f value)

Copies the specified XrVector3f to the XrSceneSphereBoundMSFT#center field.

public XrSceneSphereBoundMSFT.Buffer
center(Consumer<XrVector3f> consumer)

Passes the XrSceneSphereBoundMSFT#center field to the specified Consumer.

protected XrSceneSphereBoundMSFT
public float

Returns:

the value of the XrSceneSphereBoundMSFT#radius field.
radius
()

public XrSceneSphereBoundMSFT.Buffer
radius(float value)

Sets the specified value to the XrSceneSphereBoundMSFT#radius field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final XrSceneSphereBoundMSFT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

centerback to summary
public XrVector3f center()
Returns:XrVector3f

a XrVector3f view of the XrSceneSphereBoundMSFT#center field.

centerback to summary
public XrSceneSphereBoundMSFT.Buffer center(XrVector3f value)

Copies the specified XrVector3f to the XrSceneSphereBoundMSFT#center field.

centerback to summary
public XrSceneSphereBoundMSFT.Buffer center(Consumer<XrVector3f> consumer)

Passes the XrSceneSphereBoundMSFT#center field to the specified Consumer.

getElementFactoryback to summary
protected XrSceneSphereBoundMSFT getElementFactory()

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

Annotations
@Override
radiusback to summary
public float radius()
Returns:float

the value of the XrSceneSphereBoundMSFT#radius field.

radiusback to summary
public XrSceneSphereBoundMSFT.Buffer radius(float value)

Sets the specified value to the XrSceneSphereBoundMSFT#radius field.

selfback to summary
protected XrSceneSphereBoundMSFT.Buffer self()

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

Annotations
@Override