Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrFoveationApplyInfoHTC

extends Struct<XrFoveationApplyInfoHTC>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Information for foveation applying.
Description

The application should set the following configurations in XrFoveationApplyInfoHTC:

The faceCount of XrSwapchain 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)
See Also

XrSwapchainSubImage, ApplyFoveationHTC

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
MODE

The struct member offsets.

public static final int
NEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
SUBIMAGECOUNT

The struct member offsets.

public static final int
SUBIMAGES

The struct member offsets.

public static final int
TYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
XrFoveationApplyInfoHTC(long address, ByteBuffer container)

public
XrFoveationApplyInfoHTC(ByteBuffer container)

Creates a XrFoveationApplyInfoHTC instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static XrFoveationApplyInfoHTC
calloc()

Returns a new XrFoveationApplyInfoHTC instance allocated with memCalloc.

public static XrFoveationApplyInfoHTC.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new XrFoveationApplyInfoHTC.Buffer instance allocated with memCalloc.

public static XrFoveationApplyInfoHTC
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static XrFoveationApplyInfoHTC.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

protected XrFoveationApplyInfoHTC
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static XrFoveationApplyInfoHTC
create()

Returns a new XrFoveationApplyInfoHTC instance allocated with BufferUtils.

public static XrFoveationApplyInfoHTC
create(long address)

Returns a new XrFoveationApplyInfoHTC instance for the specified memory address.

public static XrFoveationApplyInfoHTC.Buffer
create(int
the buffer capacity
capacity
)

Returns a new XrFoveationApplyInfoHTC.Buffer instance allocated with BufferUtils.

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

Create a XrFoveationApplyInfoHTC.Buffer instance at the specified memory.

public static XrFoveationApplyInfoHTC
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static XrFoveationApplyInfoHTC
malloc()

Returns a new XrFoveationApplyInfoHTC instance allocated with memAlloc.

public static XrFoveationApplyInfoHTC.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new XrFoveationApplyInfoHTC.Buffer instance allocated with memAlloc.

public static XrFoveationApplyInfoHTC
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new XrFoveationApplyInfoHTC instance allocated on the specified MemoryStack.

public static XrFoveationApplyInfoHTC.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public int
mode()

an XrFoveationModeHTC enum describing the foveation mode.

public XrFoveationApplyInfoHTC
mode(int value)

Sets the specified value to the mode field.

public long
next()

NULL or a pointer to the next structure in a structure chain.

public XrFoveationApplyInfoHTC
next(long value)

Sets the specified value to the next field.

public XrFoveationApplyInfoHTC
next(XrFoveationCustomModeInfoHTC value)

Prepends the specified XrFoveationCustomModeInfoHTC value to the next chain.

public XrFoveationApplyInfoHTC
next(XrFoveationDynamicModeInfoHTC value)

Prepends the specified XrFoveationDynamicModeInfoHTC value to the next chain.

public static int
nmode(long struct)

Unsafe version of mode.

public static void
nmode(long struct, int value)

Unsafe version of mode.

public static long
nnext(long struct)

Unsafe version of next.

public static void
nnext(long struct, long value)

Unsafe version of next.

public static int
nsubImageCount(long struct)

Unsafe version of subImageCount.

public static void
nsubImageCount(long struct, int value)

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

public static XrSwapchainSubImage.Buffer
nsubImages(long struct)

Unsafe version of subImages.

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

Unsafe version of subImages.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

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

Initializes this struct with the specified values.

public XrFoveationApplyInfoHTC

Returns:

this struct
set
(XrFoveationApplyInfoHTC
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
subImageCount()

the count of subImages in the subImages array.

public XrSwapchainSubImage.Buffer
subImages()

an array of XrSwapchainSubImage to apply foveated rendering.

public XrFoveationApplyInfoHTC
subImages(XrSwapchainSubImage.Buffer value)

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

public int
type()

the XrStructureType of this structure.

public XrFoveationApplyInfoHTC
type(int value)

Sets the specified value to the type field.

public XrFoveationApplyInfoHTC
type$Default()

Sets the TYPE_FOVEATION_APPLY_INFO_HTC value to the type field.

public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

MODEback to summary
public static final int MODE

The struct member offsets.

NEXTback to summary
public static final int NEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

SUBIMAGECOUNTback to summary
public static final int SUBIMAGECOUNT

The struct member offsets.

SUBIMAGESback to summary
public static final int SUBIMAGES

The struct member offsets.

TYPEback to summary
public static final int TYPE

The struct member offsets.

Constructor Detail

XrFoveationApplyInfoHTCback to summary
protected XrFoveationApplyInfoHTC(long address, ByteBuffer container)
XrFoveationApplyInfoHTCback to summary
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 Detail

callocback to summary
public static XrFoveationApplyInfoHTC calloc()

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

callocback to summary
public static XrFoveationApplyInfoHTC.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrFoveationApplyInfoHTC calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static XrFoveationApplyInfoHTC.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

createback to summary
protected XrFoveationApplyInfoHTC create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static XrFoveationApplyInfoHTC create()

Returns a new XrFoveationApplyInfoHTC instance allocated with BufferUtils.

createback to summary
public static XrFoveationApplyInfoHTC create(long address)

Returns a new XrFoveationApplyInfoHTC instance for the specified memory address.

createback to summary
public static XrFoveationApplyInfoHTC.Buffer create(int capacity)

Returns a new XrFoveationApplyInfoHTC.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrFoveationApplyInfoHTC.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrFoveationApplyInfoHTC createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static XrFoveationApplyInfoHTC.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static XrFoveationApplyInfoHTC malloc()

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

mallocback to summary
public static XrFoveationApplyInfoHTC.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrFoveationApplyInfoHTC malloc(MemoryStack stack)

Returns a new XrFoveationApplyInfoHTC instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static XrFoveationApplyInfoHTC.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

modeback to summary
public int mode()

an XrFoveationModeHTC enum describing the foveation mode.

Annotations
@NativeType:XrFoveationModeHTC
modeback to summary
public XrFoveationApplyInfoHTC mode(int value)

Sets the specified value to the mode field.

nextback to summary
public long next()

NULL or a pointer to the next structure in a structure chain.

Annotations
@NativeType:void const *
nextback to summary
public XrFoveationApplyInfoHTC next(long value)

Sets the specified value to the next field.

nextback to summary
public XrFoveationApplyInfoHTC next(XrFoveationCustomModeInfoHTC value)

Prepends the specified XrFoveationCustomModeInfoHTC value to the next chain.

nextback to summary
public XrFoveationApplyInfoHTC next(XrFoveationDynamicModeInfoHTC value)

Prepends the specified XrFoveationDynamicModeInfoHTC value to the next chain.

nmodeback to summary
public static int nmode(long struct)

Unsafe version of mode.

nmodeback to summary
public static void nmode(long struct, int value)

Unsafe version of mode.

nnextback to summary
public static long nnext(long struct)

Unsafe version of next.

nnextback to summary
public static void nnext(long struct, long value)

Unsafe version of next.

nsubImageCountback to summary
public static int nsubImageCount(long struct)

Unsafe version of subImageCount.

nsubImageCountback to summary
public static void nsubImageCount(long struct, int value)

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

nsubImagesback to summary
public static XrSwapchainSubImage.Buffer nsubImages(long struct)

Unsafe version of subImages.

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

Unsafe version of subImages.

ntypeback to summary
public static int ntype(long struct)

Unsafe version of type.

ntypeback to summary
public static void ntype(long struct, int value)

Unsafe version of type.

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

Initializes this struct with the specified values.

setback to summary
public XrFoveationApplyInfoHTC set(XrFoveationApplyInfoHTC src)

Copies the specified struct data to this struct.

Parameters
src:XrFoveationApplyInfoHTC

the source struct

Returns:XrFoveationApplyInfoHTC

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
subImageCountback to summary
public int subImageCount()

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

Annotations
@NativeType:uint32_t
subImagesback to summary
public XrSwapchainSubImage.Buffer subImages()

an array of XrSwapchainSubImage to apply foveated rendering.

Annotations
@NativeType:XrSwapchainSubImage *
subImagesback to summary
public XrFoveationApplyInfoHTC subImages(XrSwapchainSubImage.Buffer value)

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

typeback to summary
public int type()

the XrStructureType of this structure.

Annotations
@NativeType:XrStructureType
typeback to summary
public XrFoveationApplyInfoHTC type(int value)

Sets the specified value to the type field.

type$Defaultback to summary
public XrFoveationApplyInfoHTC type$Default()

Sets the TYPE_FOVEATION_APPLY_INFO_HTC value to the type field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.openxr back to summary

public Class XrFoveationApplyInfoHTC.Buffer

extends StructBuffer<XrFoveationApplyInfoHTC, XrFoveationApplyInfoHTC.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of XrFoveationApplyInfoHTC structs.

Field Summary

Modifier and TypeField and Description
private static final XrFoveationApplyInfoHTC

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrFoveationApplyInfoHTC.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
protected XrFoveationApplyInfoHTC
public int

Returns:

the value of the XrFoveationApplyInfoHTC#mode field.
mode
()

public XrFoveationApplyInfoHTC.Buffer
mode(int value)

Sets the specified value to the XrFoveationApplyInfoHTC#mode field.

public long

Returns:

the value of the XrFoveationApplyInfoHTC#next field.
next
()

public XrFoveationApplyInfoHTC.Buffer
next(long value)

Sets the specified value to the XrFoveationApplyInfoHTC#next field.

public XrFoveationApplyInfoHTC.Buffer
next(XrFoveationCustomModeInfoHTC value)

Prepends the specified XrFoveationCustomModeInfoHTC value to the next chain.

public XrFoveationApplyInfoHTC.Buffer
next(XrFoveationDynamicModeInfoHTC value)

Prepends the specified XrFoveationDynamicModeInfoHTC value to the next chain.

protected XrFoveationApplyInfoHTC.Buffer
public int

Returns:

the value of the XrFoveationApplyInfoHTC#subImageCount field.
subImageCount
()

public XrSwapchainSubImage.Buffer

Returns:

a XrSwapchainSubImage.Buffer view of the struct array pointed to by the XrFoveationApplyInfoHTC#subImages field.
subImages
()

public XrFoveationApplyInfoHTC.Buffer
public int

Returns:

the value of the XrFoveationApplyInfoHTC#type field.
type
()

public XrFoveationApplyInfoHTC.Buffer
type(int value)

Sets the specified value to the XrFoveationApplyInfoHTC#type field.

public XrFoveationApplyInfoHTC.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XrFoveationApplyInfoHTC ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new XrFoveationApplyInfoHTC.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by XrFoveationApplyInfoHTC#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactoryback to summary
protected XrFoveationApplyInfoHTC getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
modeback to summary
public int mode()
Returns:int

the value of the XrFoveationApplyInfoHTC#mode field.

Annotations
@NativeType:XrFoveationModeHTC
modeback to summary
public XrFoveationApplyInfoHTC.Buffer mode(int value)

Sets the specified value to the XrFoveationApplyInfoHTC#mode field.

nextback to summary
public long next()
Returns:long

the value of the XrFoveationApplyInfoHTC#next field.

Annotations
@NativeType:void const *
nextback to summary
public XrFoveationApplyInfoHTC.Buffer next(long value)

Sets the specified value to the XrFoveationApplyInfoHTC#next field.

nextback to summary
public XrFoveationApplyInfoHTC.Buffer next(XrFoveationCustomModeInfoHTC value)

Prepends the specified XrFoveationCustomModeInfoHTC value to the next chain.

nextback to summary
public XrFoveationApplyInfoHTC.Buffer next(XrFoveationDynamicModeInfoHTC value)

Prepends the specified XrFoveationDynamicModeInfoHTC value to the next chain.

selfback to summary
protected XrFoveationApplyInfoHTC.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
subImageCountback to summary
public int subImageCount()
Returns:int

the value of the XrFoveationApplyInfoHTC#subImageCount field.

Annotations
@NativeType:uint32_t
subImagesback to summary
public XrSwapchainSubImage.Buffer subImages()
Returns:XrSwapchainSubImage.Buffer

a XrSwapchainSubImage.Buffer view of the struct array pointed to by the XrFoveationApplyInfoHTC#subImages field.

Annotations
@NativeType:XrSwapchainSubImage *
subImagesback to summary
public XrFoveationApplyInfoHTC.Buffer subImages(XrSwapchainSubImage.Buffer value)

Sets the address of the specified XrSwapchainSubImage.Buffer to the XrFoveationApplyInfoHTC#subImages field.

typeback to summary
public int type()
Returns:int

the value of the XrFoveationApplyInfoHTC#type field.

Annotations
@NativeType:XrStructureType
typeback to summary
public XrFoveationApplyInfoHTC.Buffer type(int value)

Sets the specified value to the XrFoveationApplyInfoHTC#type field.

type$Defaultback to summary
public XrFoveationApplyInfoHTC.Buffer type$Default()

Sets the TYPE_FOVEATION_APPLY_INFO_HTC value to the XrFoveationApplyInfoHTC#type field.