Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrViewConfigurationProperties

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

Detailed configuration properties for an XrViewConfigurationProperties.
Valid Usage (Implicit)
See Also

XrViewConfigurationView, GetViewConfigurationProperties

Layout


struct XrViewConfigurationProperties {
    XrStructureType type;
    void * next;
    XrViewConfigurationType viewConfigurationType;
    XrBool32 fovMutable;
}

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
FOVMUTABLE

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.

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
XrViewConfigurationProperties(long address, ByteBuffer container)

public
XrViewConfigurationProperties(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrViewConfigurationProperties
calloc()

Returns a new XrViewConfigurationProperties instance allocated with memCalloc.

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

Returns a new XrViewConfigurationProperties.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrViewConfigurationProperties instance allocated with BufferUtils.

public static XrViewConfigurationProperties
create(long address)

Returns a new XrViewConfigurationProperties instance for the specified memory address.

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

Returns a new XrViewConfigurationProperties.Buffer instance allocated with BufferUtils.

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

Create a XrViewConfigurationProperties.Buffer instance at the specified memory.

public static XrViewConfigurationProperties
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public boolean
fovMutable()

indicates if the view field of view can be modified by the application.

public XrViewConfigurationProperties
fovMutable(boolean value)

Sets the specified value to the fovMutable field.

public static XrViewConfigurationProperties
malloc()

Returns a new XrViewConfigurationProperties instance allocated with memAlloc.

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

Returns a new XrViewConfigurationProperties.Buffer instance allocated with memAlloc.

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

Returns a new XrViewConfigurationProperties instance allocated on the specified MemoryStack.

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

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

public long
next()

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

public XrViewConfigurationProperties
next(long value)

Sets the specified value to the next field.

public static int
nfovMutable(long struct)

Unsafe version of fovMutable.

public static void
nfovMutable(long struct, int value)

Unsafe version of fovMutable.

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 static int
nviewConfigurationType(long struct)

Unsafe version of viewConfigurationType.

public static void
nviewConfigurationType(long struct, int value)

Unsafe version of viewConfigurationType.

public XrViewConfigurationProperties
set(int type, long next, int viewConfigurationType, boolean fovMutable)

Initializes this struct with the specified values.

public XrViewConfigurationProperties

Returns:

this struct
set
(XrViewConfigurationProperties
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 XrViewConfigurationProperties
type(int value)

Sets the specified value to the type field.

public XrViewConfigurationProperties
public int
viewConfigurationType()

the XrViewConfigurationType of the configuration.

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

FOVMUTABLEback to summary
public static final int FOVMUTABLE

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.

VIEWCONFIGURATIONTYPEback to summary
public static final int VIEWCONFIGURATIONTYPE

The struct member offsets.

Constructor Detail

XrViewConfigurationPropertiesback to summary
protected XrViewConfigurationProperties(long address, ByteBuffer container)
XrViewConfigurationPropertiesback to summary
public XrViewConfigurationProperties(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrViewConfigurationProperties calloc(MemoryStack stack)

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

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

Returns a new XrViewConfigurationProperties instance allocated with BufferUtils.

createback to summary
public static XrViewConfigurationProperties create(long address)

Returns a new XrViewConfigurationProperties instance for the specified memory address.

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

Returns a new XrViewConfigurationProperties.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrViewConfigurationProperties.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrViewConfigurationProperties createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
fovMutableback to summary
public boolean fovMutable()

indicates if the view field of view can be modified by the application.

Annotations
@NativeType:XrBool32
fovMutableback to summary
public XrViewConfigurationProperties fovMutable(boolean value)

Sets the specified value to the fovMutable field.

mallocback to summary
public static XrViewConfigurationProperties malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrViewConfigurationProperties malloc(MemoryStack stack)

Returns a new XrViewConfigurationProperties instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nextback to summary
public long next()

NULL or a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR.

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

Sets the specified value to the next field.

nfovMutableback to summary
public static int nfovMutable(long struct)

Unsafe version of fovMutable.

nfovMutableback to summary
public static void nfovMutable(long struct, int value)

Unsafe version of fovMutable.

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.

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 XrViewConfigurationProperties set(int type, long next, int viewConfigurationType, boolean fovMutable)

Initializes this struct with the specified values.

setback to summary
public XrViewConfigurationProperties set(XrViewConfigurationProperties src)

Copies the specified struct data to this struct.

Parameters
src:XrViewConfigurationProperties

the source struct

Returns:XrViewConfigurationProperties

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 XrViewConfigurationProperties type(int value)

Sets the specified value to the type field.

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

Sets the TYPE_VIEW_CONFIGURATION_PROPERTIES value to the type field.

viewConfigurationTypeback to summary
public int viewConfigurationType()

the XrViewConfigurationType of the configuration.

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

Sets the specified value to the viewConfigurationType field.

org.lwjgl.openxr back to summary

public Class XrViewConfigurationProperties.Buffer

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

An array of XrViewConfigurationProperties structs.

Field Summary

Modifier and TypeField and Description
private static final XrViewConfigurationProperties

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrViewConfigurationProperties.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 boolean

Returns:

the value of the XrViewConfigurationProperties#fovMutable field.
fovMutable
()

public XrViewConfigurationProperties.Buffer
fovMutable(boolean value)

Sets the specified value to the XrViewConfigurationProperties#fovMutable field.

protected XrViewConfigurationProperties
public long

Returns:

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

public XrViewConfigurationProperties.Buffer
next(long value)

Sets the specified value to the XrViewConfigurationProperties#next field.

protected XrViewConfigurationProperties.Buffer
public int

Returns:

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

public XrViewConfigurationProperties.Buffer
type(int value)

Sets the specified value to the XrViewConfigurationProperties#type field.

public XrViewConfigurationProperties.Buffer
public int
public XrViewConfigurationProperties.Buffer
viewConfigurationType(int value)

Sets the specified value to the XrViewConfigurationProperties#viewConfigurationType field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XrViewConfigurationProperties ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

fovMutableback to summary
public boolean fovMutable()
Returns:boolean

the value of the XrViewConfigurationProperties#fovMutable field.

Annotations
@NativeType:XrBool32
fovMutableback to summary
public XrViewConfigurationProperties.Buffer fovMutable(boolean value)

Sets the specified value to the XrViewConfigurationProperties#fovMutable field.

getElementFactoryback to summary
protected XrViewConfigurationProperties getElementFactory()

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

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

the value of the XrViewConfigurationProperties#next field.

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

Sets the specified value to the XrViewConfigurationProperties#next field.

selfback to summary
protected XrViewConfigurationProperties.Buffer self()

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

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

the value of the XrViewConfigurationProperties#type field.

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

Sets the specified value to the XrViewConfigurationProperties#type field.

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

Sets the TYPE_VIEW_CONFIGURATION_PROPERTIES value to the XrViewConfigurationProperties#type field.

viewConfigurationTypeback to summary
public int viewConfigurationType()
Returns:int

the value of the XrViewConfigurationProperties#viewConfigurationType field.

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

Sets the specified value to the XrViewConfigurationProperties#viewConfigurationType field.