Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrApiLayerProperties

extends Struct<XrApiLayerProperties>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
Structure specifying layer properties.
Valid Usage (Implicit)
See Also

EnumerateApiLayerProperties

Layout


struct XrApiLayerProperties {
    XrStructureType type;
    void * next;
    char layerName[XR_MAX_API_LAYER_NAME_SIZE];
    XrVersion specVersion;
    uint32_t layerVersion;
    char description[XR_MAX_API_LAYER_DESCRIPTION_SIZE];
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
XrApiLayerProperties.Buffer

An array of XrApiLayerProperties structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
DESCRIPTION

The struct member offsets.

public static final int
LAYERNAME

The struct member offsets.

public static final int
LAYERVERSION

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
SPECVERSION

The struct member offsets.

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
XrApiLayerProperties(long address, ByteBuffer container)

public
XrApiLayerProperties(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrApiLayerProperties
calloc()

Returns a new XrApiLayerProperties instance allocated with memCalloc.

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

Returns a new XrApiLayerProperties.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrApiLayerProperties instance allocated with BufferUtils.

public static XrApiLayerProperties
create(long address)

Returns a new XrApiLayerProperties instance for the specified memory address.

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

Returns a new XrApiLayerProperties.Buffer instance allocated with BufferUtils.

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

Create a XrApiLayerProperties.Buffer instance at the specified memory.

public static XrApiLayerProperties
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public ByteBuffer
description()

a string providing additional details that can be used by the application to identify the API layer.

public String
descriptionString()

a string providing additional details that can be used by the application to identify the API layer.

public ByteBuffer
layerName()

a string specifying the name of the API layer.

public String
layerNameString()

a string specifying the name of the API layer.

public int
layerVersion()

the version of this API layer.

public static XrApiLayerProperties
malloc()

Returns a new XrApiLayerProperties instance allocated with memAlloc.

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

Returns a new XrApiLayerProperties.Buffer instance allocated with memAlloc.

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

Returns a new XrApiLayerProperties instance allocated on the specified MemoryStack.

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

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

public static ByteBuffer
ndescription(long struct)

Unsafe version of description.

public static String
ndescriptionString(long struct)

Unsafe version of descriptionString.

public long
next()

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

public XrApiLayerProperties
next(long value)

Sets the specified value to the next field.

public static ByteBuffer
nlayerName(long struct)

Unsafe version of layerName.

public static String
nlayerNameString(long struct)

Unsafe version of layerNameString.

public static int
nlayerVersion(long struct)

Unsafe version of layerVersion.

public static long
nnext(long struct)

Unsafe version of next.

public static void
nnext(long struct, long value)

Unsafe version of next.

public static long
nspecVersion(long struct)

Unsafe version of specVersion.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public XrApiLayerProperties
set(int type, long next)

Initializes this struct with the specified values.

public XrApiLayerProperties

Returns:

this struct
set(XrApiLayerProperties
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 long
specVersion()

the API version the API layer was written to, encoded as described in the API Version Numbers and Semantics section.

public int
type()

the XrStructureType of this structure.

public XrApiLayerProperties
type(int value)

Sets the specified value to the type field.

public XrApiLayerProperties
type$Default()

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

DESCRIPTIONback to summary
public static final int DESCRIPTION

The struct member offsets.

LAYERNAMEback to summary
public static final int LAYERNAME

The struct member offsets.

LAYERVERSIONback to summary
public static final int LAYERVERSION

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.

SPECVERSIONback to summary
public static final int SPECVERSION

The struct member offsets.

TYPEback to summary
public static final int TYPE

The struct member offsets.

Constructor Detail

XrApiLayerPropertiesback to summary
protected XrApiLayerProperties(long address, ByteBuffer container)
XrApiLayerPropertiesback to summary
public XrApiLayerProperties(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrApiLayerProperties calloc(MemoryStack stack)

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

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

Returns a new XrApiLayerProperties instance allocated with BufferUtils.

createback to summary
public static XrApiLayerProperties create(long address)

Returns a new XrApiLayerProperties instance for the specified memory address.

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

Returns a new XrApiLayerProperties.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrApiLayerProperties.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrApiLayerProperties createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
descriptionback to summary
public ByteBuffer description()

a string providing additional details that can be used by the application to identify the API layer.

Annotations
@NativeType:char[XR_MAX_API_LAYER_DESCRIPTION_SIZE]
descriptionStringback to summary
public String descriptionString()

a string providing additional details that can be used by the application to identify the API layer.

Annotations
@NativeType:char[XR_MAX_API_LAYER_DESCRIPTION_SIZE]
layerNameback to summary
public ByteBuffer layerName()

a string specifying the name of the API layer. Use this name in the XrInstanceCreateInfo::enabledApiLayerNames array to enable this API layer for an instance.

Annotations
@NativeType:char[XR_MAX_API_LAYER_NAME_SIZE]
layerNameStringback to summary
public String layerNameString()

a string specifying the name of the API layer. Use this name in the XrInstanceCreateInfo::enabledApiLayerNames array to enable this API layer for an instance.

Annotations
@NativeType:char[XR_MAX_API_LAYER_NAME_SIZE]
layerVersionback to summary
public int layerVersion()

the version of this API layer. It is an integer, increasing with backward compatible changes.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrApiLayerProperties malloc(MemoryStack stack)

Returns a new XrApiLayerProperties instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

ndescriptionback to summary
public static ByteBuffer ndescription(long struct)

Unsafe version of description.

ndescriptionStringback to summary
public static String ndescriptionString(long struct)

Unsafe version of descriptionString.

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 XrApiLayerProperties next(long value)

Sets the specified value to the next field.

nlayerNameback to summary
public static ByteBuffer nlayerName(long struct)

Unsafe version of layerName.

nlayerNameStringback to summary
public static String nlayerNameString(long struct)

Unsafe version of layerNameString.

nlayerVersionback to summary
public static int nlayerVersion(long struct)

Unsafe version of layerVersion.

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.

nspecVersionback to summary
public static long nspecVersion(long struct)

Unsafe version of specVersion.

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

Initializes this struct with the specified values.

setback to summary
public XrApiLayerProperties set(XrApiLayerProperties src)

Copies the specified struct data to this struct.

Parameters
src:XrApiLayerProperties

the source struct

Returns:XrApiLayerProperties

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
specVersionback to summary
public long specVersion()

the API version the API layer was written to, encoded as described in the API Version Numbers and Semantics section.

Annotations
@NativeType:XrVersion
typeback to summary
public int type()

the XrStructureType of this structure.

Annotations
@NativeType:XrStructureType
typeback to summary
public XrApiLayerProperties type(int value)

Sets the specified value to the type field.

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

Sets the TYPE_API_LAYER_PROPERTIES value to the type field.

org.lwjgl.openxr back to summary

public Class XrApiLayerProperties.Buffer

extends StructBuffer<XrApiLayerProperties, XrApiLayerProperties.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
An array of XrApiLayerProperties structs.

Field Summary

Modifier and TypeField and Description
private static final XrApiLayerProperties
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

Returns:

a ByteBuffer view of the XrApiLayerProperties#description field.
description()

public String

Returns:

the null-terminated string stored in the XrApiLayerProperties#description field.
descriptionString()

protected XrApiLayerProperties
getElementFactory()

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

public ByteBuffer

Returns:

a ByteBuffer view of the XrApiLayerProperties#layerName field.
layerName()

public String

Returns:

the null-terminated string stored in the XrApiLayerProperties#layerName field.
layerNameString()

public int

Returns:

the value of the XrApiLayerProperties#layerVersion field.
layerVersion()

public long

Returns:

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

public XrApiLayerProperties.Buffer
next(long value)

Sets the specified value to the XrApiLayerProperties#next field.

protected XrApiLayerProperties.Buffer
self()

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

public long

Returns:

the value of the XrApiLayerProperties#specVersion field.
specVersion()

public int

Returns:

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

public XrApiLayerProperties.Buffer
type(int value)

Sets the specified value to the XrApiLayerProperties#type field.

public XrApiLayerProperties.Buffer
type$Default()

Sets the TYPE_API_LAYER_PROPERTIES value to the XrApiLayerProperties#type field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XrApiLayerProperties ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

descriptionback to summary
public ByteBuffer description()
Returns:ByteBuffer

a ByteBuffer view of the XrApiLayerProperties#description field.

Annotations
@NativeType:char[XR_MAX_API_LAYER_DESCRIPTION_SIZE]
descriptionStringback to summary
public String descriptionString()
Returns:String

the null-terminated string stored in the XrApiLayerProperties#description field.

Annotations
@NativeType:char[XR_MAX_API_LAYER_DESCRIPTION_SIZE]
getElementFactoryback to summary
protected XrApiLayerProperties getElementFactory()

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

Annotations
@Override
layerNameback to summary
public ByteBuffer layerName()
Returns:ByteBuffer

a ByteBuffer view of the XrApiLayerProperties#layerName field.

Annotations
@NativeType:char[XR_MAX_API_LAYER_NAME_SIZE]
layerNameStringback to summary
public String layerNameString()
Returns:String

the null-terminated string stored in the XrApiLayerProperties#layerName field.

Annotations
@NativeType:char[XR_MAX_API_LAYER_NAME_SIZE]
layerVersionback to summary
public int layerVersion()
Returns:int

the value of the XrApiLayerProperties#layerVersion field.

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

the value of the XrApiLayerProperties#next field.

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

Sets the specified value to the XrApiLayerProperties#next field.

selfback to summary
protected XrApiLayerProperties.Buffer self()

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

Annotations
@Override
specVersionback to summary
public long specVersion()
Returns:long

the value of the XrApiLayerProperties#specVersion field.

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

the value of the XrApiLayerProperties#type field.

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

Sets the specified value to the XrApiLayerProperties#type field.

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

Sets the TYPE_API_LAYER_PROPERTIES value to the XrApiLayerProperties#type field.