Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrFoveationConfigurationHTC

extends Struct<XrFoveationConfigurationHTC>
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 of foveation.
Valid Usage (Implicit)
See Also

XrFoveationCustomModeInfoHTC, XrVector2f

Layout


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

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
CLEARFOVDEGREE

The struct member offsets.

public static final int
FOCALCENTEROFFSET

The struct member offsets.

public static final int
LEVEL

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
XrFoveationConfigurationHTC(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrFoveationConfigurationHTC
calloc()

Returns a new XrFoveationConfigurationHTC instance allocated with memCalloc.

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

Returns a new XrFoveationConfigurationHTC.Buffer instance allocated with memCalloc.

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

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

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

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

public float
clearFovDegree()

the value indicating the total horizontal and vertical field angle with the original pixel density level.

public XrFoveationConfigurationHTC
clearFovDegree(float value)

Sets the specified value to the clearFovDegree field.

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

Returns a new XrFoveationConfigurationHTC instance allocated with BufferUtils.

public static XrFoveationConfigurationHTC
create(long address)

Returns a new XrFoveationConfigurationHTC instance for the specified memory address.

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

Returns a new XrFoveationConfigurationHTC.Buffer instance allocated with BufferUtils.

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

Create a XrFoveationConfigurationHTC.Buffer instance at the specified memory.

public static XrFoveationConfigurationHTC
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public XrVector2f
focalCenterOffset()

the desired center offset of the field of view in NDC(normalized device coordinates) space.

public XrFoveationConfigurationHTC
focalCenterOffset(XrVector2f value)

Copies the specified XrVector2f to the focalCenterOffset field.

public XrFoveationConfigurationHTC
focalCenterOffset(Consumer<XrVector2f> consumer)

Passes the focalCenterOffset field to the specified Consumer.

public int
level()

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

public XrFoveationConfigurationHTC
level(int value)

Sets the specified value to the level field.

public static XrFoveationConfigurationHTC
malloc()

Returns a new XrFoveationConfigurationHTC instance allocated with memAlloc.

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

Returns a new XrFoveationConfigurationHTC.Buffer instance allocated with memAlloc.

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

Returns a new XrFoveationConfigurationHTC instance allocated on the specified MemoryStack.

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

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

public static float
nclearFovDegree(long struct)

Unsafe version of clearFovDegree.

public static void
nclearFovDegree(long struct, float value)

Unsafe version of clearFovDegree.

public static XrVector2f
nfocalCenterOffset(long struct)

Unsafe version of focalCenterOffset.

public static void
nfocalCenterOffset(long struct, XrVector2f value)

Unsafe version of focalCenterOffset.

public static int
nlevel(long struct)

Unsafe version of level.

public static void
nlevel(long struct, int value)

Unsafe version of level.

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

Initializes this struct with the specified values.

public XrFoveationConfigurationHTC

Returns:

this struct
set
(XrFoveationConfigurationHTC
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).
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.

CLEARFOVDEGREEback to summary
public static final int CLEARFOVDEGREE

The struct member offsets.

FOCALCENTEROFFSETback to summary
public static final int FOCALCENTEROFFSET

The struct member offsets.

LEVELback to summary
public static final int LEVEL

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

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

callocback to summary
public static XrFoveationConfigurationHTC calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrFoveationConfigurationHTC calloc(MemoryStack stack)

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

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

clearFovDegreeback to summary
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].

clearFovDegreeback to summary
public XrFoveationConfigurationHTC clearFovDegree(float value)

Sets the specified value to the clearFovDegree field.

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

Returns a new XrFoveationConfigurationHTC instance allocated with BufferUtils.

createback to summary
public static XrFoveationConfigurationHTC create(long address)

Returns a new XrFoveationConfigurationHTC instance for the specified memory address.

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

Returns a new XrFoveationConfigurationHTC.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrFoveationConfigurationHTC.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrFoveationConfigurationHTC createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
focalCenterOffsetback to summary
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].

focalCenterOffsetback to summary
public XrFoveationConfigurationHTC focalCenterOffset(XrVector2f value)

Copies the specified XrVector2f to the focalCenterOffset field.

focalCenterOffsetback to summary
public XrFoveationConfigurationHTC focalCenterOffset(Consumer<XrVector2f> consumer)

Passes the focalCenterOffset field to the specified Consumer.

levelback to summary
public int level()

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

Annotations
@NativeType:XrFoveationLevelHTC
levelback to summary
public XrFoveationConfigurationHTC level(int value)

Sets the specified value to the level field.

mallocback to summary
public static XrFoveationConfigurationHTC malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrFoveationConfigurationHTC malloc(MemoryStack stack)

Returns a new XrFoveationConfigurationHTC instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nclearFovDegreeback to summary
public static float nclearFovDegree(long struct)

Unsafe version of clearFovDegree.

nclearFovDegreeback to summary
public static void nclearFovDegree(long struct, float value)

Unsafe version of clearFovDegree.

nfocalCenterOffsetback to summary
public static XrVector2f nfocalCenterOffset(long struct)

Unsafe version of focalCenterOffset.

nfocalCenterOffsetback to summary
public static void nfocalCenterOffset(long struct, XrVector2f value)

Unsafe version of focalCenterOffset.

nlevelback to summary
public static int nlevel(long struct)

Unsafe version of level.

nlevelback to summary
public static void nlevel(long struct, int value)

Unsafe version of level.

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

Initializes this struct with the specified values.

setback to summary
public XrFoveationConfigurationHTC set(XrFoveationConfigurationHTC src)

Copies the specified struct data to this struct.

Parameters
src:XrFoveationConfigurationHTC

the source struct

Returns:XrFoveationConfigurationHTC

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
org.lwjgl.openxr back to summary

public Class XrFoveationConfigurationHTC.Buffer

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

An array of XrFoveationConfigurationHTC structs.

Field Summary

Modifier and TypeField and Description
private static final XrFoveationConfigurationHTC

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrFoveationConfigurationHTC.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 float
public XrFoveationConfigurationHTC.Buffer
clearFovDegree(float value)

Sets the specified value to the XrFoveationConfigurationHTC#clearFovDegree field.

public XrVector2f
public XrFoveationConfigurationHTC.Buffer
public XrFoveationConfigurationHTC.Buffer
protected XrFoveationConfigurationHTC
public int

Returns:

the value of the XrFoveationConfigurationHTC#level field.
level
()

public XrFoveationConfigurationHTC.Buffer
level(int value)

Sets the specified value to the XrFoveationConfigurationHTC#level field.

protected XrFoveationConfigurationHTC.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XrFoveationConfigurationHTC ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

clearFovDegreeback to summary
public float clearFovDegree()
Returns:float

the value of the XrFoveationConfigurationHTC#clearFovDegree field.

clearFovDegreeback to summary
public XrFoveationConfigurationHTC.Buffer clearFovDegree(float value)

Sets the specified value to the XrFoveationConfigurationHTC#clearFovDegree field.

focalCenterOffsetback to summary
public XrVector2f focalCenterOffset()
Returns:XrVector2f

a XrVector2f view of the XrFoveationConfigurationHTC#focalCenterOffset field.

focalCenterOffsetback to summary
public XrFoveationConfigurationHTC.Buffer focalCenterOffset(XrVector2f value)

Copies the specified XrVector2f to the XrFoveationConfigurationHTC#focalCenterOffset field.

focalCenterOffsetback to summary
public XrFoveationConfigurationHTC.Buffer focalCenterOffset(Consumer<XrVector2f> consumer)

Passes the XrFoveationConfigurationHTC#focalCenterOffset field to the specified Consumer.

getElementFactoryback to summary
protected XrFoveationConfigurationHTC getElementFactory()

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

Annotations
@Override
levelback to summary
public int level()
Returns:int

the value of the XrFoveationConfigurationHTC#level field.

Annotations
@NativeType:XrFoveationLevelHTC
levelback to summary
public XrFoveationConfigurationHTC.Buffer level(int value)

Sets the specified value to the XrFoveationConfigurationHTC#level field.

selfback to summary
protected XrFoveationConfigurationHTC.Buffer self()

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

Annotations
@Override