Package org.lwjgl.openxr

Class XrRenderModelPropertiesFB

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrRenderModelPropertiesFB>

org.lwjgl.openxr.XrRenderModelPropertiesFB

All Implemented Interfaces:

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

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

The information about the render model.

Description

XrRenderModelPropertiesFB contains information about the render model for a device. XrRenderModelPropertiesFB must be provided when calling GetRenderModelPropertiesFB. The XrRenderModelKeyFB included in the properties is a unique key for each render model that is valid across multiple instances and installs.

If the application decides to cache or save the render model in any way, modelVersion can be used to determine if the render model has changed. The application should then update its cached or saved version.

Valid Usage (Implicit)

• The XR_FB_render_model extension must be enabled prior to using XrRenderModelPropertiesFB
• type must be TYPE_RENDER_MODEL_PROPERTIES_FB
• next must be NULL or a valid pointer to the next structure in a structure chain. See also: XrRenderModelCapabilitiesRequestFB
• modelName must be a null-terminated UTF-8 string whose length is less than or equal to MAX_RENDER_MODEL_NAME_SIZE_FB
• flags must be a valid combination of XrRenderModelFlagBitsFB values
• flags must not be 0

See Also

GetRenderModelPropertiesFB

Layout

 struct XrRenderModelPropertiesFB {
     XrStructureType type();
     void * next();
     uint32_t vendorId();
     char modelName()[XR_MAX_RENDER_MODEL_NAME_SIZE_FB];
     XrRenderModelKeyFB modelKey();
     uint32_t modelVersion();
     XrRenderModelFlagsFB flags();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrRenderModelPropertiesFB.Buffer	An array of XrRenderModelPropertiesFB 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	FLAGS	The struct member offsets.
static final int	MODELKEY	The struct member offsets.
static final int	MODELNAME	The struct member offsets.
static final int	MODELVERSION	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	VENDORID	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
XrRenderModelPropertiesFB(ByteBuffer container)	Creates a XrRenderModelPropertiesFB instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrRenderModelPropertiesFB	calloc()	Returns a new XrRenderModelPropertiesFB instance allocated with memCalloc.
static XrRenderModelPropertiesFB.Buffer	calloc(int capacity)	Returns a new XrRenderModelPropertiesFB.Buffer instance allocated with memCalloc.
static XrRenderModelPropertiesFB.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrRenderModelPropertiesFB.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrRenderModelPropertiesFB	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrRenderModelPropertiesFB instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrRenderModelPropertiesFB	create()	Returns a new XrRenderModelPropertiesFB instance allocated with BufferUtils.
static XrRenderModelPropertiesFB.Buffer	create(int capacity)	Returns a new XrRenderModelPropertiesFB.Buffer instance allocated with BufferUtils.
static XrRenderModelPropertiesFB	create(long address)	Returns a new XrRenderModelPropertiesFB instance for the specified memory address.
static XrRenderModelPropertiesFB.Buffer	create(long address, int capacity)	Create a XrRenderModelPropertiesFB.Buffer instance at the specified memory.
static @Nullable XrRenderModelPropertiesFB	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrRenderModelPropertiesFB.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	flags()	a bitmask of XrRenderModelFlagsFB.
XrRenderModelPropertiesFB	flags(long value)	Sets the specified value to the flags() field.
static XrRenderModelPropertiesFB	malloc()	Returns a new XrRenderModelPropertiesFB instance allocated with memAlloc.
static XrRenderModelPropertiesFB.Buffer	malloc(int capacity)	Returns a new XrRenderModelPropertiesFB.Buffer instance allocated with memAlloc.
static XrRenderModelPropertiesFB.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrRenderModelPropertiesFB.Buffer instance allocated on the specified MemoryStack.
static XrRenderModelPropertiesFB	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrRenderModelPropertiesFB instance allocated on the specified MemoryStack.
long	modelKey()	the unique model key used to load the model in LoadRenderModelFB.
XrRenderModelPropertiesFB	modelKey(long value)	Sets the specified value to the modelKey() field.
ByteBuffer	modelName()	the name of the model.
XrRenderModelPropertiesFB	modelName(ByteBuffer value)	Copies the specified encoded string to the modelName() field.
String	modelNameString()	the name of the model.
int	modelVersion()	the version number of the model.
XrRenderModelPropertiesFB	modelVersion(int value)	Sets the specified value to the modelVersion() field.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrRenderModelPropertiesFB	next(long value)	Sets the specified value to the next() field.
XrRenderModelPropertiesFB	next(XrRenderModelCapabilitiesRequestFB value)	Prepends the specified XrRenderModelCapabilitiesRequestFB value to the next chain.
static long	nflags(long struct)	Unsafe version of flags().
static void	nflags(long struct, long value)	Unsafe version of flags.
static long	nmodelKey(long struct)	Unsafe version of modelKey().
static void	nmodelKey(long struct, long value)	Unsafe version of modelKey.
static ByteBuffer	nmodelName(long struct)	Unsafe version of modelName().
static void	nmodelName(long struct, ByteBuffer value)	Unsafe version of modelName.
static String	nmodelNameString(long struct)	Unsafe version of modelNameString().
static int	nmodelVersion(long struct)	Unsafe version of modelVersion().
static void	nmodelVersion(long struct, int value)	Unsafe version of modelVersion.
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	nvendorId(long struct)	Unsafe version of vendorId().
static void	nvendorId(long struct, int value)	Unsafe version of vendorId.
XrRenderModelPropertiesFB	set(int type, long next, int vendorId, ByteBuffer modelName, long modelKey, int modelVersion, long flags)	Initializes this struct with the specified values.
XrRenderModelPropertiesFB	set(XrRenderModelPropertiesFB src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrRenderModelPropertiesFB	type(int value)	Sets the specified value to the type() field.
XrRenderModelPropertiesFB	type$Default()	Sets the TYPE_RENDER_MODEL_PROPERTIES_FB value to the type() field.
int	vendorId()	the vendor id of the model.
XrRenderModelPropertiesFB	vendorId(int value)	Sets the specified value to the vendorId() 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.

VENDORID

public static final int VENDORID

The struct member offsets.

MODELNAME

public static final int MODELNAME

The struct member offsets.

MODELKEY

public static final int MODELKEY

The struct member offsets.

MODELVERSION

public static final int MODELVERSION

The struct member offsets.

FLAGS

public static final int FLAGS

The struct member offsets.

Constructor Details

XrRenderModelPropertiesFB

public XrRenderModelPropertiesFB(ByteBuffer container)

Creates a XrRenderModelPropertiesFB 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<XrRenderModelPropertiesFB>

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. XrRenderModelCapabilitiesRequestFB is a structure in this structure chain and should be linked when this structure is passed to GetRenderModelPropertiesFB.

vendorId

public int vendorId()

the vendor id of the model.

modelName

public ByteBuffer modelName()

the name of the model.

modelNameString

public String modelNameString()

the name of the model.

modelKey

public long modelKey()

the unique model key used to load the model in LoadRenderModelFB.

modelVersion

public int modelVersion()

the version number of the model.

flags

public long flags()

a bitmask of XrRenderModelFlagsFB. After a successful call to GetRenderModelPropertiesFB, flags must contain the support level of the model and no other support levels.

type

public XrRenderModelPropertiesFB type(int value)

Sets the specified value to the type() field.

type$Default

public XrRenderModelPropertiesFB type$Default()

Sets the TYPE_RENDER_MODEL_PROPERTIES_FB value to the type() field.

next

public XrRenderModelPropertiesFB next(long value)

Sets the specified value to the next() field.

next

public XrRenderModelPropertiesFB next(XrRenderModelCapabilitiesRequestFB value)

Prepends the specified XrRenderModelCapabilitiesRequestFB value to the next chain.

vendorId

public XrRenderModelPropertiesFB vendorId(int value)

Sets the specified value to the vendorId() field.

modelName

public XrRenderModelPropertiesFB modelName(ByteBuffer value)

Copies the specified encoded string to the modelName() field.

modelKey

public XrRenderModelPropertiesFB modelKey(long value)

Sets the specified value to the modelKey() field.

modelVersion

public XrRenderModelPropertiesFB modelVersion(int value)

Sets the specified value to the modelVersion() field.

flags

public XrRenderModelPropertiesFB flags(long value)

Sets the specified value to the flags() field.

set

public XrRenderModelPropertiesFB set(int type,
 long next,
 int vendorId,
 ByteBuffer modelName,
 long modelKey,
 int modelVersion,
 long flags)

Initializes this struct with the specified values.

set

public XrRenderModelPropertiesFB set(XrRenderModelPropertiesFB src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrRenderModelPropertiesFB malloc()

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

calloc

public static XrRenderModelPropertiesFB calloc()

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

create

public static XrRenderModelPropertiesFB create()

Returns a new XrRenderModelPropertiesFB instance allocated with BufferUtils.

create

public static XrRenderModelPropertiesFB create(long address)

Returns a new XrRenderModelPropertiesFB instance for the specified memory address.

createSafe

public static @Nullable XrRenderModelPropertiesFB createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrRenderModelPropertiesFB.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrRenderModelPropertiesFB.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrRenderModelPropertiesFB.Buffer create(int capacity)

Returns a new XrRenderModelPropertiesFB.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrRenderModelPropertiesFB.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrRenderModelPropertiesFB instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nvendorId

public static int nvendorId(long struct)

Unsafe version of vendorId().

nmodelName

public static ByteBuffer nmodelName(long struct)

Unsafe version of modelName().

nmodelNameString

public static String nmodelNameString(long struct)

Unsafe version of modelNameString().

nmodelKey

public static long nmodelKey(long struct)

Unsafe version of modelKey().

nmodelVersion

public static int nmodelVersion(long struct)

Unsafe version of modelVersion().

nflags

public static long nflags(long struct)

Unsafe version of flags().

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.

nvendorId

public static void nvendorId(long struct,
 int value)

Unsafe version of vendorId.

nmodelName

public static void nmodelName(long struct,
 ByteBuffer value)

Unsafe version of modelName.

nmodelKey

public static void nmodelKey(long struct,
 long value)

Unsafe version of modelKey.

nmodelVersion

public static void nmodelVersion(long struct,
 int value)

Unsafe version of modelVersion.

nflags

public static void nflags(long struct,
 long value)

Unsafe version of flags.