Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrInstanceProperties

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

Contains information about the instance.
Valid Usage (Implicit)
See Also

GetInstanceProperties

Layout


struct XrInstanceProperties {
    XrStructureType type;
    void * next;
    XrVersion runtimeVersion;
    char runtimeName[XR_MAX_RUNTIME_NAME_SIZE];
}

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
NEXT

The struct member offsets.

public static final int
RUNTIMENAME

The struct member offsets.

public static final int
RUNTIMEVERSION

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
XrInstanceProperties(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrInstanceProperties
calloc()

Returns a new XrInstanceProperties instance allocated with memCalloc.

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

Returns a new XrInstanceProperties.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrInstanceProperties instance allocated with BufferUtils.

public static XrInstanceProperties
create(long address)

Returns a new XrInstanceProperties instance for the specified memory address.

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

Returns a new XrInstanceProperties.Buffer instance allocated with BufferUtils.

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

Create a XrInstanceProperties.Buffer instance at the specified memory.

public static XrInstanceProperties
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static XrInstanceProperties
malloc()

Returns a new XrInstanceProperties instance allocated with memAlloc.

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

Returns a new XrInstanceProperties.Buffer instance allocated with memAlloc.

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

Returns a new XrInstanceProperties instance allocated on the specified MemoryStack.

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

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

public long
next()

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

public XrInstanceProperties
next(long value)

Sets the specified value to the next field.

public static long
nnext(long struct)

Unsafe version of next.

public static void
nnext(long struct, long value)

Unsafe version of next.

public static ByteBuffer
nruntimeName(long struct)

Unsafe version of runtimeName.

public static String
nruntimeNameString(long struct)

Unsafe version of runtimeNameString.

public static long
nruntimeVersion(long struct)

Unsafe version of runtimeVersion.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public ByteBuffer
runtimeName()

the name of the runtime.

public String
runtimeNameString()

the name of the runtime.

public long
runtimeVersion()

the runtime’s version (not necessarily related to an OpenXR API version), expressed in the format of XR10#XR_MAKE_VERSION.

public XrInstanceProperties
set(int type, long next)

Initializes this struct with the specified values.

public XrInstanceProperties

Returns:

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

Sets the specified value to the type field.

public XrInstanceProperties
type$Default()

Sets the TYPE_INSTANCE_PROPERTIES value to the type 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.

NEXTback to summary
public static final int NEXT

The struct member offsets.

RUNTIMENAMEback to summary
public static final int RUNTIMENAME

The struct member offsets.

RUNTIMEVERSIONback to summary
public static final int RUNTIMEVERSION

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.

Constructor Detail

XrInstancePropertiesback to summary
protected XrInstanceProperties(long address, ByteBuffer container)
XrInstancePropertiesback to summary
public XrInstanceProperties(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrInstanceProperties calloc(MemoryStack stack)

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

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

Returns a new XrInstanceProperties instance allocated with BufferUtils.

createback to summary
public static XrInstanceProperties create(long address)

Returns a new XrInstanceProperties instance for the specified memory address.

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

Returns a new XrInstanceProperties.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrInstanceProperties.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrInstanceProperties createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static XrInstanceProperties malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrInstanceProperties malloc(MemoryStack stack)

Returns a new XrInstanceProperties instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new XrInstanceProperties.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 XrInstanceProperties next(long value)

Sets the specified value to the next field.

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.

nruntimeNameback to summary
public static ByteBuffer nruntimeName(long struct)

Unsafe version of runtimeName.

nruntimeNameStringback to summary
public static String nruntimeNameString(long struct)

Unsafe version of runtimeNameString.

nruntimeVersionback to summary
public static long nruntimeVersion(long struct)

Unsafe version of runtimeVersion.

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.

runtimeNameback to summary
public ByteBuffer runtimeName()

the name of the runtime.

Annotations
@NativeType:char[XR_MAX_RUNTIME_NAME_SIZE]
runtimeNameStringback to summary
public String runtimeNameString()

the name of the runtime.

Annotations
@NativeType:char[XR_MAX_RUNTIME_NAME_SIZE]
runtimeVersionback to summary
public long runtimeVersion()

the runtime’s version (not necessarily related to an OpenXR API version), expressed in the format of XR10#XR_MAKE_VERSION.

Annotations
@NativeType:XrVersion
setback to summary
public XrInstanceProperties set(int type, long next)

Initializes this struct with the specified values.

setback to summary
public XrInstanceProperties set(XrInstanceProperties src)

Copies the specified struct data to this struct.

Parameters
src:XrInstanceProperties

the source struct

Returns:XrInstanceProperties

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

Sets the specified value to the type field.

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

Sets the TYPE_INSTANCE_PROPERTIES value to the type field.

org.lwjgl.openxr back to summary

public Class XrInstanceProperties.Buffer

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

An array of XrInstanceProperties structs.

Field Summary

Modifier and TypeField and Description
private static final XrInstanceProperties

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrInstanceProperties.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
protected XrInstanceProperties
public long

Returns:

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

public XrInstanceProperties.Buffer
next(long value)

Sets the specified value to the XrInstanceProperties#next field.

public ByteBuffer
public String

Returns:

the null-terminated string stored in the XrInstanceProperties#runtimeName field.
runtimeNameString
()

public long

Returns:

the value of the XrInstanceProperties#runtimeVersion field.
runtimeVersion
()

protected XrInstanceProperties.Buffer
public int

Returns:

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

public XrInstanceProperties.Buffer
type(int value)

Sets the specified value to the XrInstanceProperties#type field.

public XrInstanceProperties.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XrInstanceProperties ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

getElementFactoryback to summary
protected XrInstanceProperties getElementFactory()

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

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

the value of the XrInstanceProperties#next field.

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

Sets the specified value to the XrInstanceProperties#next field.

runtimeNameback to summary
public ByteBuffer runtimeName()
Returns:ByteBuffer

a ByteBuffer view of the XrInstanceProperties#runtimeName field.

Annotations
@NativeType:char[XR_MAX_RUNTIME_NAME_SIZE]
runtimeNameStringback to summary
public String runtimeNameString()
Returns:String

the null-terminated string stored in the XrInstanceProperties#runtimeName field.

Annotations
@NativeType:char[XR_MAX_RUNTIME_NAME_SIZE]
runtimeVersionback to summary
public long runtimeVersion()
Returns:long

the value of the XrInstanceProperties#runtimeVersion field.

Annotations
@NativeType:XrVersion
selfback to summary
protected XrInstanceProperties.Buffer self()

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

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

the value of the XrInstanceProperties#type field.

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

Sets the specified value to the XrInstanceProperties#type field.

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

Sets the TYPE_INSTANCE_PROPERTIES value to the XrInstanceProperties#type field.