Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrFoveationCustomModeInfoHTC

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

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)
See Also

XrFoveationConfigurationHTC

Layout


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

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
CONFIGCOUNT

The struct member offsets.

public static final int
CONFIGS

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
TYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
XrFoveationCustomModeInfoHTC(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrFoveationCustomModeInfoHTC
calloc()

Returns a new XrFoveationCustomModeInfoHTC instance allocated with memCalloc.

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

Returns a new XrFoveationCustomModeInfoHTC.Buffer instance allocated with memCalloc.

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

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

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

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

public int
configCount()

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

public XrFoveationConfigurationHTC.Buffer
configs()

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

public XrFoveationCustomModeInfoHTC
configs(XrFoveationConfigurationHTC.Buffer value)

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

protected XrFoveationCustomModeInfoHTC
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 XrFoveationCustomModeInfoHTC
create()

Returns a new XrFoveationCustomModeInfoHTC instance allocated with BufferUtils.

public static XrFoveationCustomModeInfoHTC
create(long address)

Returns a new XrFoveationCustomModeInfoHTC instance for the specified memory address.

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

Returns a new XrFoveationCustomModeInfoHTC.Buffer instance allocated with BufferUtils.

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

Create a XrFoveationCustomModeInfoHTC.Buffer instance at the specified memory.

public static XrFoveationCustomModeInfoHTC
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static XrFoveationCustomModeInfoHTC
malloc()

Returns a new XrFoveationCustomModeInfoHTC instance allocated with memAlloc.

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

Returns a new XrFoveationCustomModeInfoHTC.Buffer instance allocated with memAlloc.

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

Returns a new XrFoveationCustomModeInfoHTC instance allocated on the specified MemoryStack.

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

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

public static int
nconfigCount(long struct)

Unsafe version of configCount.

public static void
nconfigCount(long struct, int value)

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

public static XrFoveationConfigurationHTC.Buffer
nconfigs(long struct)

Unsafe version of configs.

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

Unsafe version of configs.

public long
next()

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

public XrFoveationCustomModeInfoHTC
next(long value)

Sets the specified value to the next field.

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
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

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

Initializes this struct with the specified values.

public XrFoveationCustomModeInfoHTC

Returns:

this struct
set
(XrFoveationCustomModeInfoHTC
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
type()

the XrStructureType of this structure.

public XrFoveationCustomModeInfoHTC
type(int value)

Sets the specified value to the type field.

public XrFoveationCustomModeInfoHTC
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.

CONFIGCOUNTback to summary
public static final int CONFIGCOUNT

The struct member offsets.

CONFIGSback to summary
public static final int CONFIGS

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.

TYPEback to summary
public static final int TYPE

The struct member offsets.

Constructor Detail

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

callocback to summary
public static XrFoveationCustomModeInfoHTC calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrFoveationCustomModeInfoHTC calloc(MemoryStack stack)

Returns a new XrFoveationCustomModeInfoHTC 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 XrFoveationCustomModeInfoHTC.Buffer calloc(int capacity, MemoryStack stack)

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

configCountback to summary
public int configCount()

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

Annotations
@NativeType:uint32_t
configsback to summary
public XrFoveationConfigurationHTC.Buffer configs()

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

Annotations
@NativeType:XrFoveationConfigurationHTC const *
configsback to summary
public XrFoveationCustomModeInfoHTC configs(XrFoveationConfigurationHTC.Buffer value)

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

createback to summary
protected XrFoveationCustomModeInfoHTC 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 XrFoveationCustomModeInfoHTC create()

Returns a new XrFoveationCustomModeInfoHTC instance allocated with BufferUtils.

createback to summary
public static XrFoveationCustomModeInfoHTC create(long address)

Returns a new XrFoveationCustomModeInfoHTC instance for the specified memory address.

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

Returns a new XrFoveationCustomModeInfoHTC.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrFoveationCustomModeInfoHTC.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrFoveationCustomModeInfoHTC createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrFoveationCustomModeInfoHTC malloc(MemoryStack stack)

Returns a new XrFoveationCustomModeInfoHTC instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nconfigCountback to summary
public static int nconfigCount(long struct)

Unsafe version of configCount.

nconfigCountback to summary
public static void nconfigCount(long struct, int value)

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

nconfigsback to summary
public static XrFoveationConfigurationHTC.Buffer nconfigs(long struct)

Unsafe version of configs.

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

Unsafe version of configs.

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 XrFoveationCustomModeInfoHTC next(long value)

Sets the specified value to the next field.

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.

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 XrFoveationCustomModeInfoHTC set(int type, long next, XrFoveationConfigurationHTC.Buffer configs)

Initializes this struct with the specified values.

setback to summary
public XrFoveationCustomModeInfoHTC set(XrFoveationCustomModeInfoHTC src)

Copies the specified struct data to this struct.

Parameters
src:XrFoveationCustomModeInfoHTC

the source struct

Returns:XrFoveationCustomModeInfoHTC

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
typeback to summary
public int type()

the XrStructureType of this structure.

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

Sets the specified value to the type field.

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

Sets the TYPE_FOVEATION_CUSTOM_MODE_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 XrFoveationCustomModeInfoHTC.Buffer

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

An array of XrFoveationCustomModeInfoHTC structs.

Field Summary

Modifier and TypeField and Description
private static final XrFoveationCustomModeInfoHTC

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrFoveationCustomModeInfoHTC.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
public int

Returns:

the value of the XrFoveationCustomModeInfoHTC#configCount field.
configCount
()

public XrFoveationConfigurationHTC.Buffer

Returns:

a XrFoveationConfigurationHTC.Buffer view of the struct array pointed to by the XrFoveationCustomModeInfoHTC#configs field.
configs
()

public XrFoveationCustomModeInfoHTC.Buffer
protected XrFoveationCustomModeInfoHTC
public long

Returns:

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

public XrFoveationCustomModeInfoHTC.Buffer
next(long value)

Sets the specified value to the XrFoveationCustomModeInfoHTC#next field.

protected XrFoveationCustomModeInfoHTC.Buffer
public int

Returns:

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

public XrFoveationCustomModeInfoHTC.Buffer
type(int value)

Sets the specified value to the XrFoveationCustomModeInfoHTC#type field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final XrFoveationCustomModeInfoHTC ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new XrFoveationCustomModeInfoHTC.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 XrFoveationCustomModeInfoHTC#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

configCountback to summary
public int configCount()
Returns:int

the value of the XrFoveationCustomModeInfoHTC#configCount field.

Annotations
@NativeType:uint32_t
configsback to summary
public XrFoveationConfigurationHTC.Buffer configs()
Returns:XrFoveationConfigurationHTC.Buffer

a XrFoveationConfigurationHTC.Buffer view of the struct array pointed to by the XrFoveationCustomModeInfoHTC#configs field.

Annotations
@NativeType:XrFoveationConfigurationHTC const *
configsback to summary
public XrFoveationCustomModeInfoHTC.Buffer configs(XrFoveationConfigurationHTC.Buffer value)

Sets the address of the specified XrFoveationConfigurationHTC.Buffer to the XrFoveationCustomModeInfoHTC#configs field.

getElementFactoryback to summary
protected XrFoveationCustomModeInfoHTC getElementFactory()

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

Annotations
@Override
nextback to summary
public long next()
Returns:long

the value of the XrFoveationCustomModeInfoHTC#next field.

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

Sets the specified value to the XrFoveationCustomModeInfoHTC#next field.

selfback to summary
protected XrFoveationCustomModeInfoHTC.Buffer self()

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

Annotations
@Override
typeback to summary
public int type()
Returns:int

the value of the XrFoveationCustomModeInfoHTC#type field.

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

Sets the specified value to the XrFoveationCustomModeInfoHTC#type field.

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

Sets the TYPE_FOVEATION_CUSTOM_MODE_INFO_HTC value to the XrFoveationCustomModeInfoHTC#type field.