Package org.lwjgl.openxr

Class XrFoveationApplyInfoHTC

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrFoveationApplyInfoHTC>

org.lwjgl.openxr.XrFoveationApplyInfoHTC

All Implemented Interfaces:

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

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

Information for foveation applying.

Description

The application should set the following configurations in XrFoveationApplyInfoHTC:

• The foveation mode to be applied.
• The specified XrSwapchainSubImage to the corresponding view.

The XrSwapchain::faceCount of the swapchain in XrSwapchainSubImage must be 1 since this extension does not support cubemaps.

If mode is FOVEATION_MODE_DYNAMIC_HTC, the next chain for this structure must include XrFoveationDynamicModeInfoHTC structure.

If mode is FOVEATION_MODE_CUSTOM_HTC, the next chain for this structure must include XrFoveationCustomModeInfoHTC structure.

The order of subImages must be the same order as in XrCompositionLayerProjectionView when submitted in EndFrame.

Valid Usage (Implicit)

• The XR_HTC_foveation extension must be enabled prior to using XrFoveationApplyInfoHTC
• type must be TYPE_FOVEATION_APPLY_INFO_HTC
• next must be NULL or a valid pointer to the next structure in a structure chain. See also: XrFoveationCustomModeInfoHTC, XrFoveationDynamicModeInfoHTC
• mode must be a valid XrFoveationModeHTC value
• subImages must be a pointer to an array of subImageCount XrSwapchainSubImage structures
• The subImageCount parameter must be greater than 0

See Also

XrSwapchainSubImage, ApplyFoveationHTC

Layout

 struct XrFoveationApplyInfoHTC {
     XrStructureType type();
     void const * next();
     XrFoveationModeHTC mode();
     uint32_t subImageCount();
     XrSwapchainSubImage * subImages();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrFoveationApplyInfoHTC.Buffer	An array of XrFoveationApplyInfoHTC 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	MODE	The struct member offsets.
static final int	NEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	SUBIMAGECOUNT	The struct member offsets.
static final int	SUBIMAGES	The struct member offsets.
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
XrFoveationApplyInfoHTC(ByteBuffer container)	Creates a XrFoveationApplyInfoHTC instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrFoveationApplyInfoHTC	calloc()	Returns a new XrFoveationApplyInfoHTC instance allocated with memCalloc.
static XrFoveationApplyInfoHTC.Buffer	calloc(int capacity)	Returns a new XrFoveationApplyInfoHTC.Buffer instance allocated with memCalloc.
static XrFoveationApplyInfoHTC.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrFoveationApplyInfoHTC.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrFoveationApplyInfoHTC	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrFoveationApplyInfoHTC instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrFoveationApplyInfoHTC	create()	Returns a new XrFoveationApplyInfoHTC instance allocated with BufferUtils.
static XrFoveationApplyInfoHTC.Buffer	create(int capacity)	Returns a new XrFoveationApplyInfoHTC.Buffer instance allocated with BufferUtils.
static XrFoveationApplyInfoHTC	create(long address)	Returns a new XrFoveationApplyInfoHTC instance for the specified memory address.
static XrFoveationApplyInfoHTC.Buffer	create(long address, int capacity)	Create a XrFoveationApplyInfoHTC.Buffer instance at the specified memory.
static @Nullable XrFoveationApplyInfoHTC	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrFoveationApplyInfoHTC.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrFoveationApplyInfoHTC	malloc()	Returns a new XrFoveationApplyInfoHTC instance allocated with memAlloc.
static XrFoveationApplyInfoHTC.Buffer	malloc(int capacity)	Returns a new XrFoveationApplyInfoHTC.Buffer instance allocated with memAlloc.
static XrFoveationApplyInfoHTC.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrFoveationApplyInfoHTC.Buffer instance allocated on the specified MemoryStack.
static XrFoveationApplyInfoHTC	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrFoveationApplyInfoHTC instance allocated on the specified MemoryStack.
int	mode()	an XrFoveationModeHTC enum describing the foveation mode.
XrFoveationApplyInfoHTC	mode(int value)	Sets the specified value to the mode() field.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrFoveationApplyInfoHTC	next(long value)	Sets the specified value to the next() field.
XrFoveationApplyInfoHTC	next(XrFoveationCustomModeInfoHTC value)	Prepends the specified XrFoveationCustomModeInfoHTC value to the next chain.
XrFoveationApplyInfoHTC	next(XrFoveationDynamicModeInfoHTC value)	Prepends the specified XrFoveationDynamicModeInfoHTC value to the next chain.
static int	nmode(long struct)	Unsafe version of mode().
static void	nmode(long struct, int value)	Unsafe version of mode.
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static int	nsubImageCount(long struct)	Unsafe version of subImageCount().
static void	nsubImageCount(long struct, int value)	Sets the specified value to the subImageCount field of the specified struct.
static XrSwapchainSubImage.Buffer	nsubImages(long struct)	Unsafe version of subImages().
static void	nsubImages(long struct, XrSwapchainSubImage.Buffer value)	Unsafe version of subImages.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
XrFoveationApplyInfoHTC	set(int type, long next, int mode, XrSwapchainSubImage.Buffer subImages)	Initializes this struct with the specified values.
XrFoveationApplyInfoHTC	set(XrFoveationApplyInfoHTC src)	Copies the specified struct data to this struct.
int	sizeof()
int	subImageCount()	the count of subImages in the subImages array.
XrSwapchainSubImage.Buffer	subImages()	an array of XrSwapchainSubImage to apply foveated rendering.
XrFoveationApplyInfoHTC	subImages(XrSwapchainSubImage.Buffer value)	Sets the address of the specified XrSwapchainSubImage.Buffer to the subImages() field.
int	type()	the XrStructureType of this structure.
XrFoveationApplyInfoHTC	type(int value)	Sets the specified value to the type() field.
XrFoveationApplyInfoHTC	type$Default()	Sets the TYPE_FOVEATION_APPLY_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.

MODE

public static final int MODE

The struct member offsets.

SUBIMAGECOUNT

public static final int SUBIMAGECOUNT

The struct member offsets.

SUBIMAGES

public static final int SUBIMAGES

The struct member offsets.

Constructor Details

XrFoveationApplyInfoHTC

public XrFoveationApplyInfoHTC(ByteBuffer container)

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

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.

mode

public int mode()

an XrFoveationModeHTC enum describing the foveation mode.

subImageCount

public int subImageCount()

the count of subImages in the subImages array. This must be equal to the number of view poses returned by LocateViews.

subImages

public XrSwapchainSubImage.Buffer subImages()

an array of XrSwapchainSubImage to apply foveated rendering.

type

public XrFoveationApplyInfoHTC type(int value)

Sets the specified value to the type() field.

type$Default

public XrFoveationApplyInfoHTC type$Default()

Sets the TYPE_FOVEATION_APPLY_INFO_HTC value to the type() field.

next

public XrFoveationApplyInfoHTC next(long value)

Sets the specified value to the next() field.

next

public XrFoveationApplyInfoHTC next(XrFoveationCustomModeInfoHTC value)

Prepends the specified XrFoveationCustomModeInfoHTC value to the next chain.

next

public XrFoveationApplyInfoHTC next(XrFoveationDynamicModeInfoHTC value)

Prepends the specified XrFoveationDynamicModeInfoHTC value to the next chain.

mode

public XrFoveationApplyInfoHTC mode(int value)

Sets the specified value to the mode() field.

subImages

public XrFoveationApplyInfoHTC subImages(XrSwapchainSubImage.Buffer value)

Sets the address of the specified XrSwapchainSubImage.Buffer to the subImages() field.

set

public XrFoveationApplyInfoHTC set(int type,
 long next,
 int mode,
 XrSwapchainSubImage.Buffer subImages)

Initializes this struct with the specified values.

set

public XrFoveationApplyInfoHTC set(XrFoveationApplyInfoHTC src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrFoveationApplyInfoHTC malloc()

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

calloc

public static XrFoveationApplyInfoHTC calloc()

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

create

public static XrFoveationApplyInfoHTC create()

Returns a new XrFoveationApplyInfoHTC instance allocated with BufferUtils.

create

public static XrFoveationApplyInfoHTC create(long address)

Returns a new XrFoveationApplyInfoHTC instance for the specified memory address.

createSafe

public static @Nullable XrFoveationApplyInfoHTC createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrFoveationApplyInfoHTC.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrFoveationApplyInfoHTC.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrFoveationApplyInfoHTC.Buffer create(int capacity)

Returns a new XrFoveationApplyInfoHTC.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrFoveationApplyInfoHTC.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrFoveationApplyInfoHTC instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nmode

public static int nmode(long struct)

Unsafe version of mode().

nsubImageCount

public static int nsubImageCount(long struct)

Unsafe version of subImageCount().

nsubImages

public static XrSwapchainSubImage.Buffer nsubImages(long struct)

Unsafe version of subImages().

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.

nmode

public static void nmode(long struct,
 int value)

Unsafe version of mode.

nsubImageCount

public static void nsubImageCount(long struct,
 int value)

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

nsubImages

public static void nsubImages(long struct,
 XrSwapchainSubImage.Buffer value)

Unsafe version of subImages.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate