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
VkInstance
should be created.Valid Usage
sType
must beSTRUCTURE_TYPE_INSTANCE_CREATE_INFO
pNext
must beNULL
flags
must be 0- If
pApplicationInfo
is notNULL
,pApplicationInfo
must be a pointer to a validVkApplicationInfo
structure - If
enabledLayerCount
is not 0,ppEnabledLayerNames
must be a pointer to an array ofenabledLayerCount
null-terminated strings - If
enabledExtensionCount
is not 0,ppEnabledExtensionNames
must be a pointer to an array ofenabledExtensionCount
null-terminated strings - Any given element of
ppEnabledLayerNames
must be the name of a layer present on the system, exactly matching a string returned in theVkLayerProperties
structure byEnumerateInstanceLayerProperties
- Any given element of
ppEnabledExtensionNames
must be the name of an extension present on the system, exactly matching a string returned in theVkExtensionProperties
structure byEnumerateInstanceExtensionProperties
- If an extension listed in
ppEnabledExtensionNames
is 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_INFO
pNext
– reserved for use by extensionsflags
– reserved for future usepApplicationInfo
– a pointer to an instance ofVkApplicationInfo
enabledLayerCount
– the number of global layers to enableppEnabledLayerNames
– a pointer to an array ofenabledLayerCount
null-terminated UTF-8 strings containing the names of layers to enableenabledExtensionCount
– the number of global extensions to enableppEnabledExtensionNames
– a pointer to an array ofenabledExtensionCount
null-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 class
VkInstanceCreateInfo.Buffer
An array ofVkInstanceCreateInfo
structs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static int
SIZEOF
The 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 aVkInstanceCreateInfo
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description static VkInstanceCreateInfo
calloc()
Returns a newVkInstanceCreateInfo
instance allocated withmemCalloc
.static VkInstanceCreateInfo.Buffer
calloc(int capacity)
Returns a newVkInstanceCreateInfo.Buffer
instance allocated withmemCalloc
.static VkInstanceCreateInfo
callocStack()
Returns a newVkInstanceCreateInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkInstanceCreateInfo.Buffer
callocStack(int capacity)
Returns a newVkInstanceCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkInstanceCreateInfo.Buffer
callocStack(int capacity, MemoryStack stack)
Returns a newVkInstanceCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkInstanceCreateInfo
callocStack(MemoryStack stack)
Returns a newVkInstanceCreateInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkInstanceCreateInfo
create()
Returns a newVkInstanceCreateInfo
instance allocated withBufferUtils
.static VkInstanceCreateInfo.Buffer
create(int capacity)
Returns a newVkInstanceCreateInfo.Buffer
instance allocated withBufferUtils
.static VkInstanceCreateInfo
create(long address)
Returns a newVkInstanceCreateInfo
instance for the specified memory address ornull
if the address isNULL
.static VkInstanceCreateInfo.Buffer
create(long address, int capacity)
Create aVkInstanceCreateInfo.Buffer
instance at the specified memory.int
enabledExtensionCount()
Returns the value of theenabledExtensionCount
field.int
enabledLayerCount()
Returns the value of theenabledLayerCount
field.int
flags()
Returns the value of theflags
field.VkInstanceCreateInfo
flags(int value)
Sets the specified value to theflags
field.static VkInstanceCreateInfo
malloc()
Returns a newVkInstanceCreateInfo
instance allocated withmemAlloc
.static VkInstanceCreateInfo.Buffer
malloc(int capacity)
Returns a newVkInstanceCreateInfo.Buffer
instance allocated withmemAlloc
.static VkInstanceCreateInfo
mallocStack()
Returns a newVkInstanceCreateInfo
instance allocated on the thread-localMemoryStack
.static VkInstanceCreateInfo.Buffer
mallocStack(int capacity)
Returns a newVkInstanceCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
.static VkInstanceCreateInfo.Buffer
mallocStack(int capacity, MemoryStack stack)
Returns a newVkInstanceCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkInstanceCreateInfo
mallocStack(MemoryStack stack)
Returns a newVkInstanceCreateInfo
instance allocated on the specifiedMemoryStack
.VkInstanceCreateInfo
nset(long struct)
Unsafe version ofset
.VkApplicationInfo
pApplicationInfo()
Returns aVkApplicationInfo
view of the struct pointed to by thepApplicationInfo
field.VkInstanceCreateInfo
pApplicationInfo(VkApplicationInfo value)
Sets the address of the specifiedVkApplicationInfo
to thepApplicationInfo
field.long
pNext()
Returns the value of thepNext
field.VkInstanceCreateInfo
pNext(long value)
Sets the specified value to thepNext
field.PointerBuffer
ppEnabledExtensionNames()
Returns aPointerBuffer
view of the data pointed to by theppEnabledExtensionNames
field.VkInstanceCreateInfo
ppEnabledExtensionNames(PointerBuffer value)
Sets the address of the specifiedPointerBuffer
to theppEnabledExtensionNames
field.PointerBuffer
ppEnabledLayerNames()
Returns aPointerBuffer
view of the data pointed to by theppEnabledLayerNames
field.VkInstanceCreateInfo
ppEnabledLayerNames(PointerBuffer value)
Sets the address of the specifiedPointerBuffer
to theppEnabledLayerNames
field.VkInstanceCreateInfo
set(int sType, long pNext, int flags, VkApplicationInfo pApplicationInfo, PointerBuffer ppEnabledLayerNames, PointerBuffer ppEnabledExtensionNames)
Initializes this struct with the specified values.VkInstanceCreateInfo
set(VkInstanceCreateInfo src)
Copies the specified struct data to this struct.int
sizeof()
Returns thesizeof(struct)
.int
sType()
Returns the value of thesType
field.VkInstanceCreateInfo
sType(int value)
Sets the specified value to thesType
field.static void
validate(long struct)
Validates pointer members that should not beNULL
.static void
validate(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 aVkInstanceCreateInfo
instance at the current position of the specifiedByteBuffer
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()
Description copied from class:Struct
Returns thesizeof(struct)
.
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
flags
public int flags()
Returns the value of theflags
field.
-
pApplicationInfo
public VkApplicationInfo pApplicationInfo()
Returns aVkApplicationInfo
view of the struct pointed to by thepApplicationInfo
field.
-
enabledLayerCount
public int enabledLayerCount()
Returns the value of theenabledLayerCount
field.
-
ppEnabledLayerNames
public PointerBuffer ppEnabledLayerNames()
Returns aPointerBuffer
view of the data pointed to by theppEnabledLayerNames
field.
-
enabledExtensionCount
public int enabledExtensionCount()
Returns the value of theenabledExtensionCount
field.
-
ppEnabledExtensionNames
public PointerBuffer ppEnabledExtensionNames()
Returns aPointerBuffer
view of the data pointed to by theppEnabledExtensionNames
field.
-
sType
public VkInstanceCreateInfo sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkInstanceCreateInfo pNext(long value)
Sets the specified value to thepNext
field.
-
flags
public VkInstanceCreateInfo flags(int value)
Sets the specified value to theflags
field.
-
pApplicationInfo
public VkInstanceCreateInfo pApplicationInfo(VkApplicationInfo value)
Sets the address of the specifiedVkApplicationInfo
to thepApplicationInfo
field.
-
ppEnabledLayerNames
public VkInstanceCreateInfo ppEnabledLayerNames(PointerBuffer value)
Sets the address of the specifiedPointerBuffer
to theppEnabledLayerNames
field.
-
ppEnabledExtensionNames
public VkInstanceCreateInfo ppEnabledExtensionNames(PointerBuffer value)
Sets the address of the specifiedPointerBuffer
to theppEnabledExtensionNames
field.
-
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 newVkInstanceCreateInfo
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkInstanceCreateInfo calloc()
Returns a newVkInstanceCreateInfo
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkInstanceCreateInfo create()
Returns a newVkInstanceCreateInfo
instance allocated withBufferUtils
.
-
create
public static VkInstanceCreateInfo create(long address)
Returns a newVkInstanceCreateInfo
instance for the specified memory address ornull
if the address isNULL
.
-
malloc
public static VkInstanceCreateInfo.Buffer malloc(int capacity)
Returns a newVkInstanceCreateInfo.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkInstanceCreateInfo.Buffer calloc(int capacity)
Returns a newVkInstanceCreateInfo.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkInstanceCreateInfo.Buffer create(int capacity)
Returns a newVkInstanceCreateInfo.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkInstanceCreateInfo.Buffer create(long address, int capacity)
Create aVkInstanceCreateInfo.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
mallocStack
public static VkInstanceCreateInfo mallocStack()
Returns a newVkInstanceCreateInfo
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkInstanceCreateInfo callocStack()
Returns a newVkInstanceCreateInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkInstanceCreateInfo mallocStack(MemoryStack stack)
Returns a newVkInstanceCreateInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkInstanceCreateInfo callocStack(MemoryStack stack)
Returns a newVkInstanceCreateInfo
instance allocated on the specifiedMemoryStack
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 newVkInstanceCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkInstanceCreateInfo.Buffer callocStack(int capacity)
Returns a newVkInstanceCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkInstanceCreateInfo.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkInstanceCreateInfo.Buffer
instance 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.Buffer
instance allocated on the specifiedMemoryStack
and 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
-
-