Package org.lwjgl.openxr
Class XrCompositionLayerCubeKHR
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.openxr.XrCompositionLayerCubeKHR
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class XrCompositionLayerCubeKHR extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceCube map layer composition info.Description
XrCompositionLayerCubeKHRcontains the information needed to render a cube map when callingEndFrame.XrCompositionLayerCubeKHRis an alias type for the base structXrCompositionLayerBaseHeaderused inXrFrameEndInfo.Valid Usage (Implicit)
- The
XR_KHR_composition_layer_cubeextension must be enabled prior to usingXrCompositionLayerCubeKHR typemust beTYPE_COMPOSITION_LAYER_CUBE_KHRnextmust beNULLor a valid pointer to the next structure in a structure chainlayerFlagsmust be 0 or a valid combination ofXrCompositionLayerFlagBitsvaluesspacemust be a validXrSpacehandleeyeVisibilitymust be a validXrEyeVisibilityvalueswapchainmust be a validXrSwapchainhandle- Both of
spaceandswapchainmust have been created, allocated, or retrieved from the sameXrSession
See Also
XrCompositionLayerBaseHeader,XrFrameEndInfo,XrQuaternionf,EndFrameLayout
struct XrCompositionLayerCubeKHR { XrStructureTypetype(); void const *next(); XrCompositionLayerFlagslayerFlags(); XrSpacespace(); XrEyeVisibility eyeVisibility; XrSwapchainswapchain(); uint32_timageArrayIndex();XrQuaternionforientation(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classXrCompositionLayerCubeKHR.BufferAn array ofXrCompositionLayerCubeKHRstructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intEYEVISIBILITY
IMAGEARRAYINDEX
LAYERFLAGS
NEXT
ORIENTATIONThe struct member offsets.static intSIZEOFThe struct size in bytes.static intSPACE
SWAPCHAIN
TYPEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description XrCompositionLayerCubeKHR(java.nio.ByteBuffer container)Creates aXrCompositionLayerCubeKHRinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static XrCompositionLayerCubeKHRcalloc()Returns a newXrCompositionLayerCubeKHRinstance allocated withmemCalloc.static XrCompositionLayerCubeKHR.Buffercalloc(int capacity)Returns a newXrCompositionLayerCubeKHR.Bufferinstance allocated withmemCalloc.static XrCompositionLayerCubeKHR.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newXrCompositionLayerCubeKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static XrCompositionLayerCubeKHRcalloc(org.lwjgl.system.MemoryStack stack)Returns a newXrCompositionLayerCubeKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static XrCompositionLayerCubeKHRcreate()Returns a newXrCompositionLayerCubeKHRinstance allocated withBufferUtils.static XrCompositionLayerCubeKHR.Buffercreate(int capacity)Returns a newXrCompositionLayerCubeKHR.Bufferinstance allocated withBufferUtils.static XrCompositionLayerCubeKHRcreate(long address)Returns a newXrCompositionLayerCubeKHRinstance for the specified memory address.static XrCompositionLayerCubeKHR.Buffercreate(long address, int capacity)Create aXrCompositionLayerCubeKHR.Bufferinstance at the specified memory.static XrCompositionLayerCubeKHRcreate(XrCompositionLayerBaseHeader value)Downcasts the specifiedXrCompositionLayerBaseHeaderinstance toXrCompositionLayerCubeKHR.static XrCompositionLayerCubeKHR.Buffercreate(XrCompositionLayerBaseHeader.Buffer value)Downcasts the specifiedXrCompositionLayerBaseHeader.Bufferinstance toXrCompositionLayerCubeKHR.Buffer.static XrCompositionLayerCubeKHRcreateSafe(long address)static XrCompositionLayerCubeKHR.BuffercreateSafe(long address, int capacity)inteyeVisibility()XrCompositionLayerCubeKHReyeVisibility(int value)Sets the specified value to theeyeVisibilityfield.intimageArrayIndex()the image array index, with 0 meaning the first or only array element.XrCompositionLayerCubeKHRimageArrayIndex(int value)Sets the specified value to theimageArrayIndex()field.longlayerFlags()any flags to apply to this layer.XrCompositionLayerCubeKHRlayerFlags(long value)Sets the specified value to thelayerFlags()field.static XrCompositionLayerCubeKHRmalloc()Returns a newXrCompositionLayerCubeKHRinstance allocated withmemAlloc.static XrCompositionLayerCubeKHR.Buffermalloc(int capacity)Returns a newXrCompositionLayerCubeKHR.Bufferinstance allocated withmemAlloc.static XrCompositionLayerCubeKHR.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newXrCompositionLayerCubeKHR.Bufferinstance allocated on the specifiedMemoryStack.static XrCompositionLayerCubeKHRmalloc(org.lwjgl.system.MemoryStack stack)Returns a newXrCompositionLayerCubeKHRinstance allocated on the specifiedMemoryStack.longnext()NULLor a pointer to the next structure in a structure chain.XrCompositionLayerCubeKHRnext(long value)Sets the specified value to thenext()field.static intneyeVisibility(long struct)Unsafe version ofeyeVisibility().static voidneyeVisibility(long struct, int value)Unsafe version ofeyeVisibility.static intnimageArrayIndex(long struct)Unsafe version ofimageArrayIndex().static voidnimageArrayIndex(long struct, int value)Unsafe version ofimageArrayIndex.static longnlayerFlags(long struct)Unsafe version oflayerFlags().static voidnlayerFlags(long struct, long value)Unsafe version oflayerFlags.static longnnext(long struct)Unsafe version ofnext().static voidnnext(long struct, long value)Unsafe version ofnext.static XrQuaternionfnorientation(long struct)Unsafe version oforientation().static voidnorientation(long struct, XrQuaternionf value)Unsafe version oforientation.static longnspace(long struct)Unsafe version ofspace().static voidnspace(long struct, XrSpace value)Unsafe version ofspace.static longnswapchain(long struct)Unsafe version ofswapchain().static voidnswapchain(long struct, XrSwapchain value)Unsafe version ofswapchain.static intntype(long struct)Unsafe version oftype().static voidntype(long struct, int value)Unsafe version oftype.XrQuaternionforientation()the orientation of the environment map in thespace.XrCompositionLayerCubeKHRorientation(java.util.function.Consumer<XrQuaternionf> consumer)Passes theorientation()field to the specifiedConsumer.XrCompositionLayerCubeKHRorientation(XrQuaternionf value)Copies the specifiedXrQuaternionfto theorientation()field.XrCompositionLayerCubeKHRset(int type, long next, long layerFlags, XrSpace space, int eyeVisibility, XrSwapchain swapchain, int imageArrayIndex, XrQuaternionf orientation)Initializes this struct with the specified values.XrCompositionLayerCubeKHRset(XrCompositionLayerCubeKHR src)Copies the specified struct data to this struct.intsizeof()longspace()theXrSpacein which theorientationof the cube layer is evaluated over time.XrCompositionLayerCubeKHRspace(XrSpace value)Sets the specified value to thespace()field.longswapchain()the swapchain.XrCompositionLayerCubeKHRswapchain(XrSwapchain value)Sets the specified value to theswapchain()field.inttype()theXrStructureTypeof this structure.XrCompositionLayerCubeKHRtype(int value)Sets the specified value to thetype()field.XrCompositionLayerCubeKHRtype$Default()Sets theTYPE_COMPOSITION_LAYER_CUBE_KHRvalue to thetype()field.static voidvalidate(long struct)Validates pointer members that should not beNULL.
-
-
-
Constructor Detail
-
XrCompositionLayerCubeKHR
public XrCompositionLayerCubeKHR(java.nio.ByteBuffer container)
Creates aXrCompositionLayerCubeKHRinstance 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
-
type
public int type()
theXrStructureTypeof this structure.
-
next
public long next()
NULLor a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR or this extension.
-
layerFlags
public long layerFlags()
any flags to apply to this layer.
-
space
public long space()
theXrSpacein which theorientationof the cube layer is evaluated over time.
-
eyeVisibility
public int eyeVisibility()
- Returns:
- the value of the
eyeVisibilityfield.
-
swapchain
public long swapchain()
the swapchain.
-
imageArrayIndex
public int imageArrayIndex()
the image array index, with 0 meaning the first or only array element.
-
orientation
public XrQuaternionf orientation()
the orientation of the environment map in thespace.
-
type
public XrCompositionLayerCubeKHR type(int value)
Sets the specified value to thetype()field.
-
type$Default
public XrCompositionLayerCubeKHR type$Default()
Sets theTYPE_COMPOSITION_LAYER_CUBE_KHRvalue to thetype()field.
-
next
public XrCompositionLayerCubeKHR next(long value)
Sets the specified value to thenext()field.
-
layerFlags
public XrCompositionLayerCubeKHR layerFlags(long value)
Sets the specified value to thelayerFlags()field.
-
space
public XrCompositionLayerCubeKHR space(XrSpace value)
Sets the specified value to thespace()field.
-
eyeVisibility
public XrCompositionLayerCubeKHR eyeVisibility(int value)
Sets the specified value to theeyeVisibilityfield.
-
swapchain
public XrCompositionLayerCubeKHR swapchain(XrSwapchain value)
Sets the specified value to theswapchain()field.
-
imageArrayIndex
public XrCompositionLayerCubeKHR imageArrayIndex(int value)
Sets the specified value to theimageArrayIndex()field.
-
orientation
public XrCompositionLayerCubeKHR orientation(XrQuaternionf value)
Copies the specifiedXrQuaternionfto theorientation()field.
-
orientation
public XrCompositionLayerCubeKHR orientation(java.util.function.Consumer<XrQuaternionf> consumer)
Passes theorientation()field to the specifiedConsumer.
-
set
public XrCompositionLayerCubeKHR set(int type, long next, long layerFlags, XrSpace space, int eyeVisibility, XrSwapchain swapchain, int imageArrayIndex, XrQuaternionf orientation)
Initializes this struct with the specified values.
-
set
public XrCompositionLayerCubeKHR set(XrCompositionLayerCubeKHR src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static XrCompositionLayerCubeKHR malloc()
Returns a newXrCompositionLayerCubeKHRinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static XrCompositionLayerCubeKHR calloc()
Returns a newXrCompositionLayerCubeKHRinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static XrCompositionLayerCubeKHR create()
Returns a newXrCompositionLayerCubeKHRinstance allocated withBufferUtils.
-
create
public static XrCompositionLayerCubeKHR create(long address)
Returns a newXrCompositionLayerCubeKHRinstance for the specified memory address.
-
createSafe
@Nullable public static XrCompositionLayerCubeKHR createSafe(long address)
-
create
public static XrCompositionLayerCubeKHR create(XrCompositionLayerBaseHeader value)
Downcasts the specifiedXrCompositionLayerBaseHeaderinstance toXrCompositionLayerCubeKHR.
-
malloc
public static XrCompositionLayerCubeKHR.Buffer malloc(int capacity)
Returns a newXrCompositionLayerCubeKHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static XrCompositionLayerCubeKHR.Buffer calloc(int capacity)
Returns a newXrCompositionLayerCubeKHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static XrCompositionLayerCubeKHR.Buffer create(int capacity)
Returns a newXrCompositionLayerCubeKHR.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static XrCompositionLayerCubeKHR.Buffer create(long address, int capacity)
Create aXrCompositionLayerCubeKHR.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static XrCompositionLayerCubeKHR.Buffer createSafe(long address, int capacity)
-
create
public static XrCompositionLayerCubeKHR.Buffer create(XrCompositionLayerBaseHeader.Buffer value)
Downcasts the specifiedXrCompositionLayerBaseHeader.Bufferinstance toXrCompositionLayerCubeKHR.Buffer.
-
malloc
public static XrCompositionLayerCubeKHR malloc(org.lwjgl.system.MemoryStack stack)
Returns a newXrCompositionLayerCubeKHRinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static XrCompositionLayerCubeKHR calloc(org.lwjgl.system.MemoryStack stack)
Returns a newXrCompositionLayerCubeKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static XrCompositionLayerCubeKHR.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newXrCompositionLayerCubeKHR.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static XrCompositionLayerCubeKHR.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newXrCompositionLayerCubeKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
ntype
public static int ntype(long struct)
Unsafe version oftype().
-
nnext
public static long nnext(long struct)
Unsafe version ofnext().
-
nlayerFlags
public static long nlayerFlags(long struct)
Unsafe version oflayerFlags().
-
nspace
public static long nspace(long struct)
Unsafe version ofspace().
-
neyeVisibility
public static int neyeVisibility(long struct)
Unsafe version ofeyeVisibility().
-
nswapchain
public static long nswapchain(long struct)
Unsafe version ofswapchain().
-
nimageArrayIndex
public static int nimageArrayIndex(long struct)
Unsafe version ofimageArrayIndex().
-
norientation
public static XrQuaternionf norientation(long struct)
Unsafe version oforientation().
-
ntype
public static void ntype(long struct, int value)Unsafe version oftype.
-
nnext
public static void nnext(long struct, long value)Unsafe version ofnext.
-
nlayerFlags
public static void nlayerFlags(long struct, long value)Unsafe version oflayerFlags.
-
neyeVisibility
public static void neyeVisibility(long struct, int value)Unsafe version ofeyeVisibility.
-
nswapchain
public static void nswapchain(long struct, XrSwapchain value)Unsafe version ofswapchain.
-
nimageArrayIndex
public static void nimageArrayIndex(long struct, int value)Unsafe version ofimageArrayIndex.
-
norientation
public static void norientation(long struct, XrQuaternionf value)Unsafe version oforientation.
-
validate
public static void validate(long struct)
Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-
-