Class VkInstanceCreateInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkInstanceCreateInfo>

org.lwjgl.vulkan.VkInstanceCreateInfo

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkInstanceCreateInfo
extends Struct<VkInstanceCreateInfo>
implements NativeResource

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 of VkInstanceCreateInfo structs.

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	ENABLEDEXTENSIONCOUNT	The struct member offsets.
static final int	ENABLEDLAYERCOUNT	The struct member offsets.
static final int	FLAGS	The struct member offsets.
static final int	PAPPLICATIONINFO	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	PPENABLEDEXTENSIONNAMES	The struct member offsets.
static final int	PPENABLEDLAYERNAMES	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkInstanceCreateInfo(ByteBuffer container)	Creates a VkInstanceCreateInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	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.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkInstanceCreateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkInstanceCreateInfo	calloc(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 @Nullable VkInstanceCreateInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkInstanceCreateInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	enabledExtensionCount()
int	enabledLayerCount()
int	flags()
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.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkInstanceCreateInfo.Buffer instance allocated on the specified MemoryStack.
static VkInstanceCreateInfo	malloc(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 @Nullable VkApplicationInfo	npApplicationInfo(long struct)	Unsafe version of pApplicationInfo().
static void	npApplicationInfo(long struct, @Nullable 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 @Nullable PointerBuffer	nppEnabledExtensionNames(long struct)	Unsafe version of ppEnabledExtensionNames.
static void	nppEnabledExtensionNames(long struct, @Nullable PointerBuffer value)	Unsafe version of ppEnabledExtensionNames.
static @Nullable PointerBuffer	nppEnabledLayerNames(long struct)	Unsafe version of ppEnabledLayerNames.
static void	nppEnabledLayerNames(long struct, @Nullable 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.
@Nullable VkApplicationInfo	pApplicationInfo()
VkInstanceCreateInfo	pApplicationInfo(@Nullable VkApplicationInfo value)	Sets the address of the specified VkApplicationInfo to the pApplicationInfo field.
long	pNext()
VkInstanceCreateInfo	pNext(long value)	Sets the specified value to the pNext field.
VkInstanceCreateInfo	pNext(VkDebugReportCallbackCreateInfoEXT value)	Prepends the specified VkDebugReportCallbackCreateInfoEXT value to the pNext chain.
VkInstanceCreateInfo	pNext(VkDebugUtilsMessengerCreateInfoEXT value)	Prepends the specified VkDebugUtilsMessengerCreateInfoEXT value to the pNext chain.
VkInstanceCreateInfo	pNext(VkDirectDriverLoadingListLUNARG value)	Prepends the specified VkDirectDriverLoadingListLUNARG value to the pNext chain.
VkInstanceCreateInfo	pNext(VkExportMetalObjectCreateInfoEXT value)	Prepends the specified VkExportMetalObjectCreateInfoEXT value to the pNext chain.
VkInstanceCreateInfo	pNext(VkLayerSettingsCreateInfoEXT value)	Prepends the specified VkLayerSettingsCreateInfoEXT value to the pNext chain.
VkInstanceCreateInfo	pNext(VkValidationFeaturesEXT value)	Prepends the specified VkValidationFeaturesEXT value to the pNext chain.
VkInstanceCreateInfo	pNext(VkValidationFlagsEXT value)	Prepends the specified VkValidationFlagsEXT value to the pNext chain.
@Nullable PointerBuffer	ppEnabledExtensionNames()
VkInstanceCreateInfo	ppEnabledExtensionNames(@Nullable PointerBuffer value)	Sets the address of the specified PointerBuffer to the ppEnabledExtensionNames field.
@Nullable PointerBuffer	ppEnabledLayerNames()
VkInstanceCreateInfo	ppEnabledLayerNames(@Nullable PointerBuffer value)	Sets the address of the specified PointerBuffer to the ppEnabledLayerNames field.
VkInstanceCreateInfo	set(int sType, long pNext, int flags, @Nullable VkApplicationInfo pApplicationInfo, @Nullable PointerBuffer ppEnabledLayerNames, @Nullable PointerBuffer ppEnabledExtensionNames)	Initializes this struct with the specified values.
VkInstanceCreateInfo	set(VkInstanceCreateInfo src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()
VkInstanceCreateInfo	sType(int value)	Sets the specified value to the sType field.
VkInstanceCreateInfo	sType$Default()	Sets the STRUCTURE_TYPE_INSTANCE_CREATE_INFO value to the sType field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

Methods inherited from class Struct

clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default

address, equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface NativeResource

close, free

Field Details

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 Details

VkInstanceCreateInfo

public VkInstanceCreateInfo(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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkInstanceCreateInfo>

sType

@NativeType("VkStructureType")
public int sType()

Returns:

the value of the sType field.

pNext

@NativeType("void const *")
public long pNext()

Returns:

the value of the pNext field.

flags

@NativeType("VkInstanceCreateFlags")
public int flags()

Returns:

the value of the flags field.

pApplicationInfo

@NativeType("VkApplicationInfo const *")
public @Nullable VkApplicationInfo pApplicationInfo()

Returns:

a VkApplicationInfo view of the struct pointed to by the pApplicationInfo field.

enabledLayerCount

@NativeType("uint32_t")
public int enabledLayerCount()

Returns:

the value of the enabledLayerCount field.

ppEnabledLayerNames

@NativeType("char const * const *")
public @Nullable PointerBuffer ppEnabledLayerNames()

Returns:

a PointerBuffer view of the data pointed to by the ppEnabledLayerNames field.

enabledExtensionCount

@NativeType("uint32_t")
public int enabledExtensionCount()

Returns:

the value of the enabledExtensionCount field.

ppEnabledExtensionNames

@NativeType("char const * const *")
public @Nullable PointerBuffer ppEnabledExtensionNames()

Returns:

a PointerBuffer view of the data pointed to by the ppEnabledExtensionNames field.

sType

public VkInstanceCreateInfo sType(@NativeType("VkStructureType")
 int value)

Sets the specified value to the sType field.

sType$Default

public VkInstanceCreateInfo sType$Default()

Sets the STRUCTURE_TYPE_INSTANCE_CREATE_INFO value to the sType field.

pNext

public VkInstanceCreateInfo pNext(@NativeType("void const *")
 long value)

Sets the specified value to the pNext field.

pNext

public VkInstanceCreateInfo pNext(VkDebugReportCallbackCreateInfoEXT value)

Prepends the specified VkDebugReportCallbackCreateInfoEXT value to the pNext chain.

pNext

public VkInstanceCreateInfo pNext(VkDebugUtilsMessengerCreateInfoEXT value)

Prepends the specified VkDebugUtilsMessengerCreateInfoEXT value to the pNext chain.

pNext

public VkInstanceCreateInfo pNext(VkDirectDriverLoadingListLUNARG value)

Prepends the specified VkDirectDriverLoadingListLUNARG value to the pNext chain.

pNext

public VkInstanceCreateInfo pNext(VkExportMetalObjectCreateInfoEXT value)

Prepends the specified VkExportMetalObjectCreateInfoEXT value to the pNext chain.

pNext

public VkInstanceCreateInfo pNext(VkLayerSettingsCreateInfoEXT value)

Prepends the specified VkLayerSettingsCreateInfoEXT value to the pNext chain.

pNext

public VkInstanceCreateInfo pNext(VkValidationFeaturesEXT value)

Prepends the specified VkValidationFeaturesEXT value to the pNext chain.

pNext

public VkInstanceCreateInfo pNext(VkValidationFlagsEXT value)

Prepends the specified VkValidationFlagsEXT value to the pNext chain.

flags

public VkInstanceCreateInfo flags(@NativeType("VkInstanceCreateFlags")
 int value)

Sets the specified value to the flags field.

pApplicationInfo

public VkInstanceCreateInfo pApplicationInfo(@NativeType("VkApplicationInfo const *")
 @Nullable VkApplicationInfo value)

Sets the address of the specified VkApplicationInfo to the pApplicationInfo field.

ppEnabledLayerNames

public VkInstanceCreateInfo ppEnabledLayerNames(@NativeType("char const * const *")
 @Nullable PointerBuffer value)

Sets the address of the specified PointerBuffer to the ppEnabledLayerNames field.

ppEnabledExtensionNames

public VkInstanceCreateInfo ppEnabledExtensionNames(@NativeType("char const * const *")
 @Nullable 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 PointerBuffer ppEnabledLayerNames,
 @Nullable 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

public static @Nullable 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

public static @Nullable VkInstanceCreateInfo.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

malloc

public static VkInstanceCreateInfo malloc(MemoryStack stack)

Returns a new VkInstanceCreateInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkInstanceCreateInfo calloc(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

malloc

public static VkInstanceCreateInfo.Buffer malloc(int capacity,
 MemoryStack stack)

Returns a new VkInstanceCreateInfo.Buffer instance allocated on the specified MemoryStack.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkInstanceCreateInfo.Buffer calloc(int capacity,
 MemoryStack stack)

Returns a new VkInstanceCreateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

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

public static @Nullable VkApplicationInfo npApplicationInfo(long struct)

Unsafe version of pApplicationInfo().

nenabledLayerCount

public static int nenabledLayerCount(long struct)

Unsafe version of enabledLayerCount().

nppEnabledLayerNames

public static @Nullable PointerBuffer nppEnabledLayerNames(long struct)

Unsafe version of ppEnabledLayerNames.

nenabledExtensionCount

public static int nenabledExtensionCount(long struct)

Unsafe version of enabledExtensionCount().

nppEnabledExtensionNames

public static @Nullable 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 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 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