Package org.lwjgl.vulkan
Class VkInstanceCreateInfo
- 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.NativeResourceStructure specifying parameters of a newly created instance.Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_INSTANCE_CREATE_INFO- Each
pNextmember of any structure (including this one) in thepNextchain must be eitherNULLor a pointer to a valid instance ofVkDebugReportCallbackCreateInfoEXT,VkDebugUtilsMessengerCreateInfoEXT,VkValidationFeaturesEXT, orVkValidationFlagsEXT - Each
sTypemember in thepNextchain must be unique flagsmust be 0- If
pApplicationInfois notNULL,pApplicationInfomust be a valid pointer to a validVkApplicationInfostructure - If
enabledLayerCountis not 0,ppEnabledLayerNamesmust be a valid pointer to an array ofenabledLayerCountnull-terminated UTF-8 strings - If
enabledExtensionCountis not 0,ppEnabledExtensionNamesmust be a valid pointer to an array ofenabledExtensionCountnull-terminated UTF-8 strings
See Also
VkApplicationInfo,CreateInstanceMember documentation
sType– the type of this structure.pNext–NULLor a pointer to an extension-specific structure.flags– reserved for future use.pApplicationInfo–NULLor a pointer to an instance ofVkApplicationInfo. If notNULL, this information helps implementations recognize behavior inherent to classes of applications.VkApplicationInfois defined in detail below.enabledLayerCount– the number of global layers to enable.ppEnabledLayerNames– a pointer to an array ofenabledLayerCountnull-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 ofenabledExtensionCountnull-terminated UTF-8 strings containing the names of extensions to enable.
Layout
struct VkInstanceCreateInfo { VkStructureType sType; void const * pNext; VkInstanceCreateFlags flags;VkApplicationInfoconst * pApplicationInfo; uint32_t enabledLayerCount; char const * const * ppEnabledLayerNames; uint32_t enabledExtensionCount; char const * const * ppEnabledExtensionNames; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkInstanceCreateInfo.BufferAn array ofVkInstanceCreateInfostructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intENABLEDEXTENSIONCOUNT
ENABLEDLAYERCOUNT
FLAGS
PAPPLICATIONINFO
PNEXT
PPENABLEDEXTENSIONNAMES
PPENABLEDLAYERNAMESThe struct member offsets.static intSIZEOFThe struct size in bytes.static intSTYPEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkInstanceCreateInfo(java.nio.ByteBuffer container)Creates aVkInstanceCreateInfoinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkInstanceCreateInfocalloc()Returns a newVkInstanceCreateInfoinstance allocated withmemCalloc.static VkInstanceCreateInfo.Buffercalloc(int capacity)Returns a newVkInstanceCreateInfo.Bufferinstance allocated withmemCalloc.static VkInstanceCreateInfocallocStack()Returns a newVkInstanceCreateInfoinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkInstanceCreateInfo.BuffercallocStack(int capacity)Returns a newVkInstanceCreateInfo.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkInstanceCreateInfo.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkInstanceCreateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkInstanceCreateInfocallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkInstanceCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkInstanceCreateInfocreate()Returns a newVkInstanceCreateInfoinstance allocated withBufferUtils.static VkInstanceCreateInfo.Buffercreate(int capacity)Returns a newVkInstanceCreateInfo.Bufferinstance allocated withBufferUtils.static VkInstanceCreateInfocreate(long address)Returns a newVkInstanceCreateInfoinstance for the specified memory address.static VkInstanceCreateInfo.Buffercreate(long address, int capacity)Create aVkInstanceCreateInfo.Bufferinstance at the specified memory.static VkInstanceCreateInfocreateSafe(long address)static VkInstanceCreateInfo.BuffercreateSafe(long address, int capacity)intenabledExtensionCount()Returns the value of theenabledExtensionCountfield.intenabledLayerCount()Returns the value of theenabledLayerCountfield.intflags()Returns the value of theflagsfield.VkInstanceCreateInfoflags(int value)Sets the specified value to theflagsfield.static VkInstanceCreateInfomalloc()Returns a newVkInstanceCreateInfoinstance allocated withmemAlloc.static VkInstanceCreateInfo.Buffermalloc(int capacity)Returns a newVkInstanceCreateInfo.Bufferinstance allocated withmemAlloc.static VkInstanceCreateInfomallocStack()Returns a newVkInstanceCreateInfoinstance allocated on the thread-localMemoryStack.static VkInstanceCreateInfo.BuffermallocStack(int capacity)Returns a newVkInstanceCreateInfo.Bufferinstance allocated on the thread-localMemoryStack.static VkInstanceCreateInfo.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkInstanceCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.static VkInstanceCreateInfomallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkInstanceCreateInfoinstance allocated on the specifiedMemoryStack.static intnenabledExtensionCount(long struct)Unsafe version ofenabledExtensionCount().static voidnenabledExtensionCount(long struct, int value)Sets the specified value to theenabledExtensionCountfield of the specifiedstruct.static intnenabledLayerCount(long struct)Unsafe version ofenabledLayerCount().static voidnenabledLayerCount(long struct, int value)Sets the specified value to theenabledLayerCountfield of the specifiedstruct.static intnflags(long struct)Unsafe version offlags().static voidnflags(long struct, int value)Unsafe version offlags.static VkApplicationInfonpApplicationInfo(long struct)Unsafe version ofpApplicationInfo().static voidnpApplicationInfo(long struct, VkApplicationInfo value)Unsafe version ofpApplicationInfo.static longnpNext(long struct)Unsafe version ofpNext().static voidnpNext(long struct, long value)Unsafe version ofpNext.static org.lwjgl.PointerBuffernppEnabledExtensionNames(long struct)Unsafe version ofppEnabledExtensionNames.static voidnppEnabledExtensionNames(long struct, org.lwjgl.PointerBuffer value)Unsafe version ofppEnabledExtensionNames.static org.lwjgl.PointerBuffernppEnabledLayerNames(long struct)Unsafe version ofppEnabledLayerNames.static voidnppEnabledLayerNames(long struct, org.lwjgl.PointerBuffer value)Unsafe version ofppEnabledLayerNames.static intnsType(long struct)Unsafe version ofsType().static voidnsType(long struct, int value)Unsafe version ofsType.VkApplicationInfopApplicationInfo()Returns aVkApplicationInfoview of the struct pointed to by thepApplicationInfofield.VkInstanceCreateInfopApplicationInfo(VkApplicationInfo value)Sets the address of the specifiedVkApplicationInfoto thepApplicationInfofield.longpNext()Returns the value of thepNextfield.VkInstanceCreateInfopNext(long value)Sets the specified value to thepNextfield.org.lwjgl.PointerBufferppEnabledExtensionNames()Returns aPointerBufferview of the data pointed to by theppEnabledExtensionNamesfield.VkInstanceCreateInfoppEnabledExtensionNames(org.lwjgl.PointerBuffer value)Sets the address of the specifiedPointerBufferto theppEnabledExtensionNamesfield.org.lwjgl.PointerBufferppEnabledLayerNames()Returns aPointerBufferview of the data pointed to by theppEnabledLayerNamesfield.VkInstanceCreateInfoppEnabledLayerNames(org.lwjgl.PointerBuffer value)Sets the address of the specifiedPointerBufferto theppEnabledLayerNamesfield.VkInstanceCreateInfoset(int sType, long pNext, int flags, VkApplicationInfo pApplicationInfo, org.lwjgl.PointerBuffer ppEnabledLayerNames, org.lwjgl.PointerBuffer ppEnabledExtensionNames)Initializes this struct with the specified values.VkInstanceCreateInfoset(VkInstanceCreateInfo src)Copies the specified struct data to this struct.intsizeof()intsType()Returns the value of thesTypefield.VkInstanceCreateInfosType(int value)Sets the specified value to thesTypefield.static voidvalidate(long struct)Validates pointer members that should not beNULL.static voidvalidate(long array, int count)Callsvalidate(long)for each struct contained in the specified struct array.
-
-
-
Constructor Detail
-
VkInstanceCreateInfo
public VkInstanceCreateInfo(java.nio.ByteBuffer container)
Creates aVkInstanceCreateInfoinstance 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
-
sType
public int sType()
Returns the value of thesTypefield.
-
pNext
public long pNext()
Returns the value of thepNextfield.
-
flags
public int flags()
Returns the value of theflagsfield.
-
pApplicationInfo
@Nullable public VkApplicationInfo pApplicationInfo()
Returns aVkApplicationInfoview of the struct pointed to by thepApplicationInfofield.
-
enabledLayerCount
public int enabledLayerCount()
Returns the value of theenabledLayerCountfield.
-
ppEnabledLayerNames
@Nullable public org.lwjgl.PointerBuffer ppEnabledLayerNames()
Returns aPointerBufferview of the data pointed to by theppEnabledLayerNamesfield.
-
enabledExtensionCount
public int enabledExtensionCount()
Returns the value of theenabledExtensionCountfield.
-
ppEnabledExtensionNames
@Nullable public org.lwjgl.PointerBuffer ppEnabledExtensionNames()
Returns aPointerBufferview of the data pointed to by theppEnabledExtensionNamesfield.
-
sType
public VkInstanceCreateInfo sType(int value)
Sets the specified value to thesTypefield.
-
pNext
public VkInstanceCreateInfo pNext(long value)
Sets the specified value to thepNextfield.
-
flags
public VkInstanceCreateInfo flags(int value)
Sets the specified value to theflagsfield.
-
pApplicationInfo
public VkInstanceCreateInfo pApplicationInfo(@Nullable VkApplicationInfo value)
Sets the address of the specifiedVkApplicationInfoto thepApplicationInfofield.
-
ppEnabledLayerNames
public VkInstanceCreateInfo ppEnabledLayerNames(@Nullable org.lwjgl.PointerBuffer value)
Sets the address of the specifiedPointerBufferto theppEnabledLayerNamesfield.
-
ppEnabledExtensionNames
public VkInstanceCreateInfo ppEnabledExtensionNames(@Nullable org.lwjgl.PointerBuffer value)
Sets the address of the specifiedPointerBufferto theppEnabledExtensionNamesfield.
-
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 newVkInstanceCreateInfoinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkInstanceCreateInfo calloc()
Returns a newVkInstanceCreateInfoinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkInstanceCreateInfo create()
Returns a newVkInstanceCreateInfoinstance allocated withBufferUtils.
-
create
public static VkInstanceCreateInfo create(long address)
Returns a newVkInstanceCreateInfoinstance for the specified memory address.
-
createSafe
@Nullable public static VkInstanceCreateInfo createSafe(long address)
-
malloc
public static VkInstanceCreateInfo.Buffer malloc(int capacity)
Returns a newVkInstanceCreateInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkInstanceCreateInfo.Buffer calloc(int capacity)
Returns a newVkInstanceCreateInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkInstanceCreateInfo.Buffer create(int capacity)
Returns a newVkInstanceCreateInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkInstanceCreateInfo.Buffer create(long address, int capacity)
Create aVkInstanceCreateInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkInstanceCreateInfo.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkInstanceCreateInfo mallocStack()
Returns a newVkInstanceCreateInfoinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkInstanceCreateInfo callocStack()
Returns a newVkInstanceCreateInfoinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkInstanceCreateInfo mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkInstanceCreateInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkInstanceCreateInfo callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkInstanceCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
mallocStack
public static VkInstanceCreateInfo.Buffer mallocStack(int capacity)
Returns a newVkInstanceCreateInfo.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkInstanceCreateInfo.Buffer callocStack(int capacity)
Returns a newVkInstanceCreateInfo.Bufferinstance allocated on the thread-localMemoryStackand 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 newVkInstanceCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
callocStack
public static VkInstanceCreateInfo.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkInstanceCreateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
nsType
public static int nsType(long struct)
Unsafe version ofsType().
-
npNext
public static long npNext(long struct)
Unsafe version ofpNext().
-
nflags
public static int nflags(long struct)
Unsafe version offlags().
-
npApplicationInfo
@Nullable public static VkApplicationInfo npApplicationInfo(long struct)
Unsafe version ofpApplicationInfo().
-
nenabledLayerCount
public static int nenabledLayerCount(long struct)
Unsafe version ofenabledLayerCount().
-
nppEnabledLayerNames
@Nullable public static org.lwjgl.PointerBuffer nppEnabledLayerNames(long struct)
Unsafe version ofppEnabledLayerNames.
-
nenabledExtensionCount
public static int nenabledExtensionCount(long struct)
Unsafe version ofenabledExtensionCount().
-
nppEnabledExtensionNames
@Nullable public static org.lwjgl.PointerBuffer nppEnabledExtensionNames(long struct)
Unsafe version ofppEnabledExtensionNames.
-
nsType
public static void nsType(long struct, int value)Unsafe version ofsType.
-
npNext
public static void npNext(long struct, long value)Unsafe version ofpNext.
-
nflags
public static void nflags(long struct, int value)Unsafe version offlags.
-
npApplicationInfo
public static void npApplicationInfo(long struct, @Nullable VkApplicationInfo value)Unsafe version ofpApplicationInfo.
-
nenabledLayerCount
public static void nenabledLayerCount(long struct, int value)Sets the specified value to theenabledLayerCountfield of the specifiedstruct.
-
nppEnabledLayerNames
public static void nppEnabledLayerNames(long struct, @Nullable org.lwjgl.PointerBuffer value)Unsafe version ofppEnabledLayerNames.
-
nenabledExtensionCount
public static void nenabledExtensionCount(long struct, int value)Sets the specified value to theenabledExtensionCountfield of the specifiedstruct.
-
nppEnabledExtensionNames
public static void nppEnabledExtensionNames(long struct, @Nullable org.lwjgl.PointerBuffer value)Unsafe version ofppEnabledExtensionNames.
-
validate
public static void validate(long struct)
Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-
validate
public static void validate(long array, int count)Callsvalidate(long)for each struct contained in the specified struct array.- Parameters:
array- the struct array to validatecount- the number of structs inarray
-
-