Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrViewLocateInfo

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

Struct containing view locate information.
Description

The XrViewLocateInfo structure contains the display time and space used to locate the view XrView structures.

The runtime must return error ERROR_VIEW_CONFIGURATION_TYPE_UNSUPPORTED if the given viewConfigurationType is not one of the supported type reported by EnumerateViewConfigurations.

Valid Usage (Implicit)
See Also

XrView, XrViewState, LocateViews

Layout


struct XrViewLocateInfo {
    XrStructureType type;
    void const * next;
    XrViewConfigurationType viewConfigurationType;
    XrTime displayTime;
    XrSpace space;
}

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
DISPLAYTIME

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
SPACE

The struct member offsets.

public static final int
TYPE

The struct member offsets.

public static final int
VIEWCONFIGURATIONTYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
XrViewLocateInfo(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrViewLocateInfo
calloc()

Returns a new XrViewLocateInfo instance allocated with memCalloc.

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

Returns a new XrViewLocateInfo.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrViewLocateInfo instance allocated with BufferUtils.

public static XrViewLocateInfo
create(long address)

Returns a new XrViewLocateInfo instance for the specified memory address.

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

Returns a new XrViewLocateInfo.Buffer instance allocated with BufferUtils.

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

Create a XrViewLocateInfo.Buffer instance at the specified memory.

public static XrViewLocateInfo
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long
displayTime()

the time for which the view poses are predicted.

public XrViewLocateInfo
displayTime(long value)

Sets the specified value to the displayTime field.

public static XrViewLocateInfo
malloc()

Returns a new XrViewLocateInfo instance allocated with memAlloc.

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

Returns a new XrViewLocateInfo.Buffer instance allocated with memAlloc.

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

Returns a new XrViewLocateInfo instance allocated on the specified MemoryStack.

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

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

public static long
ndisplayTime(long struct)

Unsafe version of displayTime.

public static void
ndisplayTime(long struct, long value)

Unsafe version of displayTime.

public long

Returns:

the value of the next field.
next
()

public XrViewLocateInfo
next(long value)

Sets the specified value to the next field.

public XrViewLocateInfo
next(XrViewLocateFoveatedRenderingVARJO value)

Prepends the specified XrViewLocateFoveatedRenderingVARJO value to the next chain.

public static long
nnext(long struct)

Unsafe version of next.

public static void
nnext(long struct, long value)

Unsafe version of next.

public static long
nspace(long struct)

Unsafe version of space.

public static void
nspace(long struct, XrSpace value)

Unsafe version of space.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public static int
nviewConfigurationType(long struct)

Unsafe version of viewConfigurationType.

public static void
nviewConfigurationType(long struct, int value)

Unsafe version of viewConfigurationType.

public XrViewLocateInfo
set(int type, long next, int viewConfigurationType, long displayTime, XrSpace space)

Initializes this struct with the specified values.

public XrViewLocateInfo

Returns:

this struct
set
(XrViewLocateInfo
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 long
space()

the XrSpace in which the pose in each XrView is expressed.

public XrViewLocateInfo
space(XrSpace value)

Sets the specified value to the space field.

public int

Returns:

the value of the type field.
type
()

public XrViewLocateInfo
type(int value)

Sets the specified value to the type field.

public XrViewLocateInfo
type$Default()

Sets the TYPE_VIEW_LOCATE_INFO value to the type field.

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

Validates pointer members that should not be NULL.

public int
viewConfigurationType()

XrViewConfigurationType to query for.

public XrViewLocateInfo
viewConfigurationType(int value)

Sets the specified value to the viewConfigurationType field.

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.

DISPLAYTIMEback to summary
public static final int DISPLAYTIME

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.

SPACEback to summary
public static final int SPACE

The struct member offsets.

TYPEback to summary
public static final int TYPE

The struct member offsets.

VIEWCONFIGURATIONTYPEback to summary
public static final int VIEWCONFIGURATIONTYPE

The struct member offsets.

Constructor Detail

XrViewLocateInfoback to summary
protected XrViewLocateInfo(long address, ByteBuffer container)
XrViewLocateInfoback to summary
public XrViewLocateInfo(ByteBuffer container)

Creates a XrViewLocateInfo 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 XrViewLocateInfo calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrViewLocateInfo calloc(MemoryStack stack)

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

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

Returns a new XrViewLocateInfo instance allocated with BufferUtils.

createback to summary
public static XrViewLocateInfo create(long address)

Returns a new XrViewLocateInfo instance for the specified memory address.

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

Returns a new XrViewLocateInfo.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrViewLocateInfo.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrViewLocateInfo createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
displayTimeback to summary
public long displayTime()

the time for which the view poses are predicted.

Annotations
@NativeType:XrTime
displayTimeback to summary
public XrViewLocateInfo displayTime(long value)

Sets the specified value to the displayTime field.

mallocback to summary
public static XrViewLocateInfo malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrViewLocateInfo malloc(MemoryStack stack)

Returns a new XrViewLocateInfo instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

ndisplayTimeback to summary
public static long ndisplayTime(long struct)

Unsafe version of displayTime.

ndisplayTimeback to summary
public static void ndisplayTime(long struct, long value)

Unsafe version of displayTime.

nextback to summary
public long next()
Returns:long

the value of the next field.

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

Sets the specified value to the next field.

nextback to summary
public XrViewLocateInfo next(XrViewLocateFoveatedRenderingVARJO value)

Prepends the specified XrViewLocateFoveatedRenderingVARJO value to the next chain.

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.

nspaceback to summary
public static long nspace(long struct)

Unsafe version of space.

nspaceback to summary
public static void nspace(long struct, XrSpace value)

Unsafe version of space.

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.

nviewConfigurationTypeback to summary
public static int nviewConfigurationType(long struct)

Unsafe version of viewConfigurationType.

nviewConfigurationTypeback to summary
public static void nviewConfigurationType(long struct, int value)

Unsafe version of viewConfigurationType.

setback to summary
public XrViewLocateInfo set(int type, long next, int viewConfigurationType, long displayTime, XrSpace space)

Initializes this struct with the specified values.

setback to summary
public XrViewLocateInfo set(XrViewLocateInfo src)

Copies the specified struct data to this struct.

Parameters
src:XrViewLocateInfo

the source struct

Returns:XrViewLocateInfo

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
spaceback to summary
public long space()

the XrSpace in which the pose in each XrView is expressed.

Annotations
@NativeType:XrSpace
spaceback to summary
public XrViewLocateInfo space(XrSpace value)

Sets the specified value to the space field.

typeback to summary
public int type()
Returns:int

the value of the type field.

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

Sets the specified value to the type field.

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

Sets the TYPE_VIEW_LOCATE_INFO 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

viewConfigurationTypeback to summary
public int viewConfigurationType()

XrViewConfigurationType to query for.

Annotations
@NativeType:XrViewConfigurationType
viewConfigurationTypeback to summary
public XrViewLocateInfo viewConfigurationType(int value)

Sets the specified value to the viewConfigurationType field.

org.lwjgl.openxr back to summary

public Class XrViewLocateInfo.Buffer

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

An array of XrViewLocateInfo structs.

Field Summary

Modifier and TypeField and Description
private static final XrViewLocateInfo

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrViewLocateInfo.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 long

Returns:

the value of the XrViewLocateInfo#displayTime field.
displayTime
()

public XrViewLocateInfo.Buffer
displayTime(long value)

Sets the specified value to the XrViewLocateInfo#displayTime field.

protected XrViewLocateInfo
public long

Returns:

the value of the next field.
next
()

public XrViewLocateInfo.Buffer
next(long value)

Sets the specified value to the next field.

public XrViewLocateInfo.Buffer
next(XrViewLocateFoveatedRenderingVARJO value)

Prepends the specified XrViewLocateFoveatedRenderingVARJO value to the next chain.

protected XrViewLocateInfo.Buffer
public long

Returns:

the value of the XrViewLocateInfo#space field.
space
()

public XrViewLocateInfo.Buffer
space(XrSpace value)

Sets the specified value to the XrViewLocateInfo#space field.

public int

Returns:

the value of the type field.
type
()

public XrViewLocateInfo.Buffer
type(int value)

Sets the specified value to the type field.

public XrViewLocateInfo.Buffer
type$Default()

Sets the TYPE_VIEW_LOCATE_INFO value to the type field.

public int
public XrViewLocateInfo.Buffer
viewConfigurationType(int value)

Sets the specified value to the XrViewLocateInfo#viewConfigurationType field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XrViewLocateInfo ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

displayTimeback to summary
public long displayTime()
Returns:long

the value of the XrViewLocateInfo#displayTime field.

Annotations
@NativeType:XrTime
displayTimeback to summary
public XrViewLocateInfo.Buffer displayTime(long value)

Sets the specified value to the XrViewLocateInfo#displayTime field.

getElementFactoryback to summary
protected XrViewLocateInfo getElementFactory()

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

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

the value of the next field.

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

Sets the specified value to the next field.

nextback to summary
public XrViewLocateInfo.Buffer next(XrViewLocateFoveatedRenderingVARJO value)

Prepends the specified XrViewLocateFoveatedRenderingVARJO value to the next chain.

selfback to summary
protected XrViewLocateInfo.Buffer self()

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

Annotations
@Override
spaceback to summary
public long space()
Returns:long

the value of the XrViewLocateInfo#space field.

Annotations
@NativeType:XrSpace
spaceback to summary
public XrViewLocateInfo.Buffer space(XrSpace value)

Sets the specified value to the XrViewLocateInfo#space field.

typeback to summary
public int type()
Returns:int

the value of the type field.

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

Sets the specified value to the type field.

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

Sets the TYPE_VIEW_LOCATE_INFO value to the type field.

viewConfigurationTypeback to summary
public int viewConfigurationType()
Returns:int

the value of the XrViewLocateInfo#viewConfigurationType field.

Annotations
@NativeType:XrViewConfigurationType
viewConfigurationTypeback to summary
public XrViewLocateInfo.Buffer viewConfigurationType(int value)

Sets the specified value to the XrViewLocateInfo#viewConfigurationType field.