Package org.lwjgl.openxr

Class XrCompositionLayerImageLayoutFB

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrCompositionLayerImageLayoutFB>

org.lwjgl.openxr.XrCompositionLayerImageLayoutFB

All Implemented Interfaces:

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

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

specifies image layout for composition layers.

Description

XrCompositionLayerImageLayoutFB contains additional flags used to change the interpretation of the image layout for a composition layer.

To specify the additional flags, you must create a XrCompositionLayerImageLayoutFB structure and pass it via the XrCompositionLayerBaseHeader structure’s next parameter.

Valid Usage (Implicit)

• The XR_FB_composition_layer_image_layout extension must be enabled prior to using XrCompositionLayerImageLayoutFB
• type must be TYPE_COMPOSITION_LAYER_IMAGE_LAYOUT_FB
• next must be NULL or a valid pointer to the next structure in a structure chain
• flags must be 0 or a valid combination of XrCompositionLayerImageLayoutFlagBitsFB values

See Also

XrCompositionLayerBaseHeader

Layout

 struct XrCompositionLayerImageLayoutFB {
     XrStructureType type();
     void * next();
     XrCompositionLayerImageLayoutFlagsFB flags();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrCompositionLayerImageLayoutFB.Buffer	An array of XrCompositionLayerImageLayoutFB 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	FLAGS	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
XrCompositionLayerImageLayoutFB(ByteBuffer container)	Creates a XrCompositionLayerImageLayoutFB instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrCompositionLayerImageLayoutFB	calloc()	Returns a new XrCompositionLayerImageLayoutFB instance allocated with memCalloc.
static XrCompositionLayerImageLayoutFB.Buffer	calloc(int capacity)	Returns a new XrCompositionLayerImageLayoutFB.Buffer instance allocated with memCalloc.
static XrCompositionLayerImageLayoutFB.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerImageLayoutFB.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrCompositionLayerImageLayoutFB	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerImageLayoutFB instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrCompositionLayerImageLayoutFB	create()	Returns a new XrCompositionLayerImageLayoutFB instance allocated with BufferUtils.
static XrCompositionLayerImageLayoutFB.Buffer	create(int capacity)	Returns a new XrCompositionLayerImageLayoutFB.Buffer instance allocated with BufferUtils.
static XrCompositionLayerImageLayoutFB	create(long address)	Returns a new XrCompositionLayerImageLayoutFB instance for the specified memory address.
static XrCompositionLayerImageLayoutFB.Buffer	create(long address, int capacity)	Create a XrCompositionLayerImageLayoutFB.Buffer instance at the specified memory.
static @Nullable XrCompositionLayerImageLayoutFB	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrCompositionLayerImageLayoutFB.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	flags()	a bitmask of XrCompositionLayerImageLayoutFlagBitsFB.
XrCompositionLayerImageLayoutFB	flags(long value)	Sets the specified value to the flags() field.
static XrCompositionLayerImageLayoutFB	malloc()	Returns a new XrCompositionLayerImageLayoutFB instance allocated with memAlloc.
static XrCompositionLayerImageLayoutFB.Buffer	malloc(int capacity)	Returns a new XrCompositionLayerImageLayoutFB.Buffer instance allocated with memAlloc.
static XrCompositionLayerImageLayoutFB.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerImageLayoutFB.Buffer instance allocated on the specified MemoryStack.
static XrCompositionLayerImageLayoutFB	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerImageLayoutFB instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrCompositionLayerImageLayoutFB	next(long value)	Sets the specified value to the next() field.
static long	nflags(long struct)	Unsafe version of flags().
static void	nflags(long struct, long value)	Unsafe version of flags.
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.
XrCompositionLayerImageLayoutFB	set(int type, long next, long flags)	Initializes this struct with the specified values.
XrCompositionLayerImageLayoutFB	set(XrCompositionLayerImageLayoutFB src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrCompositionLayerImageLayoutFB	type(int value)	Sets the specified value to the type() field.
XrCompositionLayerImageLayoutFB	type$Default()	Sets the TYPE_COMPOSITION_LAYER_IMAGE_LAYOUT_FB 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.

FLAGS

public static final int FLAGS

The struct member offsets.

Constructor Details

XrCompositionLayerImageLayoutFB

public XrCompositionLayerImageLayoutFB(ByteBuffer container)

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

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.

flags

public long flags()

a bitmask of XrCompositionLayerImageLayoutFlagBitsFB.

type

public XrCompositionLayerImageLayoutFB type(int value)

Sets the specified value to the type() field.

type$Default

public XrCompositionLayerImageLayoutFB type$Default()

Sets the TYPE_COMPOSITION_LAYER_IMAGE_LAYOUT_FB value to the type() field.

next

public XrCompositionLayerImageLayoutFB next(long value)

Sets the specified value to the next() field.

flags

public XrCompositionLayerImageLayoutFB flags(long value)

Sets the specified value to the flags() field.

set

public XrCompositionLayerImageLayoutFB set(int type,
 long next,
 long flags)

Initializes this struct with the specified values.

set

public XrCompositionLayerImageLayoutFB set(XrCompositionLayerImageLayoutFB src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrCompositionLayerImageLayoutFB malloc()

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

calloc

public static XrCompositionLayerImageLayoutFB calloc()

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

create

public static XrCompositionLayerImageLayoutFB create()

Returns a new XrCompositionLayerImageLayoutFB instance allocated with BufferUtils.

create

public static XrCompositionLayerImageLayoutFB create(long address)

Returns a new XrCompositionLayerImageLayoutFB instance for the specified memory address.

createSafe

public static @Nullable XrCompositionLayerImageLayoutFB createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrCompositionLayerImageLayoutFB.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrCompositionLayerImageLayoutFB.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrCompositionLayerImageLayoutFB.Buffer create(int capacity)

Returns a new XrCompositionLayerImageLayoutFB.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrCompositionLayerImageLayoutFB.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrCompositionLayerImageLayoutFB instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nflags

public static long nflags(long struct)

Unsafe version of flags().

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.

nflags

public static void nflags(long struct,
 long value)

Unsafe version of flags.