Package org.lwjgl.openxr

Class XrSwapchainStateBaseHeaderFB

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSwapchainStateBaseHeaderFB>

org.lwjgl.openxr.XrSwapchainStateBaseHeaderFB

All Implemented Interfaces:

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

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

Base header for swapchain update state.

Description

The XrSwapchainStateBaseHeaderFB is a base structure that can be overridden by a specific stext:XrSwapchainState* child structure.

Valid Usage (Implicit)

• The XR_FB_swapchain_update_state extension must be enabled prior to using XrSwapchainStateBaseHeaderFB
• type must be one of the following XrStructureType values: TYPE_SWAPCHAIN_STATE_FOVEATION_FB, TYPE_SWAPCHAIN_STATE_SAMPLER_OPENGL_ES_FB, TYPE_SWAPCHAIN_STATE_SAMPLER_VULKAN_FB
• next must be NULL or a valid pointer to the next structure in a structure chain

See Also

GetSwapchainStateFB, UpdateSwapchainFB

Layout

 struct XrSwapchainStateBaseHeaderFB {
     XrStructureType type();
     void * next();
 }

Nested Class Summary

Nested Classes

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

Method Summary

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

Constructor Details

XrSwapchainStateBaseHeaderFB

public XrSwapchainStateBaseHeaderFB(ByteBuffer container)

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

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 or this extension.

type

public XrSwapchainStateBaseHeaderFB type(int value)

Sets the specified value to the type() field.

next

public XrSwapchainStateBaseHeaderFB next(long value)

Sets the specified value to the next() field.

set

public XrSwapchainStateBaseHeaderFB set(int type,
 long next)

Initializes this struct with the specified values.

set

public XrSwapchainStateBaseHeaderFB set(XrSwapchainStateBaseHeaderFB src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSwapchainStateBaseHeaderFB malloc()

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

calloc

public static XrSwapchainStateBaseHeaderFB calloc()

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

create

public static XrSwapchainStateBaseHeaderFB create()

Returns a new XrSwapchainStateBaseHeaderFB instance allocated with BufferUtils.

create

public static XrSwapchainStateBaseHeaderFB create(long address)

Returns a new XrSwapchainStateBaseHeaderFB instance for the specified memory address.

createSafe

public static @Nullable XrSwapchainStateBaseHeaderFB createSafe(long address)

Like create, but returns null if address is NULL.

create

public static XrSwapchainStateBaseHeaderFB create(XrSwapchainStateFoveationFB value)

Upcasts the specified XrSwapchainStateFoveationFB instance to XrSwapchainStateBaseHeaderFB.

create

public static XrSwapchainStateBaseHeaderFB create(XrSwapchainStateSamplerOpenGLESFB value)

Upcasts the specified XrSwapchainStateSamplerOpenGLESFB instance to XrSwapchainStateBaseHeaderFB.

create

public static XrSwapchainStateBaseHeaderFB create(XrSwapchainStateSamplerVulkanFB value)

Upcasts the specified XrSwapchainStateSamplerVulkanFB instance to XrSwapchainStateBaseHeaderFB.

malloc

public static XrSwapchainStateBaseHeaderFB.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSwapchainStateBaseHeaderFB.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSwapchainStateBaseHeaderFB.Buffer create(int capacity)

Returns a new XrSwapchainStateBaseHeaderFB.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSwapchainStateBaseHeaderFB.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

create

public static XrSwapchainStateBaseHeaderFB.Buffer create(XrSwapchainStateFoveationFB.Buffer value)

Upcasts the specified XrSwapchainStateFoveationFB.Buffer instance to XrSwapchainStateBaseHeaderFB.Buffer.

create

public static XrSwapchainStateBaseHeaderFB.Buffer create(XrSwapchainStateSamplerOpenGLESFB.Buffer value)

Upcasts the specified XrSwapchainStateSamplerOpenGLESFB.Buffer instance to XrSwapchainStateBaseHeaderFB.Buffer.

create

public static XrSwapchainStateBaseHeaderFB.Buffer create(XrSwapchainStateSamplerVulkanFB.Buffer value)

Upcasts the specified XrSwapchainStateSamplerVulkanFB.Buffer instance to XrSwapchainStateBaseHeaderFB.Buffer.

malloc

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

Returns a new XrSwapchainStateBaseHeaderFB instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

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.