Package org.lwjgl.openxr

Class XrCompositionLayerCubeKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrCompositionLayerCubeKHR>

org.lwjgl.openxr.XrCompositionLayerCubeKHR

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class XrCompositionLayerCubeKHR
extends org.lwjgl.system.Struct<XrCompositionLayerCubeKHR>
implements org.lwjgl.system.NativeResource

Cube map layer composition info.

Description

XrCompositionLayerCubeKHR contains the information needed to render a cube map when calling EndFrame. XrCompositionLayerCubeKHR is an alias type for the base struct XrCompositionLayerBaseHeader used in XrFrameEndInfo.

Valid Usage (Implicit)

• The XR_KHR_composition_layer_cube extension must be enabled prior to using XrCompositionLayerCubeKHR
• type must be TYPE_COMPOSITION_LAYER_CUBE_KHR
• next must be NULL or a valid pointer to the next structure in a structure chain
• layerFlags must be 0 or a valid combination of XrCompositionLayerFlagBits values
• space must be a valid XrSpace handle
• eyeVisibility must be a valid XrEyeVisibility value
• swapchain must be a valid XrSwapchain handle
• Both of space and swapchain must have been created, allocated, or retrieved from the same XrSession

See Also

XrCompositionLayerBaseHeader, XrFrameEndInfo, XrQuaternionf, EndFrame

Layout

 struct XrCompositionLayerCubeKHR {
     XrStructureType type();
     void const * next();
     XrCompositionLayerFlags layerFlags();
     XrSpace space();
     XrEyeVisibility eyeVisibility();
     XrSwapchain swapchain();
     uint32_t imageArrayIndex();
     XrQuaternionf orientation();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrCompositionLayerCubeKHR.Buffer	An array of XrCompositionLayerCubeKHR structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	EYEVISIBILITY	The struct member offsets.
static final int	IMAGEARRAYINDEX	The struct member offsets.
static final int	LAYERFLAGS	The struct member offsets.
static final int	NEXT	The struct member offsets.
static final int	ORIENTATION	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	SPACE	The struct member offsets.
static final int	SWAPCHAIN	The struct member offsets.
static final int	TYPE	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
XrCompositionLayerCubeKHR(ByteBuffer container)	Creates a XrCompositionLayerCubeKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrCompositionLayerCubeKHR	calloc()	Returns a new XrCompositionLayerCubeKHR instance allocated with memCalloc.
static XrCompositionLayerCubeKHR.Buffer	calloc(int capacity)	Returns a new XrCompositionLayerCubeKHR.Buffer instance allocated with memCalloc.
static XrCompositionLayerCubeKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerCubeKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrCompositionLayerCubeKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerCubeKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrCompositionLayerCubeKHR	create()	Returns a new XrCompositionLayerCubeKHR instance allocated with BufferUtils.
static XrCompositionLayerCubeKHR.Buffer	create(int capacity)	Returns a new XrCompositionLayerCubeKHR.Buffer instance allocated with BufferUtils.
static XrCompositionLayerCubeKHR	create(long address)	Returns a new XrCompositionLayerCubeKHR instance for the specified memory address.
static XrCompositionLayerCubeKHR.Buffer	create(long address, int capacity)	Create a XrCompositionLayerCubeKHR.Buffer instance at the specified memory.
static XrCompositionLayerCubeKHR	create(XrCompositionLayerBaseHeader value)	Downcasts the specified XrCompositionLayerBaseHeader instance to XrCompositionLayerCubeKHR.
static XrCompositionLayerCubeKHR.Buffer	create(XrCompositionLayerBaseHeader.Buffer value)	Downcasts the specified XrCompositionLayerBaseHeader.Buffer instance to XrCompositionLayerCubeKHR.Buffer.
static @Nullable XrCompositionLayerCubeKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrCompositionLayerCubeKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	eyeVisibility()	the eye represented by this layer.
XrCompositionLayerCubeKHR	eyeVisibility(int value)	Sets the specified value to the eyeVisibility() field.
int	imageArrayIndex()	the image array index, with 0 meaning the first or only array element.
XrCompositionLayerCubeKHR	imageArrayIndex(int value)	Sets the specified value to the imageArrayIndex() field.
long	layerFlags()	any flags to apply to this layer.
XrCompositionLayerCubeKHR	layerFlags(long value)	Sets the specified value to the layerFlags() field.
static XrCompositionLayerCubeKHR	malloc()	Returns a new XrCompositionLayerCubeKHR instance allocated with memAlloc.
static XrCompositionLayerCubeKHR.Buffer	malloc(int capacity)	Returns a new XrCompositionLayerCubeKHR.Buffer instance allocated with memAlloc.
static XrCompositionLayerCubeKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerCubeKHR.Buffer instance allocated on the specified MemoryStack.
static XrCompositionLayerCubeKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerCubeKHR instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrCompositionLayerCubeKHR	next(long value)	Sets the specified value to the next() field.
static int	neyeVisibility(long struct)	Unsafe version of eyeVisibility().
static void	neyeVisibility(long struct, int value)	Unsafe version of eyeVisibility.
static int	nimageArrayIndex(long struct)	Unsafe version of imageArrayIndex().
static void	nimageArrayIndex(long struct, int value)	Unsafe version of imageArrayIndex.
static long	nlayerFlags(long struct)	Unsafe version of layerFlags().
static void	nlayerFlags(long struct, long value)	Unsafe version of layerFlags.
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static XrQuaternionf	norientation(long struct)	Unsafe version of orientation().
static void	norientation(long struct, XrQuaternionf value)	Unsafe version of orientation.
static long	nspace(long struct)	Unsafe version of space().
static void	nspace(long struct, XrSpace value)	Unsafe version of space.
static long	nswapchain(long struct)	Unsafe version of swapchain().
static void	nswapchain(long struct, XrSwapchain value)	Unsafe version of swapchain.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
XrQuaternionf	orientation()	the orientation of the environment map in the space.
XrCompositionLayerCubeKHR	orientation(Consumer<XrQuaternionf> consumer)	Passes the orientation() field to the specified Consumer.
XrCompositionLayerCubeKHR	orientation(XrQuaternionf value)	Copies the specified XrQuaternionf to the orientation() field.
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.
XrCompositionLayerCubeKHR	set(XrCompositionLayerCubeKHR src)	Copies the specified struct data to this struct.
int	sizeof()
long	space()	the XrSpace in which the orientation of the cube layer is evaluated over time.
XrCompositionLayerCubeKHR	space(XrSpace value)	Sets the specified value to the space() field.
long	swapchain()	the swapchain, which must have been created with a XrSwapchainCreateInfo::faceCount of 6.
XrCompositionLayerCubeKHR	swapchain(XrSwapchain value)	Sets the specified value to the swapchain() field.
int	type()	the XrStructureType of this structure.
XrCompositionLayerCubeKHR	type(int value)	Sets the specified value to the type() field.
XrCompositionLayerCubeKHR	type$Default()	Sets the TYPE_COMPOSITION_LAYER_CUBE_KHR value to the type() field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

TYPE

public static final int TYPE

The struct member offsets.

NEXT

public static final int NEXT

The struct member offsets.

LAYERFLAGS

public static final int LAYERFLAGS

The struct member offsets.

SPACE

public static final int SPACE

The struct member offsets.

EYEVISIBILITY

public static final int EYEVISIBILITY

The struct member offsets.

SWAPCHAIN

public static final int SWAPCHAIN

The struct member offsets.

IMAGEARRAYINDEX

public static final int IMAGEARRAYINDEX

The struct member offsets.

ORIENTATION

public static final int ORIENTATION

The struct member offsets.

Constructor Details

XrCompositionLayerCubeKHR

public XrCompositionLayerCubeKHR(ByteBuffer container)

Creates a XrCompositionLayerCubeKHR 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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<XrCompositionLayerCubeKHR>

type

public int type()

the XrStructureType of this structure.

next

public long next()

NULL or 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()

the XrSpace in which the orientation of the cube layer is evaluated over time.

eyeVisibility

public int eyeVisibility()

the eye represented by this layer.

swapchain

public long swapchain()

the swapchain, which must have been created with a XrSwapchainCreateInfo::faceCount of 6.

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 the space.

type

public XrCompositionLayerCubeKHR type(int value)

Sets the specified value to the type() field.

type$Default

public XrCompositionLayerCubeKHR type$Default()

Sets the TYPE_COMPOSITION_LAYER_CUBE_KHR value to the type() field.

next

public XrCompositionLayerCubeKHR next(long value)

Sets the specified value to the next() field.

layerFlags

public XrCompositionLayerCubeKHR layerFlags(long value)

Sets the specified value to the layerFlags() field.

space

public XrCompositionLayerCubeKHR space(XrSpace value)

Sets the specified value to the space() field.

eyeVisibility

public XrCompositionLayerCubeKHR eyeVisibility(int value)

Sets the specified value to the eyeVisibility() field.

swapchain

public XrCompositionLayerCubeKHR swapchain(XrSwapchain value)

Sets the specified value to the swapchain() field.

imageArrayIndex

public XrCompositionLayerCubeKHR imageArrayIndex(int value)

Sets the specified value to the imageArrayIndex() field.

orientation

public XrCompositionLayerCubeKHR orientation(XrQuaternionf value)

Copies the specified XrQuaternionf to the orientation() field.

orientation

public XrCompositionLayerCubeKHR orientation(Consumer<XrQuaternionf> consumer)

Passes the orientation() field to the specified Consumer.

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 new XrCompositionLayerCubeKHR instance allocated with memAlloc. The instance must be explicitly freed.

calloc

public static XrCompositionLayerCubeKHR calloc()

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

create

public static XrCompositionLayerCubeKHR create()

Returns a new XrCompositionLayerCubeKHR instance allocated with BufferUtils.

create

public static XrCompositionLayerCubeKHR create(long address)

Returns a new XrCompositionLayerCubeKHR instance for the specified memory address.

createSafe

public static @Nullable XrCompositionLayerCubeKHR createSafe(long address)

Like create, but returns null if address is NULL.

create

public static XrCompositionLayerCubeKHR create(XrCompositionLayerBaseHeader value)

Downcasts the specified XrCompositionLayerBaseHeader instance to XrCompositionLayerCubeKHR.

malloc

public static XrCompositionLayerCubeKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrCompositionLayerCubeKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrCompositionLayerCubeKHR.Buffer create(int capacity)

Returns a new XrCompositionLayerCubeKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static XrCompositionLayerCubeKHR.Buffer create(long address,
 int capacity)

Create a XrCompositionLayerCubeKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable XrCompositionLayerCubeKHR.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

create

public static XrCompositionLayerCubeKHR.Buffer create(XrCompositionLayerBaseHeader.Buffer value)

Downcasts the specified XrCompositionLayerBaseHeader.Buffer instance to XrCompositionLayerCubeKHR.Buffer.

malloc

public static XrCompositionLayerCubeKHR malloc(org.lwjgl.system.MemoryStack stack)

Returns a new XrCompositionLayerCubeKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static XrCompositionLayerCubeKHR calloc(org.lwjgl.system.MemoryStack stack)

Returns a new XrCompositionLayerCubeKHR instance allocated on the specified MemoryStack and 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 new XrCompositionLayerCubeKHR.Buffer instance allocated on the specified MemoryStack.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static XrCompositionLayerCubeKHR.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

ntype

public static int ntype(long struct)

Unsafe version of type().

nnext

public static long nnext(long struct)

Unsafe version of next().

nlayerFlags

public static long nlayerFlags(long struct)

Unsafe version of layerFlags().

nspace

public static long nspace(long struct)

Unsafe version of space().

neyeVisibility

public static int neyeVisibility(long struct)

Unsafe version of eyeVisibility().

nswapchain

public static long nswapchain(long struct)

Unsafe version of swapchain().

nimageArrayIndex

public static int nimageArrayIndex(long struct)

Unsafe version of imageArrayIndex().

norientation

public static XrQuaternionf norientation(long struct)

Unsafe version of orientation().

ntype

public static void ntype(long struct,
 int value)

Unsafe version of type.

nnext

public static void nnext(long struct,
 long value)

Unsafe version of next.

nlayerFlags

public static void nlayerFlags(long struct,
 long value)

Unsafe version of layerFlags.

nspace

public static void nspace(long struct,
 XrSpace value)

Unsafe version of space.

neyeVisibility

public static void neyeVisibility(long struct,
 int value)

Unsafe version of eyeVisibility.

nswapchain

public static void nswapchain(long struct,
 XrSwapchain value)

Unsafe version of swapchain.

nimageArrayIndex

public static void nimageArrayIndex(long struct,
 int value)

Unsafe version of imageArrayIndex.

norientation

public static void norientation(long struct,
 XrQuaternionf value)

Unsafe version of orientation.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate