applicationName must be a null-terminated UTF-8 string whose length is less than or equal to MAX_APPLICATION_NAME_SIZEengineName must be a null-terminated UTF-8 string whose length is less than or equal to MAX_ENGINE_NAME_SIZEWhen using the OpenXR API to implement a reusable engine that will be used by many applications, engineName should be set to a unique string that identifies the engine, and engineVersion should encode a representation of the engine’s version. This way, all applications that share this engine version will provide the same engineName and engineVersion to the runtime. The engine should then enable individual applications to choose their specific applicationName and applicationVersion, enabling one application to be distinguished from another application.
When using the OpenXR API to implement an individual application without a shared engine, the input engineName should be left empty and engineVersion should be set to 0. The applicationName should then be filled in with a unique string that identifies the app and the applicationVersion should encode a representation of the application’s version.
struct XrApplicationInfo {
char applicationName[XR_MAX_APPLICATION_NAME_SIZE];
uint32_t applicationVersion;
char engineName[XR_MAX_ENGINE_NAME_SIZE];
uint32_t engineVersion;
XrVersion apiVersion;
}
| Modifier and Type | Class and Description |
|---|---|
| public static class | XrApplicationInfo.
An array of |
| Modifier and Type | Field and Description |
|---|---|
| public static final int | ALIGNOF
The struct alignment in bytes. |
| public static final int | APIVERSION
The struct member offsets. |
| public static final int | APPLICATIONNAME
The struct member offsets. |
| public static final int | APPLICATIONVERSION
The struct member offsets. |
| public static final int | ENGINENAME
The struct member offsets. |
| public static final int | ENGINEVERSION
The struct member offsets. |
| public static final int | SIZEOF
The struct size in bytes. |
| Access | Constructor and Description |
|---|---|
| protected | |
| public | XrApplicationInfo(ByteBuffer container)
Creates a |
| Modifier and Type | Method and Description |
|---|---|
| public long | apiVersion()
the version of this API against which the application will run, encoded as described in the API Version Numbers and Semantics section. |
| public XrApplicationInfo | |
| public ByteBuffer | |
| public XrApplicationInfo | |
| public String | |
| public int | applicationVersion()
an unsigned integer variable containing the developer-supplied version number of the application. |
| public XrApplicationInfo | |
| public static XrApplicationInfo | |
| public static XrApplicationInfo. | calloc(int
the buffer capacity capacity)Returns a new |
| public static XrApplicationInfo | calloc(MemoryStack
the stack from which to allocate stack)Returns a new |
| public static XrApplicationInfo. | calloc(int
the buffer capacity capacity, MemoryStack the stack from which to allocate stack)Returns a new |
| protected XrApplicationInfo | create(long
the struct memory address address, ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. container)Implements abstract org. the constructor, but returns the exact type of the Struct subclass.
|
| public static XrApplicationInfo | |
| public static XrApplicationInfo | |
| public static XrApplicationInfo. | create(int
the buffer capacity capacity)Returns a new |
| public static XrApplicationInfo. | create(long
the memory address address, int the buffer capacity capacity)Create a |
| public static XrApplicationInfo | |
| public static XrApplicationInfo. | |
| public ByteBuffer | |
| public XrApplicationInfo | |
| public String | engineNameString()
a string containing the name of the engine (if any) used to create the application. |
| public int | engineVersion()
an unsigned integer variable containing the developer-supplied version number of the engine used to create the application. |
| public XrApplicationInfo | |
| public static XrApplicationInfo | |
| public static XrApplicationInfo. | malloc(int
the buffer capacity capacity)Returns a new |
| public static XrApplicationInfo | malloc(MemoryStack
the stack from which to allocate stack)Returns a new |
| public static XrApplicationInfo. | malloc(int
the buffer capacity capacity, MemoryStack the stack from which to allocate stack)Returns a new |
| public static long | |
| public static void | |
| public static ByteBuffer | |
| public static void | |
| public static String | |
| public static int | |
| public static void | |
| public static ByteBuffer | |
| public static void | |
| public static String | |
| public static int | |
| public static void | |
| public XrApplicationInfo | set(ByteBuffer applicationName, int applicationVersion, ByteBuffer engineName, int engineVersion, long apiVersion)
Initializes this struct with the specified values. |
| public XrApplicationInfo | Returns: this structthe source struct src)Copies the specified struct data to this struct. |
| public int |
| ALIGNOF | back to summary |
|---|---|
| public static final int ALIGNOF The struct alignment in bytes. | |
| APIVERSION | back to summary |
|---|---|
| public static final int APIVERSION The struct member offsets. | |
| APPLICATIONNAME | back to summary |
|---|---|
| public static final int APPLICATIONNAME The struct member offsets. | |
| APPLICATIONVERSION | back to summary |
|---|---|
| public static final int APPLICATIONVERSION The struct member offsets. | |
| ENGINENAME | back to summary |
|---|---|
| public static final int ENGINENAME The struct member offsets. | |
| ENGINEVERSION | back to summary |
|---|---|
| public static final int ENGINEVERSION The struct member offsets. | |
| SIZEOF | back to summary |
|---|---|
| public static final int SIZEOF The struct size in bytes. | |
| XrApplicationInfo | back to summary |
|---|---|
| protected XrApplicationInfo(long address, ByteBuffer container) | |
| XrApplicationInfo | back to summary |
|---|---|
| public XrApplicationInfo(ByteBuffer container) Creates a The created instance holds a strong reference to the container object. | |
| apiVersion | back to summary |
|---|---|
| public long apiVersion() the version of this API against which the application will run, encoded as described in the API Version Numbers and Semantics section. If the runtime does not support the requested
| |
| apiVersion | back to summary |
|---|---|
| public XrApplicationInfo apiVersion(long value) Sets the specified value to the | |
| applicationName | back to summary |
|---|---|
| public ByteBuffer applicationName() a non-empty string containing the name of the application.
| |
| applicationName | back to summary |
|---|---|
| public XrApplicationInfo applicationName(ByteBuffer value) Copies the specified encoded string to the | |
| applicationNameString | back to summary |
|---|---|
| public String applicationNameString() a non-empty string containing the name of the application.
| |
| applicationVersion | back to summary |
|---|---|
| public int applicationVersion() an unsigned integer variable containing the developer-supplied version number of the application.
| |
| applicationVersion | back to summary |
|---|---|
| public XrApplicationInfo applicationVersion(int value) Sets the specified value to the | |
| calloc | back to summary |
|---|---|
| public static XrApplicationInfo calloc() Returns a new | |
| calloc | back to summary |
|---|---|
| public static XrApplicationInfo. Returns a new
| |
| calloc | back to summary |
|---|---|
| public static XrApplicationInfo calloc(MemoryStack stack) Returns a new
| |
| calloc | back to summary |
|---|---|
| public static XrApplicationInfo. Returns a new
| |
| create | back to summary |
|---|---|
| protected XrApplicationInfo create(long address, ByteBuffer container) Implements abstract org. Doc from org. Similar to Effectively, every
| |
| create | back to summary |
|---|---|
| public static XrApplicationInfo create() Returns a new | |
| create | back to summary |
|---|---|
| public static XrApplicationInfo create(long address) Returns a new | |
| create | back to summary |
|---|---|
| public static XrApplicationInfo. Returns a new
| |
| create | back to summary |
|---|---|
| public static XrApplicationInfo. Create a
| |
| createSafe | back to summary |
|---|---|
| public static XrApplicationInfo createSafe(long address) Like
| |
| createSafe | back to summary |
|---|---|
| public static XrApplicationInfo. Like
| |
| engineName | back to summary |
|---|---|
| public ByteBuffer engineName() a string containing the name of the engine (if any) used to create the application. It may be empty to indicate no specified engine.
| |
| engineName | back to summary |
|---|---|
| public XrApplicationInfo engineName(ByteBuffer value) Copies the specified encoded string to the | |
| engineNameString | back to summary |
|---|---|
| public String engineNameString() a string containing the name of the engine (if any) used to create the application. It may be empty to indicate no specified engine.
| |
| engineVersion | back to summary |
|---|---|
| public int engineVersion() an unsigned integer variable containing the developer-supplied version number of the engine used to create the application. May be zero to indicate no specified engine.
| |
| engineVersion | back to summary |
|---|---|
| public XrApplicationInfo engineVersion(int value) Sets the specified value to the | |
| malloc | back to summary |
|---|---|
| public static XrApplicationInfo malloc() Returns a new | |
| malloc | back to summary |
|---|---|
| public static XrApplicationInfo. Returns a new
| |
| malloc | back to summary |
|---|---|
| public static XrApplicationInfo malloc(MemoryStack stack) Returns a new
| |
| malloc | back to summary |
|---|---|
| public static XrApplicationInfo. Returns a new
| |
| napiVersion | back to summary |
|---|---|
| public static long napiVersion(long struct) Unsafe version of | |
| napiVersion | back to summary |
|---|---|
| public static void napiVersion(long struct, long value) Unsafe version of | |
| napplicationName | back to summary |
|---|---|
| public static ByteBuffer napplicationName(long struct) Unsafe version of | |
| napplicationName | back to summary |
|---|---|
| public static void napplicationName(long struct, ByteBuffer value) Unsafe version of | |
| napplicationNameString | back to summary |
|---|---|
| public static String napplicationNameString(long struct) Unsafe version of | |
| napplicationVersion | back to summary |
|---|---|
| public static int napplicationVersion(long struct) Unsafe version of | |
| napplicationVersion | back to summary |
|---|---|
| public static void napplicationVersion(long struct, int value) Unsafe version of | |
| nengineName | back to summary |
|---|---|
| public static ByteBuffer nengineName(long struct) Unsafe version of | |
| nengineName | back to summary |
|---|---|
| public static void nengineName(long struct, ByteBuffer value) Unsafe version of | |
| nengineNameString | back to summary |
|---|---|
| public static String nengineNameString(long struct) Unsafe version of | |
| nengineVersion | back to summary |
|---|---|
| public static int nengineVersion(long struct) Unsafe version of | |
| nengineVersion | back to summary |
|---|---|
| public static void nengineVersion(long struct, int value) Unsafe version of | |
| set | back to summary |
|---|---|
| public XrApplicationInfo set(ByteBuffer applicationName, int applicationVersion, ByteBuffer engineName, int engineVersion, long apiVersion) Initializes this struct with the specified values. | |
| set | back to summary |
|---|---|
| public XrApplicationInfo set(XrApplicationInfo src) Copies the specified struct data to this struct.
| |
| sizeof | back to summary |
|---|---|
| public int sizeof() Implements abstract org. Doc from org. Returns
| |
XrApplicationInfo structs.
| Modifier and Type | Field and Description |
|---|---|
| private static final XrApplicationInfo |
| Access | Constructor and Description |
|---|---|
| public | Buffer(ByteBuffer container)
Creates a new |
| public | |
| pack-priv |
| Modifier and Type | Method and Description |
|---|---|
| public long | |
| public XrApplicationInfo. | |
| public ByteBuffer | |
| public XrApplicationInfo. | applicationName(ByteBuffer value)
Copies the specified encoded string to the |
| public String | Returns: the null-terminated string stored in theXrApplicationInfo#applicationName field.
|
| public int | |
| public XrApplicationInfo. | applicationVersion(int value)
Sets the specified value to the |
| public ByteBuffer | |
| public XrApplicationInfo. | engineName(ByteBuffer value)
Copies the specified encoded string to the |
| public String | Returns: the null-terminated string stored in theXrApplicationInfo#engineName field.
|
| public int | |
| public XrApplicationInfo. | |
| protected XrApplicationInfo | |
| protected XrApplicationInfo. |
| ELEMENT_FACTORY | back to summary |
|---|---|
| private static final XrApplicationInfo ELEMENT_FACTORY | |
| Buffer | back to summary |
|---|---|
| public Buffer(ByteBuffer container) Creates a new 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 The created buffer instance holds a strong reference to the container object. | |
| Buffer | back to summary |
|---|---|
| public Buffer(long address, int cap) | |
| Buffer | back to summary |
|---|---|
| pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap) | |
| apiVersion | back to summary |
|---|---|
public long apiVersion()
| |
| apiVersion | back to summary |
|---|---|
| public XrApplicationInfo. Sets the specified value to the | |
| applicationName | back to summary |
|---|---|
public ByteBuffer applicationName()
| |
| applicationName | back to summary |
|---|---|
| public XrApplicationInfo. Copies the specified encoded string to the | |
| applicationNameString | back to summary |
|---|---|
public String applicationNameString()
| |
| applicationVersion | back to summary |
|---|---|
public int applicationVersion()
| |
| applicationVersion | back to summary |
|---|---|
| public XrApplicationInfo. Sets the specified value to the | |
| engineName | back to summary |
|---|---|
public ByteBuffer engineName()
| |
| engineName | back to summary |
|---|---|
| public XrApplicationInfo. Copies the specified encoded string to the | |
| engineNameString | back to summary |
|---|---|
public String engineNameString()
| |
| engineVersion | back to summary |
|---|---|
public int engineVersion()
| |
| engineVersion | back to summary |
|---|---|
| public XrApplicationInfo. Sets the specified value to the | |
| getElementFactory | back to summary |
|---|---|
| protected XrApplicationInfo getElementFactory() Implements abstract org.
| |
| self | back to summary |
|---|---|
| protected XrApplicationInfo. Implements abstract org.
| |