Package org.lwjgl.openxr

Class XrCompositionLayerBaseHeader

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrCompositionLayerBaseHeader>

org.lwjgl.openxr.XrCompositionLayerBaseHeader

All Implemented Interfaces:

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

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

Composition layer base header.

Description

All composition layer structures begin with the elements described in the XrCompositionLayerBaseHeader. The XrCompositionLayerBaseHeader structure is not intended to be directly used, but forms a basis for defining current and future structures containing composition layer information. The XrFrameEndInfo structure contains an array of pointers to these polymorphic header structures. All composition layer type pointers must be type-castable as an XrCompositionLayerBaseHeader pointer.

Valid Usage (Implicit)

• type must be one of the following XrStructureType values: TYPE_COMPOSITION_LAYER_CUBE_KHR, TYPE_COMPOSITION_LAYER_CYLINDER_KHR, TYPE_COMPOSITION_LAYER_EQUIRECT2_KHR, TYPE_COMPOSITION_LAYER_EQUIRECT_KHR, TYPE_COMPOSITION_LAYER_PASSTHROUGH_FB, TYPE_COMPOSITION_LAYER_PASSTHROUGH_HTC, TYPE_COMPOSITION_LAYER_PROJECTION, TYPE_COMPOSITION_LAYER_QUAD
• next must be NULL or a valid pointer to the next structure in a structure chain. See also: XrCompositionLayerAlphaBlendFB, XrCompositionLayerColorScaleBiasKHR, XrCompositionLayerDepthTestFB, XrCompositionLayerImageLayoutFB, XrCompositionLayerSecureContentFB, XrCompositionLayerSettingsFB
• layerFlags must be 0 or a valid combination of XrCompositionLayerFlagBits values
• space must be a valid XrSpace handle

See Also

XrFrameEndInfo, XrRecommendedLayerResolutionGetInfoMETA, XrSecondaryViewConfigurationLayerInfoMSFT, XrSwapchainSubImage

Layout

 struct XrCompositionLayerBaseHeader {
     XrStructureType type();
     void const * next();
     XrCompositionLayerFlags layerFlags();
     XrSpace space();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrCompositionLayerBaseHeader.Buffer	An array of XrCompositionLayerBaseHeader 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	LAYERFLAGS	The struct member offsets.
static final int	NEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	SPACE	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
XrCompositionLayerBaseHeader(ByteBuffer container)	Creates a XrCompositionLayerBaseHeader instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrCompositionLayerBaseHeader	calloc()	Returns a new XrCompositionLayerBaseHeader instance allocated with memCalloc.
static XrCompositionLayerBaseHeader.Buffer	calloc(int capacity)	Returns a new XrCompositionLayerBaseHeader.Buffer instance allocated with memCalloc.
static XrCompositionLayerBaseHeader.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerBaseHeader.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrCompositionLayerBaseHeader	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerBaseHeader instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrCompositionLayerBaseHeader	create()	Returns a new XrCompositionLayerBaseHeader instance allocated with BufferUtils.
static XrCompositionLayerBaseHeader.Buffer	create(int capacity)	Returns a new XrCompositionLayerBaseHeader.Buffer instance allocated with BufferUtils.
static XrCompositionLayerBaseHeader	create(long address)	Returns a new XrCompositionLayerBaseHeader instance for the specified memory address.
static XrCompositionLayerBaseHeader.Buffer	create(long address, int capacity)	Create a XrCompositionLayerBaseHeader.Buffer instance at the specified memory.
static XrCompositionLayerBaseHeader	create(XrCompositionLayerCubeKHR value)	Upcasts the specified XrCompositionLayerCubeKHR instance to XrCompositionLayerBaseHeader.
static XrCompositionLayerBaseHeader.Buffer	create(XrCompositionLayerCubeKHR.Buffer value)	Upcasts the specified XrCompositionLayerCubeKHR.Buffer instance to XrCompositionLayerBaseHeader.Buffer.
static XrCompositionLayerBaseHeader	create(XrCompositionLayerCylinderKHR value)	Upcasts the specified XrCompositionLayerCylinderKHR instance to XrCompositionLayerBaseHeader.
static XrCompositionLayerBaseHeader.Buffer	create(XrCompositionLayerCylinderKHR.Buffer value)	Upcasts the specified XrCompositionLayerCylinderKHR.Buffer instance to XrCompositionLayerBaseHeader.Buffer.
static XrCompositionLayerBaseHeader	create(XrCompositionLayerEquirect2KHR value)	Upcasts the specified XrCompositionLayerEquirect2KHR instance to XrCompositionLayerBaseHeader.
static XrCompositionLayerBaseHeader.Buffer	create(XrCompositionLayerEquirect2KHR.Buffer value)	Upcasts the specified XrCompositionLayerEquirect2KHR.Buffer instance to XrCompositionLayerBaseHeader.Buffer.
static XrCompositionLayerBaseHeader	create(XrCompositionLayerEquirectKHR value)	Upcasts the specified XrCompositionLayerEquirectKHR instance to XrCompositionLayerBaseHeader.
static XrCompositionLayerBaseHeader.Buffer	create(XrCompositionLayerEquirectKHR.Buffer value)	Upcasts the specified XrCompositionLayerEquirectKHR.Buffer instance to XrCompositionLayerBaseHeader.Buffer.
static XrCompositionLayerBaseHeader	create(XrCompositionLayerPassthroughFB value)	Upcasts the specified XrCompositionLayerPassthroughFB instance to XrCompositionLayerBaseHeader.
static XrCompositionLayerBaseHeader.Buffer	create(XrCompositionLayerPassthroughFB.Buffer value)	Upcasts the specified XrCompositionLayerPassthroughFB.Buffer instance to XrCompositionLayerBaseHeader.Buffer.
static XrCompositionLayerBaseHeader	create(XrCompositionLayerPassthroughHTC value)	Upcasts the specified XrCompositionLayerPassthroughHTC instance to XrCompositionLayerBaseHeader.
static XrCompositionLayerBaseHeader.Buffer	create(XrCompositionLayerPassthroughHTC.Buffer value)	Upcasts the specified XrCompositionLayerPassthroughHTC.Buffer instance to XrCompositionLayerBaseHeader.Buffer.
static XrCompositionLayerBaseHeader	create(XrCompositionLayerProjection value)	Upcasts the specified XrCompositionLayerProjection instance to XrCompositionLayerBaseHeader.
static XrCompositionLayerBaseHeader.Buffer	create(XrCompositionLayerProjection.Buffer value)	Upcasts the specified XrCompositionLayerProjection.Buffer instance to XrCompositionLayerBaseHeader.Buffer.
static XrCompositionLayerBaseHeader	create(XrCompositionLayerQuad value)	Upcasts the specified XrCompositionLayerQuad instance to XrCompositionLayerBaseHeader.
static XrCompositionLayerBaseHeader.Buffer	create(XrCompositionLayerQuad.Buffer value)	Upcasts the specified XrCompositionLayerQuad.Buffer instance to XrCompositionLayerBaseHeader.Buffer.
static @Nullable XrCompositionLayerBaseHeader	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrCompositionLayerBaseHeader.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	layerFlags()	a bitmask of XrCompositionLayerFlagBits describing flags to apply to the layer.
XrCompositionLayerBaseHeader	layerFlags(long value)	Sets the specified value to the layerFlags() field.
static XrCompositionLayerBaseHeader	malloc()	Returns a new XrCompositionLayerBaseHeader instance allocated with memAlloc.
static XrCompositionLayerBaseHeader.Buffer	malloc(int capacity)	Returns a new XrCompositionLayerBaseHeader.Buffer instance allocated with memAlloc.
static XrCompositionLayerBaseHeader.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerBaseHeader.Buffer instance allocated on the specified MemoryStack.
static XrCompositionLayerBaseHeader	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerBaseHeader instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrCompositionLayerBaseHeader	next(long value)	Sets the specified value to the next() field.
XrCompositionLayerBaseHeader	next(XrCompositionLayerAlphaBlendFB value)	Prepends the specified XrCompositionLayerAlphaBlendFB value to the next chain.
XrCompositionLayerBaseHeader	next(XrCompositionLayerColorScaleBiasKHR value)	Prepends the specified XrCompositionLayerColorScaleBiasKHR value to the next chain.
XrCompositionLayerBaseHeader	next(XrCompositionLayerDepthTestFB value)	Prepends the specified XrCompositionLayerDepthTestFB value to the next chain.
XrCompositionLayerBaseHeader	next(XrCompositionLayerImageLayoutFB value)	Prepends the specified XrCompositionLayerImageLayoutFB value to the next chain.
XrCompositionLayerBaseHeader	next(XrCompositionLayerSecureContentFB value)	Prepends the specified XrCompositionLayerSecureContentFB value to the next chain.
XrCompositionLayerBaseHeader	next(XrCompositionLayerSettingsFB value)	Prepends the specified XrCompositionLayerSettingsFB value to the next chain.
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 long	nspace(long struct)	Unsafe version of space().
static void	nspace(long struct, XrSpace value)	Unsafe version of space.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
XrCompositionLayerBaseHeader	set(int type, long next, long layerFlags, XrSpace space)	Initializes this struct with the specified values.
XrCompositionLayerBaseHeader	set(XrCompositionLayerBaseHeader src)	Copies the specified struct data to this struct.
int	sizeof()
long	space()	the XrSpace in which the layer will be kept stable over time.
XrCompositionLayerBaseHeader	space(XrSpace value)	Sets the specified value to the space() field.
int	type()	the XrStructureType of this structure.
XrCompositionLayerBaseHeader	type(int value)	Sets the specified 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.

Constructor Details

XrCompositionLayerBaseHeader

public XrCompositionLayerBaseHeader(ByteBuffer container)

Creates a XrCompositionLayerBaseHeader 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<XrCompositionLayerBaseHeader>

type

public int type()

the XrStructureType of this structure. This base structure itself has no associated XrStructureType value.

next

public long next()

NULL or a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR.

layerFlags

public long layerFlags()

a bitmask of XrCompositionLayerFlagBits describing flags to apply to the layer.

space

public long space()

the XrSpace in which the layer will be kept stable over time.

type

public XrCompositionLayerBaseHeader type(int value)

Sets the specified value to the type() field.

next

public XrCompositionLayerBaseHeader next(long value)

Sets the specified value to the next() field.

next

public XrCompositionLayerBaseHeader next(XrCompositionLayerAlphaBlendFB value)

Prepends the specified XrCompositionLayerAlphaBlendFB value to the next chain.

next

public XrCompositionLayerBaseHeader next(XrCompositionLayerColorScaleBiasKHR value)

Prepends the specified XrCompositionLayerColorScaleBiasKHR value to the next chain.

next

public XrCompositionLayerBaseHeader next(XrCompositionLayerDepthTestFB value)

Prepends the specified XrCompositionLayerDepthTestFB value to the next chain.

next

public XrCompositionLayerBaseHeader next(XrCompositionLayerImageLayoutFB value)

Prepends the specified XrCompositionLayerImageLayoutFB value to the next chain.

next

public XrCompositionLayerBaseHeader next(XrCompositionLayerSecureContentFB value)

Prepends the specified XrCompositionLayerSecureContentFB value to the next chain.

next

public XrCompositionLayerBaseHeader next(XrCompositionLayerSettingsFB value)

Prepends the specified XrCompositionLayerSettingsFB value to the next chain.

layerFlags

public XrCompositionLayerBaseHeader layerFlags(long value)

Sets the specified value to the layerFlags() field.

space

public XrCompositionLayerBaseHeader space(XrSpace value)

Sets the specified value to the space() field.

set

public XrCompositionLayerBaseHeader set(int type,
 long next,
 long layerFlags,
 XrSpace space)

Initializes this struct with the specified values.

set

public XrCompositionLayerBaseHeader set(XrCompositionLayerBaseHeader src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrCompositionLayerBaseHeader malloc()

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

calloc

public static XrCompositionLayerBaseHeader calloc()

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

create

public static XrCompositionLayerBaseHeader create()

Returns a new XrCompositionLayerBaseHeader instance allocated with BufferUtils.

create

public static XrCompositionLayerBaseHeader create(long address)

Returns a new XrCompositionLayerBaseHeader instance for the specified memory address.

createSafe

public static @Nullable XrCompositionLayerBaseHeader createSafe(long address)

Like create, but returns null if address is NULL.

create

public static XrCompositionLayerBaseHeader create(XrCompositionLayerProjection value)

Upcasts the specified XrCompositionLayerProjection instance to XrCompositionLayerBaseHeader.

create

public static XrCompositionLayerBaseHeader create(XrCompositionLayerQuad value)

Upcasts the specified XrCompositionLayerQuad instance to XrCompositionLayerBaseHeader.

create

public static XrCompositionLayerBaseHeader create(XrCompositionLayerCubeKHR value)

Upcasts the specified XrCompositionLayerCubeKHR instance to XrCompositionLayerBaseHeader.

create

public static XrCompositionLayerBaseHeader create(XrCompositionLayerCylinderKHR value)

Upcasts the specified XrCompositionLayerCylinderKHR instance to XrCompositionLayerBaseHeader.

create

public static XrCompositionLayerBaseHeader create(XrCompositionLayerEquirectKHR value)

Upcasts the specified XrCompositionLayerEquirectKHR instance to XrCompositionLayerBaseHeader.

create

public static XrCompositionLayerBaseHeader create(XrCompositionLayerEquirect2KHR value)

Upcasts the specified XrCompositionLayerEquirect2KHR instance to XrCompositionLayerBaseHeader.

create

public static XrCompositionLayerBaseHeader create(XrCompositionLayerPassthroughFB value)

Upcasts the specified XrCompositionLayerPassthroughFB instance to XrCompositionLayerBaseHeader.

create

public static XrCompositionLayerBaseHeader create(XrCompositionLayerPassthroughHTC value)

Upcasts the specified XrCompositionLayerPassthroughHTC instance to XrCompositionLayerBaseHeader.

malloc

public static XrCompositionLayerBaseHeader.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrCompositionLayerBaseHeader.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrCompositionLayerBaseHeader.Buffer create(int capacity)

Returns a new XrCompositionLayerBaseHeader.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrCompositionLayerBaseHeader.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

create

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

Upcasts the specified XrCompositionLayerProjection.Buffer instance to XrCompositionLayerBaseHeader.Buffer.

create

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

Upcasts the specified XrCompositionLayerQuad.Buffer instance to XrCompositionLayerBaseHeader.Buffer.

create

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

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

create

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

Upcasts the specified XrCompositionLayerCylinderKHR.Buffer instance to XrCompositionLayerBaseHeader.Buffer.

create

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

Upcasts the specified XrCompositionLayerEquirectKHR.Buffer instance to XrCompositionLayerBaseHeader.Buffer.

create

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

Upcasts the specified XrCompositionLayerEquirect2KHR.Buffer instance to XrCompositionLayerBaseHeader.Buffer.

create

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

Upcasts the specified XrCompositionLayerPassthroughFB.Buffer instance to XrCompositionLayerBaseHeader.Buffer.

create

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

Upcasts the specified XrCompositionLayerPassthroughHTC.Buffer instance to XrCompositionLayerBaseHeader.Buffer.

malloc

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

Returns a new XrCompositionLayerBaseHeader instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

public static XrCompositionLayerBaseHeader.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

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.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate