Package org.lwjgl.openxr
Class XrApiLayerProperties
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.openxr.XrApiLayerProperties
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class XrApiLayerProperties extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceStructure specifying layer properties.Valid Usage (Implicit)
typemust beTYPE_API_LAYER_PROPERTIESnextmust beNULLor a valid pointer to the next structure in a structure chain
See Also
Layout
struct XrApiLayerProperties { XrStructureTypetype(); void *next(); charlayerName()[XR_MAX_API_LAYER_NAME_SIZE]; XrVersionspecVersion(); uint32_tlayerVersion(); chardescription()[XR_MAX_API_LAYER_DESCRIPTION_SIZE]; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classXrApiLayerProperties.BufferAn array ofXrApiLayerPropertiesstructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intDESCRIPTION
LAYERNAME
LAYERVERSION
NEXTThe struct member offsets.static intSIZEOFThe struct size in bytes.static intSPECVERSION
TYPEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description XrApiLayerProperties(java.nio.ByteBuffer container)Creates aXrApiLayerPropertiesinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static XrApiLayerPropertiescalloc()Returns a newXrApiLayerPropertiesinstance allocated withmemCalloc.static XrApiLayerProperties.Buffercalloc(int capacity)Returns a newXrApiLayerProperties.Bufferinstance allocated withmemCalloc.static XrApiLayerProperties.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newXrApiLayerProperties.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static XrApiLayerPropertiescalloc(org.lwjgl.system.MemoryStack stack)Returns a newXrApiLayerPropertiesinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static XrApiLayerPropertiescreate()Returns a newXrApiLayerPropertiesinstance allocated withBufferUtils.static XrApiLayerProperties.Buffercreate(int capacity)Returns a newXrApiLayerProperties.Bufferinstance allocated withBufferUtils.static XrApiLayerPropertiescreate(long address)Returns a newXrApiLayerPropertiesinstance for the specified memory address.static XrApiLayerProperties.Buffercreate(long address, int capacity)Create aXrApiLayerProperties.Bufferinstance at the specified memory.static XrApiLayerPropertiescreateSafe(long address)static XrApiLayerProperties.BuffercreateSafe(long address, int capacity)java.nio.ByteBufferdescription()a string providing additional details that can be used by the application to identify the API layer.java.lang.StringdescriptionString()a string providing additional details that can be used by the application to identify the API layer.java.nio.ByteBufferlayerName()a string specifying the name of the API layer.java.lang.StringlayerNameString()a string specifying the name of the API layer.intlayerVersion()the version of this API layer.static XrApiLayerPropertiesmalloc()Returns a newXrApiLayerPropertiesinstance allocated withmemAlloc.static XrApiLayerProperties.Buffermalloc(int capacity)Returns a newXrApiLayerProperties.Bufferinstance allocated withmemAlloc.static XrApiLayerProperties.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newXrApiLayerProperties.Bufferinstance allocated on the specifiedMemoryStack.static XrApiLayerPropertiesmalloc(org.lwjgl.system.MemoryStack stack)Returns a newXrApiLayerPropertiesinstance allocated on the specifiedMemoryStack.static java.nio.ByteBufferndescription(long struct)Unsafe version ofdescription().static java.lang.StringndescriptionString(long struct)Unsafe version ofdescriptionString().longnext()NULLor a pointer to the next structure in a structure chain.XrApiLayerPropertiesnext(long value)Sets the specified value to thenext()field.static java.nio.ByteBuffernlayerName(long struct)Unsafe version oflayerName().static java.lang.StringnlayerNameString(long struct)Unsafe version oflayerNameString().static intnlayerVersion(long struct)Unsafe version oflayerVersion().static longnnext(long struct)Unsafe version ofnext().static voidnnext(long struct, long value)Unsafe version ofnext.static longnspecVersion(long struct)Unsafe version ofspecVersion().static intntype(long struct)Unsafe version oftype().static voidntype(long struct, int value)Unsafe version oftype.XrApiLayerPropertiesset(int type, long next)Initializes this struct with the specified values.XrApiLayerPropertiesset(XrApiLayerProperties src)Copies the specified struct data to this struct.intsizeof()longspecVersion()the API version the API layer was written to, encoded as described in the API Version Numbers and Semantics section.inttype()theXrStructureTypeof this structure.XrApiLayerPropertiestype(int value)Sets the specified value to thetype()field.XrApiLayerPropertiestype$Default()Sets theTYPE_API_LAYER_PROPERTIESvalue to thetype()field.
-
-
-
Constructor Detail
-
XrApiLayerProperties
public XrApiLayerProperties(java.nio.ByteBuffer container)
Creates aXrApiLayerPropertiesinstance at the current position of the specifiedByteBuffercontainer. 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
-
sizeof
public int sizeof()
- Specified by:
sizeofin classorg.lwjgl.system.Struct
-
type
public int type()
theXrStructureTypeof this structure.
-
next
public long next()
NULLor a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR.
-
layerName, layerNameString
public java.nio.ByteBuffer layerName() public java.lang.String layerNameString()
a string specifying the name of the API layer. Use this name in theXrInstanceCreateInfo::enabledApiLayerNamesarray to enable this API layer for an instance.
-
specVersion
public long specVersion()
the API version the API layer was written to, encoded as described in the API Version Numbers and Semantics section.
-
layerVersion
public int layerVersion()
the version of this API layer. It is an integer, increasing with backward compatible changes.
-
description, descriptionString
public java.nio.ByteBuffer description() public java.lang.String descriptionString()
a string providing additional details that can be used by the application to identify the API layer.
-
type
public XrApiLayerProperties type(int value)
Sets the specified value to thetype()field.
-
type$Default
public XrApiLayerProperties type$Default()
Sets theTYPE_API_LAYER_PROPERTIESvalue to thetype()field.
-
next
public XrApiLayerProperties next(long value)
Sets the specified value to thenext()field.
-
set
public XrApiLayerProperties set(int type, long next)
Initializes this struct with the specified values.
-
set
public XrApiLayerProperties set(XrApiLayerProperties src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static XrApiLayerProperties malloc()
Returns a newXrApiLayerPropertiesinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static XrApiLayerProperties calloc()
Returns a newXrApiLayerPropertiesinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static XrApiLayerProperties create()
Returns a newXrApiLayerPropertiesinstance allocated withBufferUtils.
-
create
public static XrApiLayerProperties create(long address)
Returns a newXrApiLayerPropertiesinstance for the specified memory address.
-
createSafe
@Nullable public static XrApiLayerProperties createSafe(long address)
-
malloc
public static XrApiLayerProperties.Buffer malloc(int capacity)
Returns a newXrApiLayerProperties.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static XrApiLayerProperties.Buffer calloc(int capacity)
Returns a newXrApiLayerProperties.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static XrApiLayerProperties.Buffer create(int capacity)
Returns a newXrApiLayerProperties.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static XrApiLayerProperties.Buffer create(long address, int capacity)
Create aXrApiLayerProperties.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static XrApiLayerProperties.Buffer createSafe(long address, int capacity)
-
malloc
public static XrApiLayerProperties malloc(org.lwjgl.system.MemoryStack stack)
Returns a newXrApiLayerPropertiesinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static XrApiLayerProperties calloc(org.lwjgl.system.MemoryStack stack)
Returns a newXrApiLayerPropertiesinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static XrApiLayerProperties.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newXrApiLayerProperties.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static XrApiLayerProperties.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newXrApiLayerProperties.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
ntype
public static int ntype(long struct)
Unsafe version oftype().
-
nnext
public static long nnext(long struct)
Unsafe version ofnext().
-
nlayerName
public static java.nio.ByteBuffer nlayerName(long struct)
Unsafe version oflayerName().
-
nlayerNameString
public static java.lang.String nlayerNameString(long struct)
Unsafe version oflayerNameString().
-
nspecVersion
public static long nspecVersion(long struct)
Unsafe version ofspecVersion().
-
nlayerVersion
public static int nlayerVersion(long struct)
Unsafe version oflayerVersion().
-
ndescription
public static java.nio.ByteBuffer ndescription(long struct)
Unsafe version ofdescription().
-
ndescriptionString
public static java.lang.String ndescriptionString(long struct)
Unsafe version ofdescriptionString().
-
ntype
public static void ntype(long struct, int value)Unsafe version oftype.
-
nnext
public static void nnext(long struct, long value)Unsafe version ofnext.
-
-