Package org.lwjgl.openxr

Class XrFoveationCustomModeInfoHTC

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrFoveationCustomModeInfoHTC>

org.lwjgl.openxr.XrFoveationCustomModeInfoHTC

All Implemented Interfaces:

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

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

Configuration for custom mode.

Description

The application must chain an XrFoveationCustomModeInfoHTC structure to XrFoveationApplyInfoHTC to customize foveation if custom mode is set.

Valid Usage (Implicit)

• The XR_HTC_foveation extension must be enabled prior to using XrFoveationCustomModeInfoHTC
• type must be TYPE_FOVEATION_CUSTOM_MODE_INFO_HTC
• next must be NULL or a valid pointer to the next structure in a structure chain
• configs must be a pointer to an array of configCount valid XrFoveationConfigurationHTC structures
• The configCount parameter must be greater than 0

See Also

XrFoveationConfigurationHTC

Layout

 struct XrFoveationCustomModeInfoHTC {
     XrStructureType type();
     void const * next();
     uint32_t configCount();
     XrFoveationConfigurationHTC const * configs();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static XrFoveationCustomModeInfoHTC	calloc()	Returns a new XrFoveationCustomModeInfoHTC instance allocated with memCalloc.
static XrFoveationCustomModeInfoHTC.Buffer	calloc(int capacity)	Returns a new XrFoveationCustomModeInfoHTC.Buffer instance allocated with memCalloc.
static XrFoveationCustomModeInfoHTC.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrFoveationCustomModeInfoHTC.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrFoveationCustomModeInfoHTC	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrFoveationCustomModeInfoHTC instance allocated on the specified MemoryStack and initializes all its bits to zero.
int	configCount()	a uint32_t describing the count of elements in the configs array, which must be the number of views.
XrFoveationConfigurationHTC.Buffer	configs()	an array of XrFoveationConfigurationHTC structure contains the custom foveation settings for the corresponding views.
XrFoveationCustomModeInfoHTC	configs(XrFoveationConfigurationHTC.Buffer value)	Sets the address of the specified XrFoveationConfigurationHTC.Buffer to the configs() field.
static XrFoveationCustomModeInfoHTC	create()	Returns a new XrFoveationCustomModeInfoHTC instance allocated with BufferUtils.
static XrFoveationCustomModeInfoHTC.Buffer	create(int capacity)	Returns a new XrFoveationCustomModeInfoHTC.Buffer instance allocated with BufferUtils.
static XrFoveationCustomModeInfoHTC	create(long address)	Returns a new XrFoveationCustomModeInfoHTC instance for the specified memory address.
static XrFoveationCustomModeInfoHTC.Buffer	create(long address, int capacity)	Create a XrFoveationCustomModeInfoHTC.Buffer instance at the specified memory.
static @Nullable XrFoveationCustomModeInfoHTC	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrFoveationCustomModeInfoHTC.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrFoveationCustomModeInfoHTC	malloc()	Returns a new XrFoveationCustomModeInfoHTC instance allocated with memAlloc.
static XrFoveationCustomModeInfoHTC.Buffer	malloc(int capacity)	Returns a new XrFoveationCustomModeInfoHTC.Buffer instance allocated with memAlloc.
static XrFoveationCustomModeInfoHTC.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrFoveationCustomModeInfoHTC.Buffer instance allocated on the specified MemoryStack.
static XrFoveationCustomModeInfoHTC	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrFoveationCustomModeInfoHTC instance allocated on the specified MemoryStack.
static int	nconfigCount(long struct)	Unsafe version of configCount().
static void	nconfigCount(long struct, int value)	Sets the specified value to the configCount field of the specified struct.
static XrFoveationConfigurationHTC.Buffer	nconfigs(long struct)	Unsafe version of configs().
static void	nconfigs(long struct, XrFoveationConfigurationHTC.Buffer value)	Unsafe version of configs.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrFoveationCustomModeInfoHTC	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.
XrFoveationCustomModeInfoHTC	set(int type, long next, XrFoveationConfigurationHTC.Buffer configs)	Initializes this struct with the specified values.
XrFoveationCustomModeInfoHTC	set(XrFoveationCustomModeInfoHTC src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrFoveationCustomModeInfoHTC	type(int value)	Sets the specified value to the type() field.
XrFoveationCustomModeInfoHTC	type$Default()	Sets the TYPE_FOVEATION_CUSTOM_MODE_INFO_HTC 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.

CONFIGCOUNT

public static final int CONFIGCOUNT

The struct member offsets.

CONFIGS

public static final int CONFIGS

The struct member offsets.

Constructor Details

XrFoveationCustomModeInfoHTC

public XrFoveationCustomModeInfoHTC(ByteBuffer container)

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

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.

configCount

public int configCount()

a uint32_t describing the count of elements in the configs array, which must be the number of views.

configs

public XrFoveationConfigurationHTC.Buffer configs()

an array of XrFoveationConfigurationHTC structure contains the custom foveation settings for the corresponding views.

type

public XrFoveationCustomModeInfoHTC type(int value)

Sets the specified value to the type() field.

type$Default

public XrFoveationCustomModeInfoHTC type$Default()

Sets the TYPE_FOVEATION_CUSTOM_MODE_INFO_HTC value to the type() field.

next

public XrFoveationCustomModeInfoHTC next(long value)

Sets the specified value to the next() field.

configs

public XrFoveationCustomModeInfoHTC configs(XrFoveationConfigurationHTC.Buffer value)

Sets the address of the specified XrFoveationConfigurationHTC.Buffer to the configs() field.

set

public XrFoveationCustomModeInfoHTC set(int type,
 long next,
 XrFoveationConfigurationHTC.Buffer configs)

Initializes this struct with the specified values.

set

public XrFoveationCustomModeInfoHTC set(XrFoveationCustomModeInfoHTC src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrFoveationCustomModeInfoHTC malloc()

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

calloc

public static XrFoveationCustomModeInfoHTC calloc()

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

create

public static XrFoveationCustomModeInfoHTC create()

Returns a new XrFoveationCustomModeInfoHTC instance allocated with BufferUtils.

create

public static XrFoveationCustomModeInfoHTC create(long address)

Returns a new XrFoveationCustomModeInfoHTC instance for the specified memory address.

createSafe

public static @Nullable XrFoveationCustomModeInfoHTC createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrFoveationCustomModeInfoHTC.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrFoveationCustomModeInfoHTC.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrFoveationCustomModeInfoHTC.Buffer create(int capacity)

Returns a new XrFoveationCustomModeInfoHTC.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrFoveationCustomModeInfoHTC.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrFoveationCustomModeInfoHTC instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nconfigCount

public static int nconfigCount(long struct)

Unsafe version of configCount().

nconfigs

public static XrFoveationConfigurationHTC.Buffer nconfigs(long struct)

Unsafe version of configs().

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.

nconfigCount

public static void nconfigCount(long struct,
 int value)

Sets the specified value to the configCount field of the specified struct.

nconfigs

public static void nconfigs(long struct,
 XrFoveationConfigurationHTC.Buffer value)

Unsafe version of configs.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate