Package org.lwjgl.openxr

Class XrFoveationLevelProfileCreateInfoFB

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrFoveationLevelProfileCreateInfoFB>

org.lwjgl.openxr.XrFoveationLevelProfileCreateInfoFB

All Implemented Interfaces:

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

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

The information to create a foveation profile for foveation levels.

Valid Usage (Implicit)

• The XR_FB_foveation_configuration extension must be enabled prior to using XrFoveationLevelProfileCreateInfoFB
• type must be TYPE_FOVEATION_LEVEL_PROFILE_CREATE_INFO_FB
• next must be NULL or a valid pointer to the next structure in a structure chain. See also: XrFoveationEyeTrackedProfileCreateInfoMETA
• level must be a valid XrFoveationLevelFB value
• dynamic must be a valid XrFoveationDynamicFB value

Layout

 struct XrFoveationLevelProfileCreateInfoFB {
     XrStructureType type();
     void * next();
     XrFoveationLevelFB level();
     float verticalOffset();
     XrFoveationDynamicFB dynamic();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrFoveationLevelProfileCreateInfoFB.Buffer	An array of XrFoveationLevelProfileCreateInfoFB 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	DYNAMIC	The struct member offsets.
static final int	LEVEL	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.
static final int	VERTICALOFFSET	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
XrFoveationLevelProfileCreateInfoFB(ByteBuffer container)	Creates a XrFoveationLevelProfileCreateInfoFB instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrFoveationLevelProfileCreateInfoFB	calloc()	Returns a new XrFoveationLevelProfileCreateInfoFB instance allocated with memCalloc.
static XrFoveationLevelProfileCreateInfoFB.Buffer	calloc(int capacity)	Returns a new XrFoveationLevelProfileCreateInfoFB.Buffer instance allocated with memCalloc.
static XrFoveationLevelProfileCreateInfoFB.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrFoveationLevelProfileCreateInfoFB.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrFoveationLevelProfileCreateInfoFB	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrFoveationLevelProfileCreateInfoFB instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrFoveationLevelProfileCreateInfoFB	create()	Returns a new XrFoveationLevelProfileCreateInfoFB instance allocated with BufferUtils.
static XrFoveationLevelProfileCreateInfoFB.Buffer	create(int capacity)	Returns a new XrFoveationLevelProfileCreateInfoFB.Buffer instance allocated with BufferUtils.
static XrFoveationLevelProfileCreateInfoFB	create(long address)	Returns a new XrFoveationLevelProfileCreateInfoFB instance for the specified memory address.
static XrFoveationLevelProfileCreateInfoFB.Buffer	create(long address, int capacity)	Create a XrFoveationLevelProfileCreateInfoFB.Buffer instance at the specified memory.
static @Nullable XrFoveationLevelProfileCreateInfoFB	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrFoveationLevelProfileCreateInfoFB.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	dynamic()	the desired dynamic foveation setting.
XrFoveationLevelProfileCreateInfoFB	dynamic(int value)	Sets the specified value to the dynamic() field.
int	level()	the maximum desired foveation level.
XrFoveationLevelProfileCreateInfoFB	level(int value)	Sets the specified value to the level() field.
static XrFoveationLevelProfileCreateInfoFB	malloc()	Returns a new XrFoveationLevelProfileCreateInfoFB instance allocated with memAlloc.
static XrFoveationLevelProfileCreateInfoFB.Buffer	malloc(int capacity)	Returns a new XrFoveationLevelProfileCreateInfoFB.Buffer instance allocated with memAlloc.
static XrFoveationLevelProfileCreateInfoFB.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrFoveationLevelProfileCreateInfoFB.Buffer instance allocated on the specified MemoryStack.
static XrFoveationLevelProfileCreateInfoFB	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrFoveationLevelProfileCreateInfoFB instance allocated on the specified MemoryStack.
static int	ndynamic(long struct)	Unsafe version of dynamic().
static void	ndynamic(long struct, int value)	Unsafe version of dynamic.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrFoveationLevelProfileCreateInfoFB	next(long value)	Sets the specified value to the next() field.
XrFoveationLevelProfileCreateInfoFB	next(XrFoveationEyeTrackedProfileCreateInfoMETA value)	Prepends the specified XrFoveationEyeTrackedProfileCreateInfoMETA value to the next chain.
static int	nlevel(long struct)	Unsafe version of level().
static void	nlevel(long struct, int value)	Unsafe version of level.
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.
static float	nverticalOffset(long struct)	Unsafe version of verticalOffset().
static void	nverticalOffset(long struct, float value)	Unsafe version of verticalOffset.
XrFoveationLevelProfileCreateInfoFB	set(int type, long next, int level, float verticalOffset, int dynamic)	Initializes this struct with the specified values.
XrFoveationLevelProfileCreateInfoFB	set(XrFoveationLevelProfileCreateInfoFB src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrFoveationLevelProfileCreateInfoFB	type(int value)	Sets the specified value to the type() field.
XrFoveationLevelProfileCreateInfoFB	type$Default()	Sets the TYPE_FOVEATION_LEVEL_PROFILE_CREATE_INFO_FB value to the type() field.
float	verticalOffset()	the desired vertical offset in degrees for the center of the foveation pattern.
XrFoveationLevelProfileCreateInfoFB	verticalOffset(float value)	Sets the specified value to the verticalOffset() 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.

LEVEL

public static final int LEVEL

The struct member offsets.

VERTICALOFFSET

public static final int VERTICALOFFSET

The struct member offsets.

DYNAMIC

public static final int DYNAMIC

The struct member offsets.

Constructor Details

XrFoveationLevelProfileCreateInfoFB

public XrFoveationLevelProfileCreateInfoFB(ByteBuffer container)

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

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.

level

public int level()

the maximum desired foveation level.

verticalOffset

public float verticalOffset()

the desired vertical offset in degrees for the center of the foveation pattern.

dynamic

public int dynamic()

the desired dynamic foveation setting.

type

public XrFoveationLevelProfileCreateInfoFB type(int value)

Sets the specified value to the type() field.

type$Default

public XrFoveationLevelProfileCreateInfoFB type$Default()

Sets the TYPE_FOVEATION_LEVEL_PROFILE_CREATE_INFO_FB value to the type() field.

next

public XrFoveationLevelProfileCreateInfoFB next(long value)

Sets the specified value to the next() field.

next

public XrFoveationLevelProfileCreateInfoFB next(XrFoveationEyeTrackedProfileCreateInfoMETA value)

Prepends the specified XrFoveationEyeTrackedProfileCreateInfoMETA value to the next chain.

level

public XrFoveationLevelProfileCreateInfoFB level(int value)

Sets the specified value to the level() field.

verticalOffset

public XrFoveationLevelProfileCreateInfoFB verticalOffset(float value)

Sets the specified value to the verticalOffset() field.

dynamic

public XrFoveationLevelProfileCreateInfoFB dynamic(int value)

Sets the specified value to the dynamic() field.

set

public XrFoveationLevelProfileCreateInfoFB set(int type,
 long next,
 int level,
 float verticalOffset,
 int dynamic)

Initializes this struct with the specified values.

set

public XrFoveationLevelProfileCreateInfoFB set(XrFoveationLevelProfileCreateInfoFB src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrFoveationLevelProfileCreateInfoFB malloc()

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

calloc

public static XrFoveationLevelProfileCreateInfoFB calloc()

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

create

public static XrFoveationLevelProfileCreateInfoFB create()

Returns a new XrFoveationLevelProfileCreateInfoFB instance allocated with BufferUtils.

create

public static XrFoveationLevelProfileCreateInfoFB create(long address)

Returns a new XrFoveationLevelProfileCreateInfoFB instance for the specified memory address.

createSafe

public static @Nullable XrFoveationLevelProfileCreateInfoFB createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrFoveationLevelProfileCreateInfoFB.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrFoveationLevelProfileCreateInfoFB.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrFoveationLevelProfileCreateInfoFB.Buffer create(int capacity)

Returns a new XrFoveationLevelProfileCreateInfoFB.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrFoveationLevelProfileCreateInfoFB.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrFoveationLevelProfileCreateInfoFB instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nlevel

public static int nlevel(long struct)

Unsafe version of level().

nverticalOffset

public static float nverticalOffset(long struct)

Unsafe version of verticalOffset().

ndynamic

public static int ndynamic(long struct)

Unsafe version of dynamic().

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.

nlevel

public static void nlevel(long struct,
 int value)

Unsafe version of level.

nverticalOffset

public static void nverticalOffset(long struct,
 float value)

Unsafe version of verticalOffset.

ndynamic

public static void ndynamic(long struct,
 int value)

Unsafe version of dynamic.