VkApplicationInfo (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkApplicationInfo

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkApplicationInfo
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying application info.
Description

Vulkan 1.0 implementations were required to return ERROR_INCOMPATIBLE_DRIVER if apiVersion was larger than 1.0. Implementations that support Vulkan 1.1 or later must not return ERROR_INCOMPATIBLE_DRIVER for any value of apiVersion.

Note

Because Vulkan 1.0 implementations may fail with ERROR_INCOMPATIBLE_DRIVER, applications should determine the version of Vulkan available before calling CreateInstance. If the GetInstanceProcAddr returns NULL for EnumerateInstanceVersion, it is a Vulkan 1.0 implementation. Otherwise, the application can call EnumerateInstanceVersion to determine the version of Vulkan.

As long as the instance supports at least Vulkan 1.1, an application can use different versions of Vulkan with an instance than it does with a device or physical device.
Note

The Khronos validation layers will treat apiVersion as the highest API version the application targets, and will validate API usage against the minimum of that version and the implementation version (instance or device, depending on context). If an application tries to use functionality from a greater version than this, a validation error will be triggered.

For example, if the instance supports Vulkan 1.1 and three physical devices support Vulkan 1.0, Vulkan 1.1, and a hypothetical Vulkan 1.2, respectively, and if the application sets apiVersion to 1.2, the application can use the following versions of Vulkan:
- Vulkan 1.0 can be used with the instance and with all physical devices.
- Vulkan 1.1 can be used with the instance and with the physical devices that support Vulkan 1.1 and Vulkan 1.2.
- Vulkan 1.2 can be used with the physical device that supports Vulkan 1.2.
If we modify the above example so that the application sets apiVersion to 1.1, then the application must not use Vulkan 1.2 functionality on the physical device that supports Vulkan 1.2.
Implicit layers must be disabled if they do not support a version at least as high as apiVersion. See the Vulkan Loader Specification and Architecture Overview document for additional information.

Note

Providing a NULL VkInstanceCreateInfo::pApplicationInfo or providing an apiVersion of 0 is equivalent to providing an apiVersion of VK_MAKE_VERSION(1,0,0).

Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_APPLICATION_INFO
- pNext must be NULL
- If pApplicationName is not NULL, pApplicationName must be a null-terminated UTF-8 string
- If pEngineName is not NULL, pEngineName must be a null-terminated UTF-8 string
See Also

VkInstanceCreateInfo

Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- pApplicationName – NULL or is a pointer to a null-terminated UTF-8 string containing the name of the application.
- applicationVersion – an unsigned integer variable containing the developer-supplied version number of the application.
- pEngineName – NULL or is a pointer to a null-terminated UTF-8 string containing the name of the engine (if any) used to create the application.
- engineVersion – an unsigned integer variable containing the developer-supplied version number of the engine used to create the application.
- apiVersion – must be the highest version of Vulkan that the application is designed to use, encoded as described in Version Numbers. The patch version number specified in apiVersion is ignored when creating an instance object. Only the major and minor versions of the instance must match those requested in apiVersion.
Layout
```
 struct VkApplicationInfo {
     VkStructureType sType;
     void const * pNext;
     char const * pApplicationName;
     uint32_t applicationVersion;
     char const * pEngineName;
     uint32_t engineVersion;
     uint32_t apiVersion;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkApplicationInfo.Buffer
An array of VkApplicationInfo structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`VkApplicationInfo.Buffer` An array of `VkApplicationInfo` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`APIVERSION` The struct member offsets.
`static int`	`APPLICATIONVERSION` The struct member offsets.
`static int`	`ENGINEVERSION` The struct member offsets.
`static int`	`PAPPLICATIONNAME` The struct member offsets.
`static int`	`PENGINENAME` The struct member offsets.
`static int`	`PNEXT` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`STYPE` The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description

VkApplicationInfo(java.nio.ByteBuffer container)
Creates a VkApplicationInfo instance at the current position of the specified ByteBuffer container.

Constructors
Constructor and Description
`VkApplicationInfo(java.nio.ByteBuffer container)` Creates a `VkApplicationInfo` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`apiVersion()` Returns the value of the `apiVersion` field.
`VkApplicationInfo`	`apiVersion(int value)` Sets the specified value to the `apiVersion` field.
`int`	`applicationVersion()` Returns the value of the `applicationVersion` field.
`VkApplicationInfo`	`applicationVersion(int value)` Sets the specified value to the `applicationVersion` field.
`static VkApplicationInfo`	`calloc()` Returns a new `VkApplicationInfo` instance allocated with `memCalloc`.
`static VkApplicationInfo.Buffer`	`calloc(int capacity)` Returns a new `VkApplicationInfo.Buffer` instance allocated with `memCalloc`.
`static VkApplicationInfo`	`callocStack()` Returns a new `VkApplicationInfo` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkApplicationInfo.Buffer`	`callocStack(int capacity)` Returns a new `VkApplicationInfo.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkApplicationInfo.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkApplicationInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkApplicationInfo`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkApplicationInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkApplicationInfo`	`create()` Returns a new `VkApplicationInfo` instance allocated with `BufferUtils`.
`static VkApplicationInfo.Buffer`	`create(int capacity)` Returns a new `VkApplicationInfo.Buffer` instance allocated with `BufferUtils`.
`static VkApplicationInfo`	`create(long address)` Returns a new `VkApplicationInfo` instance for the specified memory address.
`static VkApplicationInfo.Buffer`	`create(long address, int capacity)` Create a `VkApplicationInfo.Buffer` instance at the specified memory.
`static VkApplicationInfo`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkApplicationInfo.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`engineVersion()` Returns the value of the `engineVersion` field.
`VkApplicationInfo`	`engineVersion(int value)` Sets the specified value to the `engineVersion` field.
`static VkApplicationInfo`	`malloc()` Returns a new `VkApplicationInfo` instance allocated with `memAlloc`.
`static VkApplicationInfo.Buffer`	`malloc(int capacity)` Returns a new `VkApplicationInfo.Buffer` instance allocated with `memAlloc`.
`static VkApplicationInfo`	`mallocStack()` Returns a new `VkApplicationInfo` instance allocated on the thread-local `MemoryStack`.
`static VkApplicationInfo.Buffer`	`mallocStack(int capacity)` Returns a new `VkApplicationInfo.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkApplicationInfo.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkApplicationInfo.Buffer` instance allocated on the specified `MemoryStack`.
`static VkApplicationInfo`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkApplicationInfo` instance allocated on the specified `MemoryStack`.
`static int`	`napiVersion(long struct)` Unsafe version of `apiVersion()`.
`static void`	`napiVersion(long struct, int value)` Unsafe version of `apiVersion`.
`static int`	`napplicationVersion(long struct)` Unsafe version of `applicationVersion()`.
`static void`	`napplicationVersion(long struct, int value)` Unsafe version of `applicationVersion`.
`static int`	`nengineVersion(long struct)` Unsafe version of `engineVersion()`.
`static void`	`nengineVersion(long struct, int value)` Unsafe version of `engineVersion`.
`static java.nio.ByteBuffer`	`npApplicationName(long struct)` Unsafe version of `pApplicationName()`.
`static void`	`npApplicationName(long struct, java.nio.ByteBuffer value)` Unsafe version of `pApplicationName`.
`static java.lang.String`	`npApplicationNameString(long struct)` Unsafe version of `pApplicationNameString()`.
`static java.nio.ByteBuffer`	`npEngineName(long struct)` Unsafe version of `pEngineName()`.
`static void`	`npEngineName(long struct, java.nio.ByteBuffer value)` Unsafe version of `pEngineName`.
`static java.lang.String`	`npEngineNameString(long struct)` Unsafe version of `pEngineNameString()`.
`static long`	`npNext(long struct)` Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)` Unsafe version of `pNext`.
`static int`	`nsType(long struct)` Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)` Unsafe version of `sType`.
`java.nio.ByteBuffer`	`pApplicationName()` Returns a `ByteBuffer` view of the null-terminated string pointed to by the `pApplicationName` field.
`VkApplicationInfo`	`pApplicationName(java.nio.ByteBuffer value)` Sets the address of the specified encoded string to the `pApplicationName` field.
`java.lang.String`	`pApplicationNameString()` Decodes the null-terminated string pointed to by the `pApplicationName` field.
`java.nio.ByteBuffer`	`pEngineName()` Returns a `ByteBuffer` view of the null-terminated string pointed to by the `pEngineName` field.
`VkApplicationInfo`	`pEngineName(java.nio.ByteBuffer value)` Sets the address of the specified encoded string to the `pEngineName` field.
`java.lang.String`	`pEngineNameString()` Decodes the null-terminated string pointed to by the `pEngineName` field.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkApplicationInfo`	`pNext(long value)` Sets the specified value to the `pNext` field.
`VkApplicationInfo`	`set(int sType, long pNext, java.nio.ByteBuffer pApplicationName, int applicationVersion, java.nio.ByteBuffer pEngineName, int engineVersion, int apiVersion)` Initializes this struct with the specified values.
`VkApplicationInfo`	`set(VkApplicationInfo src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()` Returns the value of the `sType` field.
`VkApplicationInfo`	`sType(int value)` Sets the specified value to the `sType` field.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - STYPE
```
public static final int STYPE
```
    The struct member offsets.
  - PNEXT
```
public static final int PNEXT
```
    The struct member offsets.
  - PAPPLICATIONNAME
```
public static final int PAPPLICATIONNAME
```
    The struct member offsets.
  - APPLICATIONVERSION
```
public static final int APPLICATIONVERSION
```
    The struct member offsets.
  - PENGINENAME
```
public static final int PENGINENAME
```
    The struct member offsets.
  - ENGINEVERSION
```
public static final int ENGINEVERSION
```
    The struct member offsets.
  - APIVERSION
```
public static final int APIVERSION
```
    The struct member offsets.
- Constructor Detail
  - VkApplicationInfo
```
public VkApplicationInfo(java.nio.ByteBuffer container)
```
    Creates a VkApplicationInfo 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
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - sType
```
public int sType()
```
    Returns the value of the sType field.
  - pNext
```
public long pNext()
```
    Returns the value of the pNext field.
  - pApplicationName
```
@Nullable
public java.nio.ByteBuffer pApplicationName()
```
    Returns a ByteBuffer view of the null-terminated string pointed to by the pApplicationName field.
  - pApplicationNameString
```
@Nullable
public java.lang.String pApplicationNameString()
```
    Decodes the null-terminated string pointed to by the pApplicationName field.
  - applicationVersion
```
public int applicationVersion()
```
    Returns the value of the applicationVersion field.
  - pEngineName
```
@Nullable
public java.nio.ByteBuffer pEngineName()
```
    Returns a ByteBuffer view of the null-terminated string pointed to by the pEngineName field.
  - pEngineNameString
```
@Nullable
public java.lang.String pEngineNameString()
```
    Decodes the null-terminated string pointed to by the pEngineName field.
  - engineVersion
```
public int engineVersion()
```
    Returns the value of the engineVersion field.
  - apiVersion
```
public int apiVersion()
```
    Returns the value of the apiVersion field.
  - sType
```
public VkApplicationInfo sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkApplicationInfo pNext(long value)
```
    Sets the specified value to the pNext field.
  - pApplicationName
```
public VkApplicationInfo pApplicationName(@Nullable
                                          java.nio.ByteBuffer value)
```
    Sets the address of the specified encoded string to the pApplicationName field.
  - applicationVersion
```
public VkApplicationInfo applicationVersion(int value)
```
    Sets the specified value to the applicationVersion field.
  - pEngineName
```
public VkApplicationInfo pEngineName(@Nullable
                                     java.nio.ByteBuffer value)
```
    Sets the address of the specified encoded string to the pEngineName field.
  - engineVersion
```
public VkApplicationInfo engineVersion(int value)
```
    Sets the specified value to the engineVersion field.
  - apiVersion
```
public VkApplicationInfo apiVersion(int value)
```
    Sets the specified value to the apiVersion field.
  - set
```
public VkApplicationInfo set(int sType,
                             long pNext,
                             @Nullable
                             java.nio.ByteBuffer pApplicationName,
                             int applicationVersion,
                             @Nullable
                             java.nio.ByteBuffer pEngineName,
                             int engineVersion,
                             int apiVersion)
```
    Initializes this struct with the specified values.
  - set
```
public VkApplicationInfo set(VkApplicationInfo src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkApplicationInfo malloc()
```
    Returns a new VkApplicationInfo instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkApplicationInfo calloc()
```
    Returns a new VkApplicationInfo instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkApplicationInfo create()
```
    Returns a new VkApplicationInfo instance allocated with BufferUtils.
  - create
```
public static VkApplicationInfo create(long address)
```
    Returns a new VkApplicationInfo instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkApplicationInfo createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkApplicationInfo.Buffer malloc(int capacity)
```
    Returns a new VkApplicationInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkApplicationInfo.Buffer calloc(int capacity)
```
    Returns a new VkApplicationInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkApplicationInfo.Buffer create(int capacity)
```
    Returns a new VkApplicationInfo.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkApplicationInfo.Buffer create(long address,
                                              int capacity)
```
    Create a VkApplicationInfo.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkApplicationInfo.Buffer createSafe(long address,
                                                            int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkApplicationInfo mallocStack()
```
    Returns a new VkApplicationInfo instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkApplicationInfo callocStack()
```
    Returns a new VkApplicationInfo instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkApplicationInfo mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkApplicationInfo instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkApplicationInfo callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkApplicationInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkApplicationInfo.Buffer mallocStack(int capacity)
```
    Returns a new VkApplicationInfo.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkApplicationInfo.Buffer callocStack(int capacity)
```
    Returns a new VkApplicationInfo.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkApplicationInfo.Buffer mallocStack(int capacity,
                                                   org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkApplicationInfo.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkApplicationInfo.Buffer callocStack(int capacity,
                                                   org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkApplicationInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - nsType
```
public static int nsType(long struct)
```
    Unsafe version of sType().
  - npNext
```
public static long npNext(long struct)
```
    Unsafe version of pNext().
  - npApplicationName
```
@Nullable
public static java.nio.ByteBuffer npApplicationName(long struct)
```
    Unsafe version of pApplicationName().
  - npApplicationNameString
```
@Nullable
public static java.lang.String npApplicationNameString(long struct)
```
    Unsafe version of pApplicationNameString().
  - napplicationVersion
```
public static int napplicationVersion(long struct)
```
    Unsafe version of applicationVersion().
  - npEngineName
```
@Nullable
public static java.nio.ByteBuffer npEngineName(long struct)
```
    Unsafe version of pEngineName().
  - npEngineNameString
```
@Nullable
public static java.lang.String npEngineNameString(long struct)
```
    Unsafe version of pEngineNameString().
  - nengineVersion
```
public static int nengineVersion(long struct)
```
    Unsafe version of engineVersion().
  - napiVersion
```
public static int napiVersion(long struct)
```
    Unsafe version of apiVersion().
  - nsType
```
public static void nsType(long struct,
                          int value)
```
    Unsafe version of sType.
  - npNext
```
public static void npNext(long struct,
                          long value)
```
    Unsafe version of pNext.
  - npApplicationName
```
public static void npApplicationName(long struct,
                                     @Nullable
                                     java.nio.ByteBuffer value)
```
    Unsafe version of pApplicationName.
  - napplicationVersion
```
public static void napplicationVersion(long struct,
                                       int value)
```
    Unsafe version of applicationVersion.
  - npEngineName
```
public static void npEngineName(long struct,
                                @Nullable
                                java.nio.ByteBuffer value)
```
    Unsafe version of pEngineName.
  - nengineVersion
```
public static void nengineVersion(long struct,
                                  int value)
```
    Unsafe version of engineVersion.
  - napiVersion
```
public static void napiVersion(long struct,
                               int value)
```
    Unsafe version of apiVersion.

Class VkApplicationInfo

Description

Note

Note

Note

Valid Usage (Implicit)

See Also

Member documentation

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

STYPE

PNEXT

PAPPLICATIONNAME

APPLICATIONVERSION

PENGINENAME

ENGINEVERSION

APIVERSION

Constructor Detail

VkApplicationInfo

Method Detail

sizeof

sType

pNext

pApplicationName

pApplicationNameString

applicationVersion

pEngineName

pEngineNameString

engineVersion

apiVersion

sType

pNext

pApplicationName

applicationVersion

pEngineName

engineVersion

apiVersion

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

npApplicationName

npApplicationNameString

napplicationVersion

npEngineName

npEngineNameString

nengineVersion

napiVersion

nsType

npNext