Package org.lwjgl.openxr

Class XrSwapchainStateFoveationFB

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSwapchainStateFoveationFB>

org.lwjgl.openxr.XrSwapchainStateFoveationFB

All Implemented Interfaces:

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

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

Foveation swapchain state,xrefs=.

Valid Usage (Implicit)

• The XR_FB_foveation extension must be enabled prior to using XrSwapchainStateFoveationFB
• type must be TYPE_SWAPCHAIN_STATE_FOVEATION_FB
• next must be NULL or a valid pointer to the next structure in a structure chain
• flags must be 0
• profile must be a valid XrFoveationProfileFB handle

Layout

 struct XrSwapchainStateFoveationFB {
     XrStructureType type();
     void * next();
     XrSwapchainStateFoveationFlagsFB flags();
     XrFoveationProfileFB profile();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static XrSwapchainStateFoveationFB	calloc()	Returns a new XrSwapchainStateFoveationFB instance allocated with memCalloc.
static XrSwapchainStateFoveationFB.Buffer	calloc(int capacity)	Returns a new XrSwapchainStateFoveationFB.Buffer instance allocated with memCalloc.
static XrSwapchainStateFoveationFB.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSwapchainStateFoveationFB.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSwapchainStateFoveationFB	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSwapchainStateFoveationFB instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSwapchainStateFoveationFB	create()	Returns a new XrSwapchainStateFoveationFB instance allocated with BufferUtils.
static XrSwapchainStateFoveationFB.Buffer	create(int capacity)	Returns a new XrSwapchainStateFoveationFB.Buffer instance allocated with BufferUtils.
static XrSwapchainStateFoveationFB	create(long address)	Returns a new XrSwapchainStateFoveationFB instance for the specified memory address.
static XrSwapchainStateFoveationFB.Buffer	create(long address, int capacity)	Create a XrSwapchainStateFoveationFB.Buffer instance at the specified memory.
static XrSwapchainStateFoveationFB	create(XrSwapchainStateBaseHeaderFB value)	Downcasts the specified XrSwapchainStateBaseHeaderFB instance to XrSwapchainStateFoveationFB.
static XrSwapchainStateFoveationFB.Buffer	create(XrSwapchainStateBaseHeaderFB.Buffer value)	Downcasts the specified XrSwapchainStateBaseHeaderFB.Buffer instance to XrSwapchainStateFoveationFB.Buffer.
static @Nullable XrSwapchainStateFoveationFB	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrSwapchainStateFoveationFB.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	flags()	a bitmask of XrSwapchainStateFoveationFlagBitsFB which indicate various characteristics of how and when the foveation properties of the swapchain must be updated.
XrSwapchainStateFoveationFB	flags(long value)	Sets the specified value to the flags() field.
static XrSwapchainStateFoveationFB	malloc()	Returns a new XrSwapchainStateFoveationFB instance allocated with memAlloc.
static XrSwapchainStateFoveationFB.Buffer	malloc(int capacity)	Returns a new XrSwapchainStateFoveationFB.Buffer instance allocated with memAlloc.
static XrSwapchainStateFoveationFB.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSwapchainStateFoveationFB.Buffer instance allocated on the specified MemoryStack.
static XrSwapchainStateFoveationFB	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSwapchainStateFoveationFB instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrSwapchainStateFoveationFB	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 long	nprofile(long struct)	Unsafe version of profile().
static void	nprofile(long struct, XrFoveationProfileFB value)	Unsafe version of profile.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
long	profile()	an XrFoveationProfileFB defining the desired foveation properties to be applied to the swapchain.
XrSwapchainStateFoveationFB	profile(XrFoveationProfileFB value)	Sets the specified value to the profile() field.
XrSwapchainStateFoveationFB	set(int type, long next, long flags, XrFoveationProfileFB profile)	Initializes this struct with the specified values.
XrSwapchainStateFoveationFB	set(XrSwapchainStateFoveationFB src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrSwapchainStateFoveationFB	type(int value)	Sets the specified value to the type() field.
XrSwapchainStateFoveationFB	type$Default()	Sets the TYPE_SWAPCHAIN_STATE_FOVEATION_FB 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.

FLAGS

public static final int FLAGS

The struct member offsets.

PROFILE

public static final int PROFILE

The struct member offsets.

Constructor Details

XrSwapchainStateFoveationFB

public XrSwapchainStateFoveationFB(ByteBuffer container)

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

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 XrSwapchainStateFoveationFlagBitsFB which indicate various characteristics of how and when the foveation properties of the swapchain must be updated.

profile

public long profile()

an XrFoveationProfileFB defining the desired foveation properties to be applied to the swapchain.

type

public XrSwapchainStateFoveationFB type(int value)

Sets the specified value to the type() field.

type$Default

public XrSwapchainStateFoveationFB type$Default()

Sets the TYPE_SWAPCHAIN_STATE_FOVEATION_FB value to the type() field.

next

public XrSwapchainStateFoveationFB next(long value)

Sets the specified value to the next() field.

flags

public XrSwapchainStateFoveationFB flags(long value)

Sets the specified value to the flags() field.

profile

public XrSwapchainStateFoveationFB profile(XrFoveationProfileFB value)

Sets the specified value to the profile() field.

set

public XrSwapchainStateFoveationFB set(int type,
 long next,
 long flags,
 XrFoveationProfileFB profile)

Initializes this struct with the specified values.

set

public XrSwapchainStateFoveationFB set(XrSwapchainStateFoveationFB src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSwapchainStateFoveationFB malloc()

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

calloc

public static XrSwapchainStateFoveationFB calloc()

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

create

public static XrSwapchainStateFoveationFB create()

Returns a new XrSwapchainStateFoveationFB instance allocated with BufferUtils.

create

public static XrSwapchainStateFoveationFB create(long address)

Returns a new XrSwapchainStateFoveationFB instance for the specified memory address.

createSafe

public static @Nullable XrSwapchainStateFoveationFB createSafe(long address)

Like create, but returns null if address is NULL.

create

public static XrSwapchainStateFoveationFB create(XrSwapchainStateBaseHeaderFB value)

Downcasts the specified XrSwapchainStateBaseHeaderFB instance to XrSwapchainStateFoveationFB.

malloc

public static XrSwapchainStateFoveationFB.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSwapchainStateFoveationFB.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSwapchainStateFoveationFB.Buffer create(int capacity)

Returns a new XrSwapchainStateFoveationFB.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSwapchainStateFoveationFB.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

create

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

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

malloc

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

Returns a new XrSwapchainStateFoveationFB instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nprofile

public static long nprofile(long struct)

Unsafe version of profile().

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.

nprofile

public static void nprofile(long struct,
 XrFoveationProfileFB value)

Unsafe version of profile.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate