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, NativeResource, Pointer
public class VkInstanceCreateInfo extends Struct
Khronos Reference Page
Vulkan SpecificationContains information about how a
VkInstanceshould be created.Valid Usage
sTypemust beSTRUCTURE_TYPE_INSTANCE_CREATE_INFOpNextmust beNULLflagsmust be 0- If
pApplicationInfois notNULL,pApplicationInfomust be a pointer to a validVkApplicationInfostructure - If
enabledLayerCountis not 0,ppEnabledLayerNamesmust be a pointer to an array ofenabledLayerCountnull-terminated strings - If
enabledExtensionCountis not 0,ppEnabledExtensionNamesmust be a pointer to an array ofenabledExtensionCountnull-terminated strings - Any given element of
ppEnabledLayerNamesmust be the name of a layer present on the system, exactly matching a string returned in theVkLayerPropertiesstructure byEnumerateInstanceLayerProperties - Any given element of
ppEnabledExtensionNamesmust be the name of an extension present on the system, exactly matching a string returned in theVkExtensionPropertiesstructure byEnumerateInstanceExtensionProperties - If an extension listed in
ppEnabledExtensionNamesis provided as part of a layer, then both the layer and extension must be enabled to enable that extension
Member documentation
sType– the type of this structure. Must be:STRUCTURE_TYPE_INSTANCE_CREATE_INFOpNext– reserved for use by extensionsflags– reserved for future usepApplicationInfo– a pointer to an instance ofVkApplicationInfoenabledLayerCount– the number of global layers to enableppEnabledLayerNames– a pointer to an array ofenabledLayerCountnull-terminated UTF-8 strings containing the names of layers to enableenabledExtensionCount– the number of global extensions to enableppEnabledExtensionNames– a pointer to an array ofenabledExtensionCountnull-terminated UTF-8 strings containing the names of extensions to enable
Layout
struct VkInstanceCreateInfo { VkStructureType sType; const void * pNext; VkInstanceCreateFlags flags; const VkApplicationInfo * pApplicationInfo; uint32_t enabledLayerCount; const char * const * ppEnabledLayerNames; uint32_t enabledExtensionCount; const char * const * ppEnabledExtensionNames; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static classVkInstanceCreateInfo.BufferAn array ofVkInstanceCreateInfostructs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static intSIZEOFThe struct size in bytes.-
Fields inherited from interface org.lwjgl.system.Pointer
POINTER_SHIFT, POINTER_SIZE
-
-
Constructor Summary
Constructors Constructor and 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 and 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, MemoryStack stack)Returns a newVkInstanceCreateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkInstanceCreateInfocallocStack(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 ornullif the address isNULL.static VkInstanceCreateInfo.Buffercreate(long address, int capacity)Create aVkInstanceCreateInfo.Bufferinstance at the specified memory.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, MemoryStack stack)Returns a newVkInstanceCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.static VkInstanceCreateInfomallocStack(MemoryStack stack)Returns a newVkInstanceCreateInfoinstance allocated on the specifiedMemoryStack.VkInstanceCreateInfonset(long struct)Unsafe version ofset.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.PointerBufferppEnabledExtensionNames()Returns aPointerBufferview of the data pointed to by theppEnabledExtensionNamesfield.VkInstanceCreateInfoppEnabledExtensionNames(PointerBuffer value)Sets the address of the specifiedPointerBufferto theppEnabledExtensionNamesfield.PointerBufferppEnabledLayerNames()Returns aPointerBufferview of the data pointed to by theppEnabledLayerNamesfield.VkInstanceCreateInfoppEnabledLayerNames(PointerBuffer value)Sets the address of the specifiedPointerBufferto theppEnabledLayerNamesfield.VkInstanceCreateInfoset(int sType, long pNext, int flags, VkApplicationInfo pApplicationInfo, PointerBuffer ppEnabledLayerNames, PointerBuffer ppEnabledExtensionNames)Initializes this struct with the specified values.VkInstanceCreateInfoset(VkInstanceCreateInfo src)Copies the specified struct data to this struct.intsizeof()Returns thesizeof(struct).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)CallsVkInstanceCreateInfo.validate(long)for each struct contained in the specified struct array.-
Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
-
Methods inherited from interface org.lwjgl.system.NativeResource
close
-
-
-
-
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()
Description copied from class:StructReturns thesizeof(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
public VkApplicationInfo pApplicationInfo()
Returns aVkApplicationInfoview of the struct pointed to by thepApplicationInfofield.
-
enabledLayerCount
public int enabledLayerCount()
Returns the value of theenabledLayerCountfield.
-
ppEnabledLayerNames
public PointerBuffer ppEnabledLayerNames()
Returns aPointerBufferview of the data pointed to by theppEnabledLayerNamesfield.
-
enabledExtensionCount
public int enabledExtensionCount()
Returns the value of theenabledExtensionCountfield.
-
ppEnabledExtensionNames
public 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(VkApplicationInfo value)
Sets the address of the specifiedVkApplicationInfoto thepApplicationInfofield.
-
ppEnabledLayerNames
public VkInstanceCreateInfo ppEnabledLayerNames(PointerBuffer value)
Sets the address of the specifiedPointerBufferto theppEnabledLayerNamesfield.
-
ppEnabledExtensionNames
public VkInstanceCreateInfo ppEnabledExtensionNames(PointerBuffer value)
Sets the address of the specifiedPointerBufferto theppEnabledExtensionNamesfield.
-
set
public VkInstanceCreateInfo set(int sType, long pNext, int flags, VkApplicationInfo pApplicationInfo, PointerBuffer ppEnabledLayerNames, PointerBuffer ppEnabledExtensionNames)
Initializes this struct with the specified values.
-
nset
public VkInstanceCreateInfo nset(long struct)
Unsafe version ofset.
-
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 ornullif the address isNULL.
-
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
-
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(MemoryStack stack)
Returns a newVkInstanceCreateInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkInstanceCreateInfo callocStack(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, 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, 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
-
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)CallsVkInstanceCreateInfo.validate(long)for each struct contained in the specified struct array.- Parameters:
array- the struct array to validatecount- the number of structs inarray
-
-