Package org.lwjgl.openxr

Class XrViewConfigurationProperties

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrViewConfigurationProperties>

org.lwjgl.openxr.XrViewConfigurationProperties

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class XrViewConfigurationProperties
extends org.lwjgl.system.Struct<XrViewConfigurationProperties>
implements org.lwjgl.system.NativeResource

Detailed configuration properties for an XrViewConfigurationProperties.

Valid Usage (Implicit)

• type must be TYPE_VIEW_CONFIGURATION_PROPERTIES
• next must be NULL or a valid pointer to the next structure in a structure chain
• viewConfigurationType must be a valid XrViewConfigurationType value

See Also

XrViewConfigurationView, GetViewConfigurationProperties

Layout

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrViewConfigurationProperties.Buffer	An array of XrViewConfigurationProperties structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	FOVMUTABLE	The struct member offsets.
static final int	NEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	TYPE	The struct member offsets.
static final int	VIEWCONFIGURATIONTYPE	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
XrViewConfigurationProperties(ByteBuffer container)	Creates a XrViewConfigurationProperties instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrViewConfigurationProperties	calloc()	Returns a new XrViewConfigurationProperties instance allocated with memCalloc.
static XrViewConfigurationProperties.Buffer	calloc(int capacity)	Returns a new XrViewConfigurationProperties.Buffer instance allocated with memCalloc.
static XrViewConfigurationProperties.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrViewConfigurationProperties.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrViewConfigurationProperties	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrViewConfigurationProperties instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrViewConfigurationProperties	create()	Returns a new XrViewConfigurationProperties instance allocated with BufferUtils.
static XrViewConfigurationProperties.Buffer	create(int capacity)	Returns a new XrViewConfigurationProperties.Buffer instance allocated with BufferUtils.
static XrViewConfigurationProperties	create(long address)	Returns a new XrViewConfigurationProperties instance for the specified memory address.
static XrViewConfigurationProperties.Buffer	create(long address, int capacity)	Create a XrViewConfigurationProperties.Buffer instance at the specified memory.
static @Nullable XrViewConfigurationProperties	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrViewConfigurationProperties.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
boolean	fovMutable()	indicates if the view field of view can be modified by the application.
XrViewConfigurationProperties	fovMutable(boolean value)	Sets the specified value to the fovMutable() field.
static XrViewConfigurationProperties	malloc()	Returns a new XrViewConfigurationProperties instance allocated with memAlloc.
static XrViewConfigurationProperties.Buffer	malloc(int capacity)	Returns a new XrViewConfigurationProperties.Buffer instance allocated with memAlloc.
static XrViewConfigurationProperties.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrViewConfigurationProperties.Buffer instance allocated on the specified MemoryStack.
static XrViewConfigurationProperties	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrViewConfigurationProperties instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrViewConfigurationProperties	next(long value)	Sets the specified value to the next() field.
static int	nfovMutable(long struct)	Unsafe version of fovMutable().
static void	nfovMutable(long struct, int value)	Unsafe version of fovMutable.
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
static int	nviewConfigurationType(long struct)	Unsafe version of viewConfigurationType().
static void	nviewConfigurationType(long struct, int value)	Unsafe version of viewConfigurationType.
XrViewConfigurationProperties	set(int type, long next, int viewConfigurationType, boolean fovMutable)	Initializes this struct with the specified values.
XrViewConfigurationProperties	set(XrViewConfigurationProperties src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrViewConfigurationProperties	type(int value)	Sets the specified value to the type() field.
XrViewConfigurationProperties	type$Default()	Sets the TYPE_VIEW_CONFIGURATION_PROPERTIES value to the type() field.
int	viewConfigurationType()	the XrViewConfigurationType of the configuration.
XrViewConfigurationProperties	viewConfigurationType(int value)	Sets the specified value to the viewConfigurationType() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

TYPE

public static final int TYPE

The struct member offsets.

NEXT

public static final int NEXT

The struct member offsets.

VIEWCONFIGURATIONTYPE

public static final int VIEWCONFIGURATIONTYPE

The struct member offsets.

FOVMUTABLE

public static final int FOVMUTABLE

The struct member offsets.

Constructor Details

XrViewConfigurationProperties

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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<XrViewConfigurationProperties>

type

public int type()

the XrStructureType of this structure.

next

public long next()

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

viewConfigurationType

public int viewConfigurationType()

the XrViewConfigurationType of the configuration.

fovMutable

public boolean fovMutable()

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

type

public XrViewConfigurationProperties type(int value)

Sets the specified value to the type() field.

type$Default

public XrViewConfigurationProperties type$Default()

Sets the TYPE_VIEW_CONFIGURATION_PROPERTIES value to the type() field.

next

public XrViewConfigurationProperties next(long value)

Sets the specified value to the next() field.

viewConfigurationType

public XrViewConfigurationProperties viewConfigurationType(int value)

Sets the specified value to the viewConfigurationType() field.

fovMutable

public XrViewConfigurationProperties fovMutable(boolean value)

Sets the specified value to the fovMutable() field.

set

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

Initializes this struct with the specified values.

set

public XrViewConfigurationProperties set(XrViewConfigurationProperties src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrViewConfigurationProperties malloc()

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

calloc

public static XrViewConfigurationProperties calloc()

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

create

public static XrViewConfigurationProperties create()

Returns a new XrViewConfigurationProperties instance allocated with BufferUtils.

create

public static XrViewConfigurationProperties create(long address)

Returns a new XrViewConfigurationProperties instance for the specified memory address.

createSafe

public static @Nullable XrViewConfigurationProperties createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrViewConfigurationProperties.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrViewConfigurationProperties.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrViewConfigurationProperties.Buffer create(int capacity)

Returns a new XrViewConfigurationProperties.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrViewConfigurationProperties.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static XrViewConfigurationProperties malloc(org.lwjgl.system.MemoryStack stack)

Returns a new XrViewConfigurationProperties instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static XrViewConfigurationProperties calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static XrViewConfigurationProperties.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static XrViewConfigurationProperties.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

ntype

public static int ntype(long struct)

Unsafe version of type().

nnext

public static long nnext(long struct)

Unsafe version of next().

nviewConfigurationType

public static int nviewConfigurationType(long struct)

Unsafe version of viewConfigurationType().

nfovMutable

public static int nfovMutable(long struct)

Unsafe version of fovMutable().

ntype

public static void ntype(long struct,
 int value)

Unsafe version of type.

nnext

public static void nnext(long struct,
 long value)

Unsafe version of next.

nviewConfigurationType

public static void nviewConfigurationType(long struct,
 int value)

Unsafe version of viewConfigurationType.

nfovMutable

public static void nfovMutable(long struct,
 int value)

Unsafe version of fovMutable.