Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrExtensionProperties

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

Returns properties of available instance extensions.
Valid Usage (Implicit)
See Also

EnumerateInstanceExtensionProperties

Layout


struct XrExtensionProperties {
    XrStructureType type;
    void * next;
    char extensionName[XR_MAX_EXTENSION_NAME_SIZE];
    uint32_t extensionVersion;
}

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
EXTENSIONNAME

The struct member offsets.

public static final int
EXTENSIONVERSION

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.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
XrExtensionProperties(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrExtensionProperties
calloc()

Returns a new XrExtensionProperties instance allocated with memCalloc.

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

Returns a new XrExtensionProperties.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrExtensionProperties instance allocated with BufferUtils.

public static XrExtensionProperties
create(long address)

Returns a new XrExtensionProperties instance for the specified memory address.

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

Returns a new XrExtensionProperties.Buffer instance allocated with BufferUtils.

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

Create a XrExtensionProperties.Buffer instance at the specified memory.

public static XrExtensionProperties
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public ByteBuffer
extensionName()

a NULL terminated string specifying the name of the extension.

public String
extensionNameString()

a NULL terminated string specifying the name of the extension.

public int
extensionVersion()

the version of this extension.

public static XrExtensionProperties
malloc()

Returns a new XrExtensionProperties instance allocated with memAlloc.

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

Returns a new XrExtensionProperties.Buffer instance allocated with memAlloc.

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

Returns a new XrExtensionProperties instance allocated on the specified MemoryStack.

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

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

public long
next()

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

public XrExtensionProperties
next(long value)

Sets the specified value to the next field.

public static ByteBuffer
nextensionName(long struct)

Unsafe version of extensionName.

public static String
nextensionNameString(long struct)

Unsafe version of extensionNameString.

public static int
nextensionVersion(long struct)

Unsafe version of extensionVersion.

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 XrExtensionProperties
set(int type, long next)

Initializes this struct with the specified values.

public XrExtensionProperties

Returns:

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

Sets the specified value to the type field.

public XrExtensionProperties
type$Default()

Sets the TYPE_EXTENSION_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.

EXTENSIONNAMEback to summary
public static final int EXTENSIONNAME

The struct member offsets.

EXTENSIONVERSIONback to summary
public static final int EXTENSIONVERSION

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.

Constructor Detail

XrExtensionPropertiesback to summary
protected XrExtensionProperties(long address, ByteBuffer container)
XrExtensionPropertiesback to summary
public XrExtensionProperties(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrExtensionProperties calloc(MemoryStack stack)

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

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

Returns a new XrExtensionProperties instance allocated with BufferUtils.

createback to summary
public static XrExtensionProperties create(long address)

Returns a new XrExtensionProperties instance for the specified memory address.

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

Returns a new XrExtensionProperties.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrExtensionProperties.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrExtensionProperties createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
extensionNameback to summary
public ByteBuffer extensionName()

a NULL terminated string specifying the name of the extension.

Annotations
@NativeType:char[XR_MAX_EXTENSION_NAME_SIZE]
extensionNameStringback to summary
public String extensionNameString()

a NULL terminated string specifying the name of the extension.

Annotations
@NativeType:char[XR_MAX_EXTENSION_NAME_SIZE]
extensionVersionback to summary
public int extensionVersion()

the version of this extension. It is an integer, incremented with backward compatible changes.

Annotations
@NativeType:uint32_t
mallocback to summary
public static XrExtensionProperties malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrExtensionProperties malloc(MemoryStack stack)

Returns a new XrExtensionProperties instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Sets the specified value to the next field.

nextensionNameback to summary
public static ByteBuffer nextensionName(long struct)

Unsafe version of extensionName.

nextensionNameStringback to summary
public static String nextensionNameString(long struct)

Unsafe version of extensionNameString.

nextensionVersionback to summary
public static int nextensionVersion(long struct)

Unsafe version of extensionVersion.

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.

setback to summary
public XrExtensionProperties set(int type, long next)

Initializes this struct with the specified values.

setback to summary
public XrExtensionProperties set(XrExtensionProperties src)

Copies the specified struct data to this struct.

Parameters
src:XrExtensionProperties

the source struct

Returns:XrExtensionProperties

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

Sets the specified value to the type field.

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

Sets the TYPE_EXTENSION_PROPERTIES value to the type field.

org.lwjgl.openxr back to summary

public Class XrExtensionProperties.Buffer

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

An array of XrExtensionProperties structs.

Field Summary

Modifier and TypeField and Description
private static final XrExtensionProperties

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrExtensionProperties.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 ByteBuffer
public String

Returns:

the null-terminated string stored in the XrExtensionProperties#extensionName field.
extensionNameString
()

public int

Returns:

the value of the XrExtensionProperties#extensionVersion field.
extensionVersion
()

protected XrExtensionProperties
public long

Returns:

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

public XrExtensionProperties.Buffer
next(long value)

Sets the specified value to the XrExtensionProperties#next field.

protected XrExtensionProperties.Buffer
public int

Returns:

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

public XrExtensionProperties.Buffer
type(int value)

Sets the specified value to the XrExtensionProperties#type field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final XrExtensionProperties ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

extensionNameback to summary
public ByteBuffer extensionName()
Returns:ByteBuffer

a ByteBuffer view of the XrExtensionProperties#extensionName field.

Annotations
@NativeType:char[XR_MAX_EXTENSION_NAME_SIZE]
extensionNameStringback to summary
public String extensionNameString()
Returns:String

the null-terminated string stored in the XrExtensionProperties#extensionName field.

Annotations
@NativeType:char[XR_MAX_EXTENSION_NAME_SIZE]
extensionVersionback to summary
public int extensionVersion()
Returns:int

the value of the XrExtensionProperties#extensionVersion field.

Annotations
@NativeType:uint32_t
getElementFactoryback to summary
protected XrExtensionProperties getElementFactory()

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

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

the value of the XrExtensionProperties#next field.

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

Sets the specified value to the XrExtensionProperties#next field.

selfback to summary
protected XrExtensionProperties.Buffer self()

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

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

the value of the XrExtensionProperties#type field.

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

Sets the specified value to the XrExtensionProperties#type field.

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

Sets the TYPE_EXTENSION_PROPERTIES value to the XrExtensionProperties#type field.