Package org.lwjgl.openxr

Class XrFoveationConfigurationHTC

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrFoveationConfigurationHTC>

org.lwjgl.openxr.XrFoveationConfigurationHTC

All Implemented Interfaces:

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

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

Configuration of foveation.

Valid Usage (Implicit)

• The XR_HTC_foveation extension must be enabled prior to using XrFoveationConfigurationHTC
• level must be a valid XrFoveationLevelHTC value

See Also

XrFoveationCustomModeInfoHTC, XrVector2f

Layout

 struct XrFoveationConfigurationHTC {
     XrFoveationLevelHTC level();
     float clearFovDegree();
     XrVector2f focalCenterOffset();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrFoveationConfigurationHTC.Buffer	An array of XrFoveationConfigurationHTC 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	CLEARFOVDEGREE	The struct member offsets.
static final int	FOCALCENTEROFFSET	The struct member offsets.
static final int	LEVEL	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
XrFoveationConfigurationHTC(ByteBuffer container)	Creates a XrFoveationConfigurationHTC instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrFoveationConfigurationHTC	calloc()	Returns a new XrFoveationConfigurationHTC instance allocated with memCalloc.
static XrFoveationConfigurationHTC.Buffer	calloc(int capacity)	Returns a new XrFoveationConfigurationHTC.Buffer instance allocated with memCalloc.
static XrFoveationConfigurationHTC.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrFoveationConfigurationHTC.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrFoveationConfigurationHTC	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrFoveationConfigurationHTC instance allocated on the specified MemoryStack and initializes all its bits to zero.
float	clearFovDegree()	the value indicating the total horizontal and vertical field angle with the original pixel density level.
XrFoveationConfigurationHTC	clearFovDegree(float value)	Sets the specified value to the clearFovDegree() field.
static XrFoveationConfigurationHTC	create()	Returns a new XrFoveationConfigurationHTC instance allocated with BufferUtils.
static XrFoveationConfigurationHTC.Buffer	create(int capacity)	Returns a new XrFoveationConfigurationHTC.Buffer instance allocated with BufferUtils.
static XrFoveationConfigurationHTC	create(long address)	Returns a new XrFoveationConfigurationHTC instance for the specified memory address.
static XrFoveationConfigurationHTC.Buffer	create(long address, int capacity)	Create a XrFoveationConfigurationHTC.Buffer instance at the specified memory.
static @Nullable XrFoveationConfigurationHTC	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrFoveationConfigurationHTC.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
XrVector2f	focalCenterOffset()	the desired center offset of the field of view in NDC(normalized device coordinates) space.
XrFoveationConfigurationHTC	focalCenterOffset(Consumer<XrVector2f> consumer)	Passes the focalCenterOffset() field to the specified Consumer.
XrFoveationConfigurationHTC	focalCenterOffset(XrVector2f value)	Copies the specified XrVector2f to the focalCenterOffset() field.
int	level()	the pixel density drop level of periphery area specified by XrFoveationLevelHTC .
XrFoveationConfigurationHTC	level(int value)	Sets the specified value to the level() field.
static XrFoveationConfigurationHTC	malloc()	Returns a new XrFoveationConfigurationHTC instance allocated with memAlloc.
static XrFoveationConfigurationHTC.Buffer	malloc(int capacity)	Returns a new XrFoveationConfigurationHTC.Buffer instance allocated with memAlloc.
static XrFoveationConfigurationHTC.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrFoveationConfigurationHTC.Buffer instance allocated on the specified MemoryStack.
static XrFoveationConfigurationHTC	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrFoveationConfigurationHTC instance allocated on the specified MemoryStack.
static float	nclearFovDegree(long struct)	Unsafe version of clearFovDegree().
static void	nclearFovDegree(long struct, float value)	Unsafe version of clearFovDegree.
static XrVector2f	nfocalCenterOffset(long struct)	Unsafe version of focalCenterOffset().
static void	nfocalCenterOffset(long struct, XrVector2f value)	Unsafe version of focalCenterOffset.
static int	nlevel(long struct)	Unsafe version of level().
static void	nlevel(long struct, int value)	Unsafe version of level.
XrFoveationConfigurationHTC	set(int level, float clearFovDegree, XrVector2f focalCenterOffset)	Initializes this struct with the specified values.
XrFoveationConfigurationHTC	set(XrFoveationConfigurationHTC src)	Copies the specified struct data to this struct.
int	sizeof()

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.

LEVEL

public static final int LEVEL

The struct member offsets.

CLEARFOVDEGREE

public static final int CLEARFOVDEGREE

The struct member offsets.

FOCALCENTEROFFSET

public static final int FOCALCENTEROFFSET

The struct member offsets.

Constructor Details

XrFoveationConfigurationHTC

public XrFoveationConfigurationHTC(ByteBuffer container)

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

level

public int level()

the pixel density drop level of periphery area specified by XrFoveationLevelHTC .

clearFovDegree

public float clearFovDegree()

the value indicating the total horizontal and vertical field angle with the original pixel density level. clearFovDegree must be specified in degree, and must be in the range [0, 180].

focalCenterOffset

public XrVector2f focalCenterOffset()

the desired center offset of the field of view in NDC(normalized device coordinates) space. The x and y of focalCenterOffset must be in the range [-1, 1].

level

public XrFoveationConfigurationHTC level(int value)

Sets the specified value to the level() field.

clearFovDegree

public XrFoveationConfigurationHTC clearFovDegree(float value)

Sets the specified value to the clearFovDegree() field.

focalCenterOffset

public XrFoveationConfigurationHTC focalCenterOffset(XrVector2f value)

Copies the specified XrVector2f to the focalCenterOffset() field.

focalCenterOffset

public XrFoveationConfigurationHTC focalCenterOffset(Consumer<XrVector2f> consumer)

Passes the focalCenterOffset() field to the specified Consumer.

set

public XrFoveationConfigurationHTC set(int level,
 float clearFovDegree,
 XrVector2f focalCenterOffset)

Initializes this struct with the specified values.

set

public XrFoveationConfigurationHTC set(XrFoveationConfigurationHTC src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrFoveationConfigurationHTC malloc()

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

calloc

public static XrFoveationConfigurationHTC calloc()

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

create

public static XrFoveationConfigurationHTC create()

Returns a new XrFoveationConfigurationHTC instance allocated with BufferUtils.

create

public static XrFoveationConfigurationHTC create(long address)

Returns a new XrFoveationConfigurationHTC instance for the specified memory address.

createSafe

public static @Nullable XrFoveationConfigurationHTC createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrFoveationConfigurationHTC.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrFoveationConfigurationHTC.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrFoveationConfigurationHTC.Buffer create(int capacity)

Returns a new XrFoveationConfigurationHTC.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrFoveationConfigurationHTC.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrFoveationConfigurationHTC instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nlevel

public static int nlevel(long struct)

Unsafe version of level().

nclearFovDegree

public static float nclearFovDegree(long struct)

Unsafe version of clearFovDegree().

nfocalCenterOffset

public static XrVector2f nfocalCenterOffset(long struct)

Unsafe version of focalCenterOffset().

nlevel

public static void nlevel(long struct,
 int value)

Unsafe version of level.

nclearFovDegree

public static void nclearFovDegree(long struct,
 float value)

Unsafe version of clearFovDegree.

nfocalCenterOffset

public static void nfocalCenterOffset(long struct,
 XrVector2f value)

Unsafe version of focalCenterOffset.