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.NativeResource
Structure specifying parameters of a newly created instance.Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_INSTANCE_CREATE_INFO
- Each
pNext
member of any structure (including this one) in thepNext
chain must be eitherNULL
or a pointer to a valid instance ofVkDebugReportCallbackCreateInfoEXT
,VkDebugUtilsMessengerCreateInfoEXT
,VkValidationFeaturesEXT
, orVkValidationFlagsEXT
- Each
sType
member in thepNext
chain must be unique flags
must be 0- If
pApplicationInfo
is notNULL
,pApplicationInfo
must be a valid pointer to a validVkApplicationInfo
structure - If
enabledLayerCount
is not 0,ppEnabledLayerNames
must be a valid pointer to an array ofenabledLayerCount
null-terminated UTF-8 strings - If
enabledExtensionCount
is not 0,ppEnabledExtensionNames
must be a valid pointer to an array ofenabledExtensionCount
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 an instance ofVkApplicationInfo
. If notNULL
, 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 ofenabledLayerCount
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 ofenabledExtensionCount
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 Description static class
VkInstanceCreateInfo.Buffer
An array ofVkInstanceCreateInfo
structs.
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
ENABLEDEXTENSIONCOUNT
ENABLEDLAYERCOUNT
FLAGS
PAPPLICATIONINFO
PNEXT
PPENABLEDEXTENSIONNAMES
PPENABLEDLAYERNAMESThe struct member offsets.static int
SIZEOF
The struct size in bytes.static int
STYPE
The struct member offsets.
-
Constructor Summary
Constructors Constructor 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 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, org.lwjgl.system.MemoryStack stack)
Returns a newVkInstanceCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkInstanceCreateInfo
callocStack(org.lwjgl.system.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.static VkInstanceCreateInfo.Buffer
create(long address, int capacity)
Create aVkInstanceCreateInfo.Buffer
instance at the specified memory.static VkInstanceCreateInfo
createSafe(long address)
static VkInstanceCreateInfo.Buffer
createSafe(long address, int capacity)
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, org.lwjgl.system.MemoryStack stack)
Returns a newVkInstanceCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkInstanceCreateInfo
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkInstanceCreateInfo
instance allocated on the specifiedMemoryStack
.static int
nenabledExtensionCount(long struct)
Unsafe version ofenabledExtensionCount()
.static void
nenabledExtensionCount(long struct, int value)
Sets the specified value to theenabledExtensionCount
field of the specifiedstruct
.static int
nenabledLayerCount(long struct)
Unsafe version ofenabledLayerCount()
.static void
nenabledLayerCount(long struct, int value)
Sets the specified value to theenabledLayerCount
field of the specifiedstruct
.static int
nflags(long struct)
Unsafe version offlags()
.static void
nflags(long struct, int value)
Unsafe version offlags
.static VkApplicationInfo
npApplicationInfo(long struct)
Unsafe version ofpApplicationInfo()
.static void
npApplicationInfo(long struct, VkApplicationInfo value)
Unsafe version ofpApplicationInfo
.static long
npNext(long struct)
Unsafe version ofpNext()
.static void
npNext(long struct, long value)
Unsafe version ofpNext
.static org.lwjgl.PointerBuffer
nppEnabledExtensionNames(long struct)
Unsafe version ofppEnabledExtensionNames
.static void
nppEnabledExtensionNames(long struct, org.lwjgl.PointerBuffer value)
Unsafe version ofppEnabledExtensionNames
.static org.lwjgl.PointerBuffer
nppEnabledLayerNames(long struct)
Unsafe version ofppEnabledLayerNames
.static void
nppEnabledLayerNames(long struct, org.lwjgl.PointerBuffer value)
Unsafe version ofppEnabledLayerNames
.static int
nsType(long struct)
Unsafe version ofsType()
.static void
nsType(long struct, int value)
Unsafe version ofsType
.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.org.lwjgl.PointerBuffer
ppEnabledExtensionNames()
Returns aPointerBuffer
view of the data pointed to by theppEnabledExtensionNames
field.VkInstanceCreateInfo
ppEnabledExtensionNames(org.lwjgl.PointerBuffer value)
Sets the address of the specifiedPointerBuffer
to theppEnabledExtensionNames
field.org.lwjgl.PointerBuffer
ppEnabledLayerNames()
Returns aPointerBuffer
view of the data pointed to by theppEnabledLayerNames
field.VkInstanceCreateInfo
ppEnabledLayerNames(org.lwjgl.PointerBuffer value)
Sets the address of the specifiedPointerBuffer
to theppEnabledLayerNames
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 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)
Callsvalidate(long)
for each struct contained in the specified struct array.
-
-
-
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()
- Specified by:
sizeof
in classorg.lwjgl.system.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
@Nullable 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
@Nullable public org.lwjgl.PointerBuffer ppEnabledLayerNames()
Returns aPointerBuffer
view of the data pointed to by theppEnabledLayerNames
field.
-
enabledExtensionCount
public int enabledExtensionCount()
Returns the value of theenabledExtensionCount
field.
-
ppEnabledExtensionNames
@Nullable public org.lwjgl.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(@Nullable VkApplicationInfo value)
Sets the address of the specifiedVkApplicationInfo
to thepApplicationInfo
field.
-
ppEnabledLayerNames
public VkInstanceCreateInfo ppEnabledLayerNames(@Nullable org.lwjgl.PointerBuffer value)
Sets the address of the specifiedPointerBuffer
to theppEnabledLayerNames
field.
-
ppEnabledExtensionNames
public VkInstanceCreateInfo ppEnabledExtensionNames(@Nullable org.lwjgl.PointerBuffer value)
Sets the address of the specifiedPointerBuffer
to theppEnabledExtensionNames
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 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.
-
createSafe
@Nullable public static VkInstanceCreateInfo createSafe(long address)
-
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
-
createSafe
@Nullable public static VkInstanceCreateInfo.Buffer createSafe(long address, int 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(org.lwjgl.system.MemoryStack stack)
Returns a newVkInstanceCreateInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkInstanceCreateInfo callocStack(org.lwjgl.system.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, org.lwjgl.system.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, org.lwjgl.system.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
-
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 theenabledLayerCount
field 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 theenabledExtensionCount
field 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
-
-