Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrRenderModelPropertiesFB

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

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)
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 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
FLAGS

The struct member offsets.

public static final int
MODELKEY

The struct member offsets.

public static final int
MODELNAME

The struct member offsets.

public static final int
MODELVERSION

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
VENDORID

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
XrRenderModelPropertiesFB(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrRenderModelPropertiesFB
calloc()

Returns a new XrRenderModelPropertiesFB instance allocated with memCalloc.

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

Returns a new XrRenderModelPropertiesFB.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrRenderModelPropertiesFB instance allocated with BufferUtils.

public static XrRenderModelPropertiesFB
create(long address)

Returns a new XrRenderModelPropertiesFB instance for the specified memory address.

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

Returns a new XrRenderModelPropertiesFB.Buffer instance allocated with BufferUtils.

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

Create a XrRenderModelPropertiesFB.Buffer instance at the specified memory.

public static XrRenderModelPropertiesFB
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long
flags()

a bitmask of XrRenderModelFlagsFB.

public XrRenderModelPropertiesFB
flags(long value)

Sets the specified value to the flags field.

public static XrRenderModelPropertiesFB
malloc()

Returns a new XrRenderModelPropertiesFB instance allocated with memAlloc.

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

Returns a new XrRenderModelPropertiesFB.Buffer instance allocated with memAlloc.

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

Returns a new XrRenderModelPropertiesFB instance allocated on the specified MemoryStack.

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

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

public long
modelKey()

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

public XrRenderModelPropertiesFB
modelKey(long value)

Sets the specified value to the modelKey field.

public ByteBuffer
modelName()

the name of the model.

public XrRenderModelPropertiesFB
modelName(ByteBuffer value)

Copies the specified encoded string to the modelName field.

public String
modelNameString()

the name of the model.

public int
modelVersion()

the version number of the model.

public XrRenderModelPropertiesFB
modelVersion(int value)

Sets the specified value to the modelVersion field.

public long
next()

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

public XrRenderModelPropertiesFB
next(long value)

Sets the specified value to the next field.

public static long
nflags(long struct)

Unsafe version of flags.

public static void
nflags(long struct, long value)

Unsafe version of flags.

public static long
nmodelKey(long struct)

Unsafe version of modelKey.

public static void
nmodelKey(long struct, long value)

Unsafe version of modelKey.

public static ByteBuffer
nmodelName(long struct)

Unsafe version of modelName.

public static void
nmodelName(long struct, ByteBuffer value)

Unsafe version of modelName.

public static String
nmodelNameString(long struct)

Unsafe version of modelNameString.

public static int
nmodelVersion(long struct)

Unsafe version of modelVersion.

public static void
nmodelVersion(long struct, int value)

Unsafe version of modelVersion.

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
nvendorId(long struct)

Unsafe version of vendorId.

public static void
nvendorId(long struct, int value)

Unsafe version of vendorId.

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

Initializes this struct with the specified values.

public XrRenderModelPropertiesFB

Returns:

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

Sets the specified value to the type field.

public XrRenderModelPropertiesFB
type$Default()

Sets the TYPE_RENDER_MODEL_PROPERTIES_FB value to the type field.

public int
vendorId()

the vendor id of the model.

public XrRenderModelPropertiesFB
vendorId(int value)

Sets the specified value to the vendorId 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.

FLAGSback to summary
public static final int FLAGS

The struct member offsets.

MODELKEYback to summary
public static final int MODELKEY

The struct member offsets.

MODELNAMEback to summary
public static final int MODELNAME

The struct member offsets.

MODELVERSIONback to summary
public static final int MODELVERSION

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.

VENDORIDback to summary
public static final int VENDORID

The struct member offsets.

Constructor Detail

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

callocback to summary
public static XrRenderModelPropertiesFB calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrRenderModelPropertiesFB calloc(MemoryStack stack)

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

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

Returns a new XrRenderModelPropertiesFB instance allocated with BufferUtils.

createback to summary
public static XrRenderModelPropertiesFB create(long address)

Returns a new XrRenderModelPropertiesFB instance for the specified memory address.

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

Returns a new XrRenderModelPropertiesFB.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrRenderModelPropertiesFB.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrRenderModelPropertiesFB createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

Annotations
@NativeType:XrRenderModelFlagsFB
flagsback to summary
public XrRenderModelPropertiesFB flags(long value)

Sets the specified value to the flags field.

mallocback to summary
public static XrRenderModelPropertiesFB malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrRenderModelPropertiesFB malloc(MemoryStack stack)

Returns a new XrRenderModelPropertiesFB instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

modelKeyback to summary
public long modelKey()

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

Annotations
@NativeType:XrRenderModelKeyFB
modelKeyback to summary
public XrRenderModelPropertiesFB modelKey(long value)

Sets the specified value to the modelKey field.

modelNameback to summary
public ByteBuffer modelName()

the name of the model.

Annotations
@NativeType:char[XR_MAX_RENDER_MODEL_NAME_SIZE_FB]
modelNameback to summary
public XrRenderModelPropertiesFB modelName(ByteBuffer value)

Copies the specified encoded string to the modelName field.

modelNameStringback to summary
public String modelNameString()

the name of the model.

Annotations
@NativeType:char[XR_MAX_RENDER_MODEL_NAME_SIZE_FB]
modelVersionback to summary
public int modelVersion()

the version number of the model.

Annotations
@NativeType:uint32_t
modelVersionback to summary
public XrRenderModelPropertiesFB modelVersion(int value)

Sets the specified value to the modelVersion field.

nextback to summary
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.

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

Sets the specified value to the next field.

nflagsback to summary
public static long nflags(long struct)

Unsafe version of flags.

nflagsback to summary
public static void nflags(long struct, long value)

Unsafe version of flags.

nmodelKeyback to summary
public static long nmodelKey(long struct)

Unsafe version of modelKey.

nmodelKeyback to summary
public static void nmodelKey(long struct, long value)

Unsafe version of modelKey.

nmodelNameback to summary
public static ByteBuffer nmodelName(long struct)

Unsafe version of modelName.

nmodelNameback to summary
public static void nmodelName(long struct, ByteBuffer value)

Unsafe version of modelName.

nmodelNameStringback to summary
public static String nmodelNameString(long struct)

Unsafe version of modelNameString.

nmodelVersionback to summary
public static int nmodelVersion(long struct)

Unsafe version of modelVersion.

nmodelVersionback to summary
public static void nmodelVersion(long struct, int value)

Unsafe version of modelVersion.

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.

nvendorIdback to summary
public static int nvendorId(long struct)

Unsafe version of vendorId.

nvendorIdback to summary
public static void nvendorId(long struct, int value)

Unsafe version of vendorId.

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

Initializes this struct with the specified values.

setback to summary
public XrRenderModelPropertiesFB set(XrRenderModelPropertiesFB src)

Copies the specified struct data to this struct.

Parameters
src:XrRenderModelPropertiesFB

the source struct

Returns:XrRenderModelPropertiesFB

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

Sets the specified value to the type field.

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

Sets the TYPE_RENDER_MODEL_PROPERTIES_FB value to the type field.

vendorIdback to summary
public int vendorId()

the vendor id of the model.

Annotations
@NativeType:uint32_t
vendorIdback to summary
public XrRenderModelPropertiesFB vendorId(int value)

Sets the specified value to the vendorId field.

org.lwjgl.openxr back to summary

public Class XrRenderModelPropertiesFB.Buffer

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

An array of XrRenderModelPropertiesFB structs.

Field Summary

Modifier and TypeField and Description
private static final XrRenderModelPropertiesFB

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrRenderModelPropertiesFB.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 XrRenderModelPropertiesFB#flags field.
flags
()

public XrRenderModelPropertiesFB.Buffer
flags(long value)

Sets the specified value to the XrRenderModelPropertiesFB#flags field.

protected XrRenderModelPropertiesFB
public long

Returns:

the value of the XrRenderModelPropertiesFB#modelKey field.
modelKey
()

public XrRenderModelPropertiesFB.Buffer
modelKey(long value)

Sets the specified value to the XrRenderModelPropertiesFB#modelKey field.

public ByteBuffer
public XrRenderModelPropertiesFB.Buffer
modelName(ByteBuffer value)

Copies the specified encoded string to the XrRenderModelPropertiesFB#modelName field.

public String

Returns:

the null-terminated string stored in the XrRenderModelPropertiesFB#modelName field.
modelNameString
()

public int

Returns:

the value of the XrRenderModelPropertiesFB#modelVersion field.
modelVersion
()

public XrRenderModelPropertiesFB.Buffer
modelVersion(int value)

Sets the specified value to the XrRenderModelPropertiesFB#modelVersion field.

public long

Returns:

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

public XrRenderModelPropertiesFB.Buffer
next(long value)

Sets the specified value to the XrRenderModelPropertiesFB#next field.

protected XrRenderModelPropertiesFB.Buffer
public int

Returns:

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

public XrRenderModelPropertiesFB.Buffer
type(int value)

Sets the specified value to the XrRenderModelPropertiesFB#type field.

public XrRenderModelPropertiesFB.Buffer
public int

Returns:

the value of the XrRenderModelPropertiesFB#vendorId field.
vendorId
()

public XrRenderModelPropertiesFB.Buffer
vendorId(int value)

Sets the specified value to the XrRenderModelPropertiesFB#vendorId field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XrRenderModelPropertiesFB ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

flagsback to summary
public long flags()
Returns:long

the value of the XrRenderModelPropertiesFB#flags field.

Annotations
@NativeType:XrRenderModelFlagsFB
flagsback to summary
public XrRenderModelPropertiesFB.Buffer flags(long value)

Sets the specified value to the XrRenderModelPropertiesFB#flags field.

getElementFactoryback to summary
protected XrRenderModelPropertiesFB getElementFactory()

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

Annotations
@Override
modelKeyback to summary
public long modelKey()
Returns:long

the value of the XrRenderModelPropertiesFB#modelKey field.

Annotations
@NativeType:XrRenderModelKeyFB
modelKeyback to summary
public XrRenderModelPropertiesFB.Buffer modelKey(long value)

Sets the specified value to the XrRenderModelPropertiesFB#modelKey field.

modelNameback to summary
public ByteBuffer modelName()
Returns:ByteBuffer

a ByteBuffer view of the XrRenderModelPropertiesFB#modelName field.

Annotations
@NativeType:char[XR_MAX_RENDER_MODEL_NAME_SIZE_FB]
modelNameback to summary
public XrRenderModelPropertiesFB.Buffer modelName(ByteBuffer value)

Copies the specified encoded string to the XrRenderModelPropertiesFB#modelName field.

modelNameStringback to summary
public String modelNameString()
Returns:String

the null-terminated string stored in the XrRenderModelPropertiesFB#modelName field.

Annotations
@NativeType:char[XR_MAX_RENDER_MODEL_NAME_SIZE_FB]
modelVersionback to summary
public int modelVersion()
Returns:int

the value of the XrRenderModelPropertiesFB#modelVersion field.

Annotations
@NativeType:uint32_t
modelVersionback to summary
public XrRenderModelPropertiesFB.Buffer modelVersion(int value)

Sets the specified value to the XrRenderModelPropertiesFB#modelVersion field.

nextback to summary
public long next()
Returns:long

the value of the XrRenderModelPropertiesFB#next field.

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

Sets the specified value to the XrRenderModelPropertiesFB#next field.

selfback to summary
protected XrRenderModelPropertiesFB.Buffer self()

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

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

the value of the XrRenderModelPropertiesFB#type field.

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

Sets the specified value to the XrRenderModelPropertiesFB#type field.

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

Sets the TYPE_RENDER_MODEL_PROPERTIES_FB value to the XrRenderModelPropertiesFB#type field.

vendorIdback to summary
public int vendorId()
Returns:int

the value of the XrRenderModelPropertiesFB#vendorId field.

Annotations
@NativeType:uint32_t
vendorIdback to summary
public XrRenderModelPropertiesFB.Buffer vendorId(int value)

Sets the specified value to the XrRenderModelPropertiesFB#vendorId field.