Package org.lwjgl.openxr

Class XrCompositionLayerColorScaleBiasKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrCompositionLayerColorScaleBiasKHR>

org.lwjgl.openxr.XrCompositionLayerColorScaleBiasKHR

All Implemented Interfaces:

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

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

defines color scale and bias for layer textures.

Description

XrCompositionLayerColorScaleBiasKHR contains the information needed to scale and bias the color of layer textures.

The XrCompositionLayerColorScaleBiasKHR structure can be applied by applications to composition layers by adding an instance of the struct to the XrCompositionLayerBaseHeader::next list.

Valid Usage (Implicit)

• The XR_KHR_composition_layer_color_scale_bias extension must be enabled prior to using XrCompositionLayerColorScaleBiasKHR
• type must be TYPE_COMPOSITION_LAYER_COLOR_SCALE_BIAS_KHR
• next must be NULL or a valid pointer to the next structure in a structure chain

See Also

XrColor4f, XrCompositionLayerBaseHeader

Layout

 struct XrCompositionLayerColorScaleBiasKHR {
     XrStructureType type();
     void const * next();
     XrColor4f colorScale();
     XrColor4f colorBias();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static XrCompositionLayerColorScaleBiasKHR	calloc()	Returns a new XrCompositionLayerColorScaleBiasKHR instance allocated with memCalloc.
static XrCompositionLayerColorScaleBiasKHR.Buffer	calloc(int capacity)	Returns a new XrCompositionLayerColorScaleBiasKHR.Buffer instance allocated with memCalloc.
static XrCompositionLayerColorScaleBiasKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerColorScaleBiasKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrCompositionLayerColorScaleBiasKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerColorScaleBiasKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
XrColor4f	colorBias()	an XrColor4f which will offset the color sourced from the images.
XrCompositionLayerColorScaleBiasKHR	colorBias(Consumer<XrColor4f> consumer)	Passes the colorBias() field to the specified Consumer.
XrCompositionLayerColorScaleBiasKHR	colorBias(XrColor4f value)	Copies the specified XrColor4f to the colorBias() field.
XrColor4f	colorScale()	an XrColor4f which will modulate the color sourced from the images.
XrCompositionLayerColorScaleBiasKHR	colorScale(Consumer<XrColor4f> consumer)	Passes the colorScale() field to the specified Consumer.
XrCompositionLayerColorScaleBiasKHR	colorScale(XrColor4f value)	Copies the specified XrColor4f to the colorScale() field.
static XrCompositionLayerColorScaleBiasKHR	create()	Returns a new XrCompositionLayerColorScaleBiasKHR instance allocated with BufferUtils.
static XrCompositionLayerColorScaleBiasKHR.Buffer	create(int capacity)	Returns a new XrCompositionLayerColorScaleBiasKHR.Buffer instance allocated with BufferUtils.
static XrCompositionLayerColorScaleBiasKHR	create(long address)	Returns a new XrCompositionLayerColorScaleBiasKHR instance for the specified memory address.
static XrCompositionLayerColorScaleBiasKHR.Buffer	create(long address, int capacity)	Create a XrCompositionLayerColorScaleBiasKHR.Buffer instance at the specified memory.
static @Nullable XrCompositionLayerColorScaleBiasKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrCompositionLayerColorScaleBiasKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrCompositionLayerColorScaleBiasKHR	malloc()	Returns a new XrCompositionLayerColorScaleBiasKHR instance allocated with memAlloc.
static XrCompositionLayerColorScaleBiasKHR.Buffer	malloc(int capacity)	Returns a new XrCompositionLayerColorScaleBiasKHR.Buffer instance allocated with memAlloc.
static XrCompositionLayerColorScaleBiasKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerColorScaleBiasKHR.Buffer instance allocated on the specified MemoryStack.
static XrCompositionLayerColorScaleBiasKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerColorScaleBiasKHR instance allocated on the specified MemoryStack.
static XrColor4f	ncolorBias(long struct)	Unsafe version of colorBias().
static void	ncolorBias(long struct, XrColor4f value)	Unsafe version of colorBias.
static XrColor4f	ncolorScale(long struct)	Unsafe version of colorScale().
static void	ncolorScale(long struct, XrColor4f value)	Unsafe version of colorScale.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrCompositionLayerColorScaleBiasKHR	next(long value)	Sets the specified value to the next() field.
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
XrCompositionLayerColorScaleBiasKHR	set(int type, long next, XrColor4f colorScale, XrColor4f colorBias)	Initializes this struct with the specified values.
XrCompositionLayerColorScaleBiasKHR	set(XrCompositionLayerColorScaleBiasKHR src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrCompositionLayerColorScaleBiasKHR	type(int value)	Sets the specified value to the type() field.
XrCompositionLayerColorScaleBiasKHR	type$Default()	Sets the TYPE_COMPOSITION_LAYER_COLOR_SCALE_BIAS_KHR value to the type() field.

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.

COLORSCALE

public static final int COLORSCALE

The struct member offsets.

COLORBIAS

public static final int COLORBIAS

The struct member offsets.

Constructor Details

XrCompositionLayerColorScaleBiasKHR

public XrCompositionLayerColorScaleBiasKHR(ByteBuffer container)

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

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.

colorScale

public XrColor4f colorScale()

an XrColor4f which will modulate the color sourced from the images.

colorBias

public XrColor4f colorBias()

an XrColor4f which will offset the color sourced from the images.

type

public XrCompositionLayerColorScaleBiasKHR type(int value)

Sets the specified value to the type() field.

type$Default

public XrCompositionLayerColorScaleBiasKHR type$Default()

Sets the TYPE_COMPOSITION_LAYER_COLOR_SCALE_BIAS_KHR value to the type() field.

next

public XrCompositionLayerColorScaleBiasKHR next(long value)

Sets the specified value to the next() field.

colorScale

public XrCompositionLayerColorScaleBiasKHR colorScale(XrColor4f value)

Copies the specified XrColor4f to the colorScale() field.

colorScale

public XrCompositionLayerColorScaleBiasKHR colorScale(Consumer<XrColor4f> consumer)

Passes the colorScale() field to the specified Consumer.

colorBias

public XrCompositionLayerColorScaleBiasKHR colorBias(XrColor4f value)

Copies the specified XrColor4f to the colorBias() field.

colorBias

public XrCompositionLayerColorScaleBiasKHR colorBias(Consumer<XrColor4f> consumer)

Passes the colorBias() field to the specified Consumer.

set

public XrCompositionLayerColorScaleBiasKHR set(int type,
 long next,
 XrColor4f colorScale,
 XrColor4f colorBias)

Initializes this struct with the specified values.

set

public XrCompositionLayerColorScaleBiasKHR set(XrCompositionLayerColorScaleBiasKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrCompositionLayerColorScaleBiasKHR malloc()

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

calloc

public static XrCompositionLayerColorScaleBiasKHR calloc()

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

create

public static XrCompositionLayerColorScaleBiasKHR create()

Returns a new XrCompositionLayerColorScaleBiasKHR instance allocated with BufferUtils.

create

public static XrCompositionLayerColorScaleBiasKHR create(long address)

Returns a new XrCompositionLayerColorScaleBiasKHR instance for the specified memory address.

createSafe

public static @Nullable XrCompositionLayerColorScaleBiasKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrCompositionLayerColorScaleBiasKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrCompositionLayerColorScaleBiasKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrCompositionLayerColorScaleBiasKHR.Buffer create(int capacity)

Returns a new XrCompositionLayerColorScaleBiasKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrCompositionLayerColorScaleBiasKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrCompositionLayerColorScaleBiasKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

ncolorScale

public static XrColor4f ncolorScale(long struct)

Unsafe version of colorScale().

ncolorBias

public static XrColor4f ncolorBias(long struct)

Unsafe version of colorBias().

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.

ncolorScale

public static void ncolorScale(long struct,
 XrColor4f value)

Unsafe version of colorScale.

ncolorBias

public static void ncolorBias(long struct,
 XrColor4f value)

Unsafe version of colorBias.