VkInstanceCreateInfo (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkInstanceCreateInfo
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying parameters of a newly created instance.
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_INSTANCE_CREATE_INFO
- Each pNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of VkDebugReportCallbackCreateInfoEXT, VkDebugUtilsMessengerCreateInfoEXT, VkValidationFeaturesEXT, or VkValidationFlagsEXT
- Each sType member in the pNext chain must be unique
- flags must be 0
- If pApplicationInfo is not NULL, pApplicationInfo must be a valid pointer to a valid VkApplicationInfo structure
- If enabledLayerCount is not 0, ppEnabledLayerNames must be a valid pointer to an array of enabledLayerCount null-terminated UTF-8 strings
- If enabledExtensionCount is not 0, ppEnabledExtensionNames must be a valid pointer to an array of enabledExtensionCount null-terminated UTF-8 strings
See Also

VkApplicationInfo, CreateInstance

Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- flags – reserved for future use.
- pApplicationInfo – NULL or a pointer to a VkApplicationInfo structure. If not NULL, this information helps implementations recognize behavior inherent to classes of applications. VkApplicationInfo is defined in detail below.
- enabledLayerCount – the number of global layers to enable.
- ppEnabledLayerNames – a pointer to an array of enabledLayerCount null-terminated UTF-8 strings containing the names of layers to enable for the created instance. See the Layers section for further details.
- enabledExtensionCount – the number of global extensions to enable.
- ppEnabledExtensionNames – a pointer to an array of enabledExtensionCount null-terminated UTF-8 strings containing the names of extensions to enable.
Layout
```
 struct VkInstanceCreateInfo {
     VkStructureType sType;
     void const * pNext;
     VkInstanceCreateFlags flags;
     VkApplicationInfo const * pApplicationInfo;
     uint32_t enabledLayerCount;
     char const * const * ppEnabledLayerNames;
     uint32_t enabledExtensionCount;
     char const * const * ppEnabledExtensionNames;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkInstanceCreateInfo.Buffer
An array of VkInstanceCreateInfo 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`	`VkInstanceCreateInfo.Buffer` An array of `VkInstanceCreateInfo` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`ENABLEDEXTENSIONCOUNT` The struct member offsets.
`static int`	`ENABLEDLAYERCOUNT` The struct member offsets.
`static int`	`FLAGS` The struct member offsets.
`static int`	`PAPPLICATIONINFO` The struct member offsets.
`static int`	`PNEXT` The struct member offsets.
`static int`	`PPENABLEDEXTENSIONNAMES` The struct member offsets.
`static int`	`PPENABLEDLAYERNAMES` 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
`VkInstanceCreateInfo(java.nio.ByteBuffer container)` Creates a `VkInstanceCreateInfo` 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
`static VkInstanceCreateInfo`	`calloc()` Returns a new `VkInstanceCreateInfo` instance allocated with `memCalloc`.
`static VkInstanceCreateInfo.Buffer`	`calloc(int capacity)` Returns a new `VkInstanceCreateInfo.Buffer` instance allocated with `memCalloc`.
`static VkInstanceCreateInfo`	`callocStack()` Returns a new `VkInstanceCreateInfo` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkInstanceCreateInfo.Buffer`	`callocStack(int capacity)` Returns a new `VkInstanceCreateInfo.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkInstanceCreateInfo.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkInstanceCreateInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkInstanceCreateInfo`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkInstanceCreateInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkInstanceCreateInfo`	`create()` Returns a new `VkInstanceCreateInfo` instance allocated with `BufferUtils`.
`static VkInstanceCreateInfo.Buffer`	`create(int capacity)` Returns a new `VkInstanceCreateInfo.Buffer` instance allocated with `BufferUtils`.
`static VkInstanceCreateInfo`	`create(long address)` Returns a new `VkInstanceCreateInfo` instance for the specified memory address.
`static VkInstanceCreateInfo.Buffer`	`create(long address, int capacity)` Create a `VkInstanceCreateInfo.Buffer` instance at the specified memory.
`static VkInstanceCreateInfo`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkInstanceCreateInfo.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`enabledExtensionCount()` Returns the value of the `enabledExtensionCount` field.
`int`	`enabledLayerCount()` Returns the value of the `enabledLayerCount` field.
`int`	`flags()` Returns the value of the `flags` field.
`VkInstanceCreateInfo`	`flags(int value)` Sets the specified value to the `flags` field.
`static VkInstanceCreateInfo`	`malloc()` Returns a new `VkInstanceCreateInfo` instance allocated with `memAlloc`.
`static VkInstanceCreateInfo.Buffer`	`malloc(int capacity)` Returns a new `VkInstanceCreateInfo.Buffer` instance allocated with `memAlloc`.
`static VkInstanceCreateInfo`	`mallocStack()` Returns a new `VkInstanceCreateInfo` instance allocated on the thread-local `MemoryStack`.
`static VkInstanceCreateInfo.Buffer`	`mallocStack(int capacity)` Returns a new `VkInstanceCreateInfo.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkInstanceCreateInfo.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkInstanceCreateInfo.Buffer` instance allocated on the specified `MemoryStack`.
`static VkInstanceCreateInfo`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkInstanceCreateInfo` instance allocated on the specified `MemoryStack`.
`static int`	`nenabledExtensionCount(long struct)` Unsafe version of `enabledExtensionCount()`.
`static void`	`nenabledExtensionCount(long struct, int value)` Sets the specified value to the `enabledExtensionCount` field of the specified `struct`.
`static int`	`nenabledLayerCount(long struct)` Unsafe version of `enabledLayerCount()`.
`static void`	`nenabledLayerCount(long struct, int value)` Sets the specified value to the `enabledLayerCount` field of the specified `struct`.
`static int`	`nflags(long struct)` Unsafe version of `flags()`.
`static void`	`nflags(long struct, int value)` Unsafe version of `flags`.
`static VkApplicationInfo`	`npApplicationInfo(long struct)` Unsafe version of `pApplicationInfo()`.
`static void`	`npApplicationInfo(long struct, VkApplicationInfo value)` Unsafe version of `pApplicationInfo`.
`static long`	`npNext(long struct)` Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)` Unsafe version of `pNext`.
`static org.lwjgl.PointerBuffer`	`nppEnabledExtensionNames(long struct)` Unsafe version of `ppEnabledExtensionNames`.
`static void`	`nppEnabledExtensionNames(long struct, org.lwjgl.PointerBuffer value)` Unsafe version of `ppEnabledExtensionNames`.
`static org.lwjgl.PointerBuffer`	`nppEnabledLayerNames(long struct)` Unsafe version of `ppEnabledLayerNames`.
`static void`	`nppEnabledLayerNames(long struct, org.lwjgl.PointerBuffer value)` Unsafe version of `ppEnabledLayerNames`.
`static int`	`nsType(long struct)` Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)` Unsafe version of `sType`.
`VkApplicationInfo`	`pApplicationInfo()` Returns a `VkApplicationInfo` view of the struct pointed to by the `pApplicationInfo` field.
`VkInstanceCreateInfo`	`pApplicationInfo(VkApplicationInfo value)` Sets the address of the specified `VkApplicationInfo` to the `pApplicationInfo` field.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkInstanceCreateInfo`	`pNext(long value)` Sets the specified value to the `pNext` field.
`org.lwjgl.PointerBuffer`	`ppEnabledExtensionNames()` Returns a `PointerBuffer` view of the data pointed to by the `ppEnabledExtensionNames` field.
`VkInstanceCreateInfo`	`ppEnabledExtensionNames(org.lwjgl.PointerBuffer value)` Sets the address of the specified `PointerBuffer` to the `ppEnabledExtensionNames` field.
`org.lwjgl.PointerBuffer`	`ppEnabledLayerNames()` Returns a `PointerBuffer` view of the data pointed to by the `ppEnabledLayerNames` field.
`VkInstanceCreateInfo`	`ppEnabledLayerNames(org.lwjgl.PointerBuffer value)` Sets the address of the specified `PointerBuffer` to the `ppEnabledLayerNames` field.
`VkInstanceCreateInfo`	`set(int sType, long pNext, int flags, VkApplicationInfo pApplicationInfo, org.lwjgl.PointerBuffer ppEnabledLayerNames, org.lwjgl.PointerBuffer ppEnabledExtensionNames)` Initializes this struct with the specified values.
`VkInstanceCreateInfo`	`set(VkInstanceCreateInfo src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()` Returns the value of the `sType` field.
`VkInstanceCreateInfo`	`sType(int value)` Sets the specified value to the `sType` field.
`static void`	`validate(long struct)` Validates pointer members that should not be `NULL`.
`static void`	`validate(long array, int count)` Calls `validate(long)` for each struct contained in the specified struct array.

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.
  - FLAGS
```
public static final int FLAGS
```
    The struct member offsets.
  - PAPPLICATIONINFO
```
public static final int PAPPLICATIONINFO
```
    The struct member offsets.
  - ENABLEDLAYERCOUNT
```
public static final int ENABLEDLAYERCOUNT
```
    The struct member offsets.
  - PPENABLEDLAYERNAMES
```
public static final int PPENABLEDLAYERNAMES
```
    The struct member offsets.
  - ENABLEDEXTENSIONCOUNT
```
public static final int ENABLEDEXTENSIONCOUNT
```
    The struct member offsets.
  - PPENABLEDEXTENSIONNAMES
```
public static final int PPENABLEDEXTENSIONNAMES
```
    The struct member offsets.
- Constructor Detail
  - VkInstanceCreateInfo
```
public VkInstanceCreateInfo(java.nio.ByteBuffer container)
```
    Creates a VkInstanceCreateInfo 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.
  - flags
```
public int flags()
```
    Returns the value of the flags field.
  - pApplicationInfo
```
@Nullable
public VkApplicationInfo pApplicationInfo()
```
    Returns a VkApplicationInfo view of the struct pointed to by the pApplicationInfo field.
  - enabledLayerCount
```
public int enabledLayerCount()
```
    Returns the value of the enabledLayerCount field.
  - ppEnabledLayerNames
```
@Nullable
public org.lwjgl.PointerBuffer ppEnabledLayerNames()
```
    Returns a PointerBuffer view of the data pointed to by the ppEnabledLayerNames field.
  - enabledExtensionCount
```
public int enabledExtensionCount()
```
    Returns the value of the enabledExtensionCount field.
  - ppEnabledExtensionNames
```
@Nullable
public org.lwjgl.PointerBuffer ppEnabledExtensionNames()
```
    Returns a PointerBuffer view of the data pointed to by the ppEnabledExtensionNames field.
  - sType
```
public VkInstanceCreateInfo sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkInstanceCreateInfo pNext(long value)
```
    Sets the specified value to the pNext field.
  - flags
```
public VkInstanceCreateInfo flags(int value)
```
    Sets the specified value to the flags field.
  - pApplicationInfo
```
public VkInstanceCreateInfo pApplicationInfo(@Nullable
                                             VkApplicationInfo value)
```
    Sets the address of the specified VkApplicationInfo to the pApplicationInfo field.
  - ppEnabledLayerNames
```
public VkInstanceCreateInfo ppEnabledLayerNames(@Nullable
                                                org.lwjgl.PointerBuffer value)
```
    Sets the address of the specified PointerBuffer to the ppEnabledLayerNames field.
  - ppEnabledExtensionNames
```
public VkInstanceCreateInfo ppEnabledExtensionNames(@Nullable
                                                    org.lwjgl.PointerBuffer value)
```
    Sets the address of the specified PointerBuffer to the ppEnabledExtensionNames field.
  - set
```
public VkInstanceCreateInfo set(int sType,
                                long pNext,
                                int flags,
                                @Nullable
                                VkApplicationInfo pApplicationInfo,
                                @Nullable
                                org.lwjgl.PointerBuffer ppEnabledLayerNames,
                                @Nullable
                                org.lwjgl.PointerBuffer ppEnabledExtensionNames)
```
    Initializes this struct with the specified values.
  - set
```
public VkInstanceCreateInfo set(VkInstanceCreateInfo src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkInstanceCreateInfo malloc()
```
    Returns a new VkInstanceCreateInfo instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkInstanceCreateInfo calloc()
```
    Returns a new VkInstanceCreateInfo instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkInstanceCreateInfo create()
```
    Returns a new VkInstanceCreateInfo instance allocated with BufferUtils.
  - create
```
public static VkInstanceCreateInfo create(long address)
```
    Returns a new VkInstanceCreateInfo instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkInstanceCreateInfo createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkInstanceCreateInfo.Buffer malloc(int capacity)
```
    Returns a new VkInstanceCreateInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkInstanceCreateInfo.Buffer calloc(int capacity)
```
    Returns a new VkInstanceCreateInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkInstanceCreateInfo.Buffer create(int capacity)
```
    Returns a new VkInstanceCreateInfo.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkInstanceCreateInfo.Buffer create(long address,
                                                 int capacity)
```
    Create a VkInstanceCreateInfo.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkInstanceCreateInfo.Buffer createSafe(long address,
                                                               int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkInstanceCreateInfo mallocStack()
```
    Returns a new VkInstanceCreateInfo instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkInstanceCreateInfo callocStack()
```
    Returns a new VkInstanceCreateInfo instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkInstanceCreateInfo mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkInstanceCreateInfo instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkInstanceCreateInfo callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkInstanceCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkInstanceCreateInfo.Buffer mallocStack(int capacity)
```
    Returns a new VkInstanceCreateInfo.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkInstanceCreateInfo.Buffer callocStack(int capacity)
```
    Returns a new VkInstanceCreateInfo.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkInstanceCreateInfo.Buffer mallocStack(int capacity,
                                                      org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkInstanceCreateInfo.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkInstanceCreateInfo.Buffer callocStack(int capacity,
                                                      org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkInstanceCreateInfo.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().
  - nflags
```
public static int nflags(long struct)
```
    Unsafe version of flags().
  - npApplicationInfo
```
@Nullable
public static VkApplicationInfo npApplicationInfo(long struct)
```
    Unsafe version of pApplicationInfo().
  - nenabledLayerCount
```
public static int nenabledLayerCount(long struct)
```
    Unsafe version of enabledLayerCount().
  - nppEnabledLayerNames
```
@Nullable
public static org.lwjgl.PointerBuffer nppEnabledLayerNames(long struct)
```
    Unsafe version of ppEnabledLayerNames.
  - nenabledExtensionCount
```
public static int nenabledExtensionCount(long struct)
```
    Unsafe version of enabledExtensionCount().
  - nppEnabledExtensionNames
```
@Nullable
public static org.lwjgl.PointerBuffer nppEnabledExtensionNames(long struct)
```
    Unsafe version of ppEnabledExtensionNames.
  - 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.
  - nflags
```
public static void nflags(long struct,
                          int value)
```
    Unsafe version of flags.
  - npApplicationInfo
```
public static void npApplicationInfo(long struct,
                                     @Nullable
                                     VkApplicationInfo value)
```
    Unsafe version of pApplicationInfo.
  - nenabledLayerCount
```
public static void nenabledLayerCount(long struct,
                                      int value)
```
    Sets the specified value to the enabledLayerCount field of the specified struct.
  - nppEnabledLayerNames
```
public static void nppEnabledLayerNames(long struct,
                                        @Nullable
                                        org.lwjgl.PointerBuffer value)
```
    Unsafe version of ppEnabledLayerNames.
  - nenabledExtensionCount
```
public static void nenabledExtensionCount(long struct,
                                          int value)
```
    Sets the specified value to the enabledExtensionCount field of the specified struct.
  - nppEnabledExtensionNames
```
public static void nppEnabledExtensionNames(long struct,
                                            @Nullable
                                            org.lwjgl.PointerBuffer value)
```
    Unsafe version of ppEnabledExtensionNames.
  - validate
```
public static void validate(long struct)
```
    Validates pointer members that should not be NULL.
    
    Parameters:
    
    struct - the struct to validate
  - validate
```
public static void validate(long array,
                            int count)
```
    Calls validate(long) for each struct contained in the specified struct array.
    
    Parameters:
    
    array - the struct array to validate
    
    count - the number of structs in array

Class VkInstanceCreateInfo

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

FLAGS

PAPPLICATIONINFO

ENABLEDLAYERCOUNT

PPENABLEDLAYERNAMES

ENABLEDEXTENSIONCOUNT

PPENABLEDEXTENSIONNAMES

Constructor Detail

VkInstanceCreateInfo

Method Detail

sizeof

sType

pNext

flags

pApplicationInfo

enabledLayerCount

ppEnabledLayerNames

enabledExtensionCount

ppEnabledExtensionNames

sType

pNext

flags

pApplicationInfo

ppEnabledLayerNames

ppEnabledExtensionNames

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nflags

npApplicationInfo

nenabledLayerCount

nppEnabledLayerNames

nenabledExtensionCount

nppEnabledExtensionNames

nsType

npNext

nflags

npApplicationInfo

nenabledLayerCount

nppEnabledLayerNames

nenabledExtensionCount

nppEnabledExtensionNames