Package org.lwjgl.openxr

Class XrCompositionLayerPassthroughHTC

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrCompositionLayerPassthroughHTC>

org.lwjgl.openxr.XrCompositionLayerPassthroughHTC

All Implemented Interfaces:

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

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

A composition layer for passthrough.

Description

The application can create an XrCompositionLayerPassthroughHTC structure with the created passthrough and the corresponding information. A pointer to XrCompositionLayerPassthroughHTC may be submitted in EndFrame as a pointer to the base structure XrCompositionLayerBaseHeader, in the desired layer order, to request the runtime to composite a passthrough layer into the final frame output.

If the passthrough form specified to CreatePassthroughHTC is PASSTHROUGH_FORM_PROJECTED_HTC, XrPassthroughMeshTransformInfoHTC must appear in the next chain. If they are absent, the runtime must return error ERROR_VALIDATION_FAILURE.

Valid Usage (Implicit)

• The XR_HTC_passthrough extension must be enabled prior to using XrCompositionLayerPassthroughHTC
• type must be TYPE_COMPOSITION_LAYER_PASSTHROUGH_HTC
• next must be NULL or a valid pointer to the next structure in a structure chain. See also: XrPassthroughMeshTransformInfoHTC
• layerFlags must be a valid combination of XrCompositionLayerFlagBits values
• layerFlags must not be 0
• space must be a valid XrSpace handle
• passthrough must be a valid XrPassthroughHTC handle
• color must be a valid XrPassthroughColorHTC structure
• Both of passthrough and space must have been created, allocated, or retrieved from the same XrSession

See Also

XrCompositionLayerBaseHeader, XrPassthroughColorHTC

Layout

 struct XrCompositionLayerPassthroughHTC {
     XrStructureType type();
     void const * next();
     XrCompositionLayerFlags layerFlags();
     XrSpace space();
     XrPassthroughHTC passthrough();
     XrPassthroughColorHTC color();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static XrCompositionLayerPassthroughHTC	calloc()	Returns a new XrCompositionLayerPassthroughHTC instance allocated with memCalloc.
static XrCompositionLayerPassthroughHTC.Buffer	calloc(int capacity)	Returns a new XrCompositionLayerPassthroughHTC.Buffer instance allocated with memCalloc.
static XrCompositionLayerPassthroughHTC.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerPassthroughHTC.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrCompositionLayerPassthroughHTC	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerPassthroughHTC instance allocated on the specified MemoryStack and initializes all its bits to zero.
XrPassthroughColorHTC	color()	the XrPassthroughColorHTC describing the color information with the alpha value of the passthrough layer.
XrCompositionLayerPassthroughHTC	color(Consumer<XrPassthroughColorHTC> consumer)	Passes the color() field to the specified Consumer.
XrCompositionLayerPassthroughHTC	color(XrPassthroughColorHTC value)	Copies the specified XrPassthroughColorHTC to the color() field.
static XrCompositionLayerPassthroughHTC	create()	Returns a new XrCompositionLayerPassthroughHTC instance allocated with BufferUtils.
static XrCompositionLayerPassthroughHTC.Buffer	create(int capacity)	Returns a new XrCompositionLayerPassthroughHTC.Buffer instance allocated with BufferUtils.
static XrCompositionLayerPassthroughHTC	create(long address)	Returns a new XrCompositionLayerPassthroughHTC instance for the specified memory address.
static XrCompositionLayerPassthroughHTC.Buffer	create(long address, int capacity)	Create a XrCompositionLayerPassthroughHTC.Buffer instance at the specified memory.
static XrCompositionLayerPassthroughHTC	create(XrCompositionLayerBaseHeader value)	Downcasts the specified XrCompositionLayerBaseHeader instance to XrCompositionLayerPassthroughHTC.
static XrCompositionLayerPassthroughHTC.Buffer	create(XrCompositionLayerBaseHeader.Buffer value)	Downcasts the specified XrCompositionLayerBaseHeader.Buffer instance to XrCompositionLayerPassthroughHTC.Buffer.
static @Nullable XrCompositionLayerPassthroughHTC	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrCompositionLayerPassthroughHTC.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.
XrCompositionLayerPassthroughHTC	layerFlags(long value)	Sets the specified value to the layerFlags() field.
static XrCompositionLayerPassthroughHTC	malloc()	Returns a new XrCompositionLayerPassthroughHTC instance allocated with memAlloc.
static XrCompositionLayerPassthroughHTC.Buffer	malloc(int capacity)	Returns a new XrCompositionLayerPassthroughHTC.Buffer instance allocated with memAlloc.
static XrCompositionLayerPassthroughHTC.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerPassthroughHTC.Buffer instance allocated on the specified MemoryStack.
static XrCompositionLayerPassthroughHTC	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerPassthroughHTC instance allocated on the specified MemoryStack.
static XrPassthroughColorHTC	ncolor(long struct)	Unsafe version of color().
static void	ncolor(long struct, XrPassthroughColorHTC value)	Unsafe version of color.
long	next()	NULL or a pointer to the next structure in a structure chain, such as XrPassthroughMeshTransformInfoHTC.
XrCompositionLayerPassthroughHTC	next(long value)	Sets the specified value to the next() field.
XrCompositionLayerPassthroughHTC	next(XrPassthroughMeshTransformInfoHTC value)	Prepends the specified XrPassthroughMeshTransformInfoHTC 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	npassthrough(long struct)	Unsafe version of passthrough().
static void	npassthrough(long struct, XrPassthroughHTC value)	Unsafe version of passthrough.
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.
long	passthrough()	the XrPassthroughHTC previously created by CreatePassthroughHTC.
XrCompositionLayerPassthroughHTC	passthrough(XrPassthroughHTC value)	Sets the specified value to the passthrough() field.
XrCompositionLayerPassthroughHTC	set(int type, long next, long layerFlags, XrSpace space, XrPassthroughHTC passthrough, XrPassthroughColorHTC color)	Initializes this struct with the specified values.
XrCompositionLayerPassthroughHTC	set(XrCompositionLayerPassthroughHTC src)	Copies the specified struct data to this struct.
int	sizeof()
long	space()	the XrSpace that specifies the layer’s space - must be NULL_HANDLE.
XrCompositionLayerPassthroughHTC	space(XrSpace value)	Sets the specified value to the space() field.
int	type()	the XrStructureType of this structure.
XrCompositionLayerPassthroughHTC	type(int value)	Sets the specified value to the type() field.
XrCompositionLayerPassthroughHTC	type$Default()	Sets the TYPE_COMPOSITION_LAYER_PASSTHROUGH_HTC 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.

PASSTHROUGH

public static final int PASSTHROUGH

The struct member offsets.

COLOR

public static final int COLOR

The struct member offsets.

Constructor Details

XrCompositionLayerPassthroughHTC

public XrCompositionLayerPassthroughHTC(ByteBuffer container)

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

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, such as XrPassthroughMeshTransformInfoHTC.

layerFlags

public long layerFlags()

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

space

public long space()

the XrSpace that specifies the layer’s space - must be NULL_HANDLE.

passthrough

public long passthrough()

the XrPassthroughHTC previously created by CreatePassthroughHTC.

color

public XrPassthroughColorHTC color()

the XrPassthroughColorHTC describing the color information with the alpha value of the passthrough layer.

type

public XrCompositionLayerPassthroughHTC type(int value)

Sets the specified value to the type() field.

type$Default

public XrCompositionLayerPassthroughHTC type$Default()

Sets the TYPE_COMPOSITION_LAYER_PASSTHROUGH_HTC value to the type() field.

next

public XrCompositionLayerPassthroughHTC next(long value)

Sets the specified value to the next() field.

next

public XrCompositionLayerPassthroughHTC next(XrPassthroughMeshTransformInfoHTC value)

Prepends the specified XrPassthroughMeshTransformInfoHTC value to the next chain.

layerFlags

public XrCompositionLayerPassthroughHTC layerFlags(long value)

Sets the specified value to the layerFlags() field.

space

public XrCompositionLayerPassthroughHTC space(XrSpace value)

Sets the specified value to the space() field.

passthrough

public XrCompositionLayerPassthroughHTC passthrough(XrPassthroughHTC value)

Sets the specified value to the passthrough() field.

color

public XrCompositionLayerPassthroughHTC color(XrPassthroughColorHTC value)

Copies the specified XrPassthroughColorHTC to the color() field.

color

public XrCompositionLayerPassthroughHTC color(Consumer<XrPassthroughColorHTC> consumer)

Passes the color() field to the specified Consumer.

set

public XrCompositionLayerPassthroughHTC set(int type,
 long next,
 long layerFlags,
 XrSpace space,
 XrPassthroughHTC passthrough,
 XrPassthroughColorHTC color)

Initializes this struct with the specified values.

set

public XrCompositionLayerPassthroughHTC set(XrCompositionLayerPassthroughHTC src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrCompositionLayerPassthroughHTC malloc()

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

calloc

public static XrCompositionLayerPassthroughHTC calloc()

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

create

public static XrCompositionLayerPassthroughHTC create()

Returns a new XrCompositionLayerPassthroughHTC instance allocated with BufferUtils.

create

public static XrCompositionLayerPassthroughHTC create(long address)

Returns a new XrCompositionLayerPassthroughHTC instance for the specified memory address.

createSafe

public static @Nullable XrCompositionLayerPassthroughHTC createSafe(long address)

Like create, but returns null if address is NULL.

create

public static XrCompositionLayerPassthroughHTC create(XrCompositionLayerBaseHeader value)

Downcasts the specified XrCompositionLayerBaseHeader instance to XrCompositionLayerPassthroughHTC.

malloc

public static XrCompositionLayerPassthroughHTC.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrCompositionLayerPassthroughHTC.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrCompositionLayerPassthroughHTC.Buffer create(int capacity)

Returns a new XrCompositionLayerPassthroughHTC.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrCompositionLayerPassthroughHTC.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

create

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

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

malloc

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

Returns a new XrCompositionLayerPassthroughHTC instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

npassthrough

public static long npassthrough(long struct)

Unsafe version of passthrough().

ncolor

public static XrPassthroughColorHTC ncolor(long struct)

Unsafe version of color().

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.

npassthrough

public static void npassthrough(long struct,
 XrPassthroughHTC value)

Unsafe version of passthrough.

ncolor

public static void ncolor(long struct,
 XrPassthroughColorHTC value)

Unsafe version of color.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate