Package org.lwjgl.openxr
Class XrSceneFrustumBoundMSFT
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.openxr.XrSceneFrustumBoundMSFT
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class XrSceneFrustumBoundMSFT extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceDescribe a scene frustum bounds.Description
The runtime must return
ERROR_VALIDATION_FAILUREiffarDistanceis less than or equal to zero. The runtime must returnERROR_VALIDATION_FAILUREif thefovangles are not between between-π/2andπ/2exclusively.Valid Usage (Implicit)
- The
XR_MSFT_scene_understandingextension must be enabled prior to usingXrSceneFrustumBoundMSFT
See Also
XrFovf,XrPosef,XrSceneBoundsMSFTLayout
struct XrSceneFrustumBoundMSFT {XrPosefpose();XrFovffov(); floatfarDistance(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classXrSceneFrustumBoundMSFT.BufferAn array ofXrSceneFrustumBoundMSFTstructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intFARDISTANCE
FOV
POSEThe struct member offsets.static intSIZEOFThe struct size in bytes.
-
Constructor Summary
Constructors Constructor Description XrSceneFrustumBoundMSFT(java.nio.ByteBuffer container)Creates aXrSceneFrustumBoundMSFTinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static XrSceneFrustumBoundMSFTcalloc()Returns a newXrSceneFrustumBoundMSFTinstance allocated withmemCalloc.static XrSceneFrustumBoundMSFT.Buffercalloc(int capacity)Returns a newXrSceneFrustumBoundMSFT.Bufferinstance allocated withmemCalloc.static XrSceneFrustumBoundMSFT.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newXrSceneFrustumBoundMSFT.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static XrSceneFrustumBoundMSFTcalloc(org.lwjgl.system.MemoryStack stack)Returns a newXrSceneFrustumBoundMSFTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static XrSceneFrustumBoundMSFTcreate()Returns a newXrSceneFrustumBoundMSFTinstance allocated withBufferUtils.static XrSceneFrustumBoundMSFT.Buffercreate(int capacity)Returns a newXrSceneFrustumBoundMSFT.Bufferinstance allocated withBufferUtils.static XrSceneFrustumBoundMSFTcreate(long address)Returns a newXrSceneFrustumBoundMSFTinstance for the specified memory address.static XrSceneFrustumBoundMSFT.Buffercreate(long address, int capacity)Create aXrSceneFrustumBoundMSFT.Bufferinstance at the specified memory.static XrSceneFrustumBoundMSFTcreateSafe(long address)static XrSceneFrustumBoundMSFT.BuffercreateSafe(long address, int capacity)floatfarDistance()the positive distance of the far plane of the frustum bound along the -Z direction of the frustum bound space.XrSceneFrustumBoundMSFTfarDistance(float value)Sets the specified value to thefarDistance()field.XrFovffov()anXrFovffor the four sides of the frustum bound whereangleLeftandangleRightare along the X axis andangleUpandangleDownare along the Y axis of the frustum bound space.XrSceneFrustumBoundMSFTfov(java.util.function.Consumer<XrFovf> consumer)Passes thefov()field to the specifiedConsumer.XrSceneFrustumBoundMSFTfov(XrFovf value)static XrSceneFrustumBoundMSFTmalloc()Returns a newXrSceneFrustumBoundMSFTinstance allocated withmemAlloc.static XrSceneFrustumBoundMSFT.Buffermalloc(int capacity)Returns a newXrSceneFrustumBoundMSFT.Bufferinstance allocated withmemAlloc.static XrSceneFrustumBoundMSFT.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newXrSceneFrustumBoundMSFT.Bufferinstance allocated on the specifiedMemoryStack.static XrSceneFrustumBoundMSFTmalloc(org.lwjgl.system.MemoryStack stack)Returns a newXrSceneFrustumBoundMSFTinstance allocated on the specifiedMemoryStack.static floatnfarDistance(long struct)Unsafe version offarDistance().static voidnfarDistance(long struct, float value)Unsafe version offarDistance.static XrFovfnfov(long struct)Unsafe version offov().static voidnfov(long struct, XrFovf value)Unsafe version offov.static XrPosefnpose(long struct)Unsafe version ofpose().static voidnpose(long struct, XrPosef value)Unsafe version ofpose.XrPosefpose()anXrPosefdefining the position and orientation of the tip of the frustum bound within the reference frame of the correspondingXrSceneBoundsMSFT::space.XrSceneFrustumBoundMSFTpose(java.util.function.Consumer<XrPosef> consumer)Passes thepose()field to the specifiedConsumer.XrSceneFrustumBoundMSFTpose(XrPosef value)XrSceneFrustumBoundMSFTset(XrPosef pose, XrFovf fov, float farDistance)Initializes this struct with the specified values.XrSceneFrustumBoundMSFTset(XrSceneFrustumBoundMSFT src)Copies the specified struct data to this struct.intsizeof()
-
-
-
Constructor Detail
-
XrSceneFrustumBoundMSFT
public XrSceneFrustumBoundMSFT(java.nio.ByteBuffer container)
Creates aXrSceneFrustumBoundMSFTinstance at the current position of the specifiedByteBuffercontainer. 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
-
sizeof
public int sizeof()
- Specified by:
sizeofin classorg.lwjgl.system.Struct
-
pose
public XrPosef pose()
anXrPosefdefining the position and orientation of the tip of the frustum bound within the reference frame of the correspondingXrSceneBoundsMSFT::space.
-
fov
public XrFovf fov()
anXrFovffor the four sides of the frustum bound whereangleLeftandangleRightare along the X axis andangleUpandangleDownare along the Y axis of the frustum bound space.
-
farDistance
public float farDistance()
the positive distance of the far plane of the frustum bound along the -Z direction of the frustum bound space.
-
pose
public XrSceneFrustumBoundMSFT pose(XrPosef value)
-
pose
public XrSceneFrustumBoundMSFT pose(java.util.function.Consumer<XrPosef> consumer)
Passes thepose()field to the specifiedConsumer.
-
fov
public XrSceneFrustumBoundMSFT fov(XrFovf value)
-
fov
public XrSceneFrustumBoundMSFT fov(java.util.function.Consumer<XrFovf> consumer)
Passes thefov()field to the specifiedConsumer.
-
farDistance
public XrSceneFrustumBoundMSFT farDistance(float value)
Sets the specified value to thefarDistance()field.
-
set
public XrSceneFrustumBoundMSFT set(XrPosef pose, XrFovf fov, float farDistance)
Initializes this struct with the specified values.
-
set
public XrSceneFrustumBoundMSFT set(XrSceneFrustumBoundMSFT src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static XrSceneFrustumBoundMSFT malloc()
Returns a newXrSceneFrustumBoundMSFTinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static XrSceneFrustumBoundMSFT calloc()
Returns a newXrSceneFrustumBoundMSFTinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static XrSceneFrustumBoundMSFT create()
Returns a newXrSceneFrustumBoundMSFTinstance allocated withBufferUtils.
-
create
public static XrSceneFrustumBoundMSFT create(long address)
Returns a newXrSceneFrustumBoundMSFTinstance for the specified memory address.
-
createSafe
@Nullable public static XrSceneFrustumBoundMSFT createSafe(long address)
-
malloc
public static XrSceneFrustumBoundMSFT.Buffer malloc(int capacity)
Returns a newXrSceneFrustumBoundMSFT.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static XrSceneFrustumBoundMSFT.Buffer calloc(int capacity)
Returns a newXrSceneFrustumBoundMSFT.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static XrSceneFrustumBoundMSFT.Buffer create(int capacity)
Returns a newXrSceneFrustumBoundMSFT.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static XrSceneFrustumBoundMSFT.Buffer create(long address, int capacity)
Create aXrSceneFrustumBoundMSFT.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static XrSceneFrustumBoundMSFT.Buffer createSafe(long address, int capacity)
-
malloc
public static XrSceneFrustumBoundMSFT malloc(org.lwjgl.system.MemoryStack stack)
Returns a newXrSceneFrustumBoundMSFTinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static XrSceneFrustumBoundMSFT calloc(org.lwjgl.system.MemoryStack stack)
Returns a newXrSceneFrustumBoundMSFTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static XrSceneFrustumBoundMSFT.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newXrSceneFrustumBoundMSFT.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static XrSceneFrustumBoundMSFT.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newXrSceneFrustumBoundMSFT.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
nfarDistance
public static float nfarDistance(long struct)
Unsafe version offarDistance().
-
nfarDistance
public static void nfarDistance(long struct, float value)Unsafe version offarDistance.
-
-