Package org.lwjgl.openxr

Class XrSwapchainCreateInfoFoveationFB

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSwapchainCreateInfoFoveationFB>

org.lwjgl.openxr.XrSwapchainCreateInfoFoveationFB

All Implemented Interfaces:

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

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

The information to create a swapchain supporting foveation.

Valid Usage (Implicit)

• The XR_FB_foveation extension must be enabled prior to using XrSwapchainCreateInfoFoveationFB
• type must be TYPE_SWAPCHAIN_CREATE_INFO_FOVEATION_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 XrSwapchainCreateFoveationFlagBitsFB values

Layout

 struct XrSwapchainCreateInfoFoveationFB {
     XrStructureType type();
     void * next();
     XrSwapchainCreateFoveationFlagsFB flags();
 }

Nested Class Summary

Nested Classes

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

Method Summary

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

XrSwapchainCreateInfoFoveationFB

public XrSwapchainCreateInfoFoveationFB(ByteBuffer container)

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

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 XrSwapchainCreateFoveationFlagBitsFB which indicate various characteristics for how foveation is enabled on the swapchain.

type

public XrSwapchainCreateInfoFoveationFB type(int value)

Sets the specified value to the type() field.

type$Default

public XrSwapchainCreateInfoFoveationFB type$Default()

Sets the TYPE_SWAPCHAIN_CREATE_INFO_FOVEATION_FB value to the type() field.

next

public XrSwapchainCreateInfoFoveationFB next(long value)

Sets the specified value to the next() field.

flags

public XrSwapchainCreateInfoFoveationFB flags(long value)

Sets the specified value to the flags() field.

set

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

Initializes this struct with the specified values.

set

public XrSwapchainCreateInfoFoveationFB set(XrSwapchainCreateInfoFoveationFB src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSwapchainCreateInfoFoveationFB malloc()

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

calloc

public static XrSwapchainCreateInfoFoveationFB calloc()

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

create

public static XrSwapchainCreateInfoFoveationFB create()

Returns a new XrSwapchainCreateInfoFoveationFB instance allocated with BufferUtils.

create

public static XrSwapchainCreateInfoFoveationFB create(long address)

Returns a new XrSwapchainCreateInfoFoveationFB instance for the specified memory address.

createSafe

public static @Nullable XrSwapchainCreateInfoFoveationFB createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrSwapchainCreateInfoFoveationFB.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSwapchainCreateInfoFoveationFB.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSwapchainCreateInfoFoveationFB.Buffer create(int capacity)

Returns a new XrSwapchainCreateInfoFoveationFB.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSwapchainCreateInfoFoveationFB.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrSwapchainCreateInfoFoveationFB instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new XrSwapchainCreateInfoFoveationFB.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.