org.lwjgl.vulkan.VkInstanceCreateInfo Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of lwjgl-vulkan Show documentation
Show all versions of lwjgl-vulkan Show documentation
A new generation graphics and compute API that provides high-efficiency, cross-platform access to modern GPUs used in a wide variety of devices from PCs and consoles to mobile phones and embedded platforms.
/*
* Copyright LWJGL. All rights reserved.
* License terms: https://www.lwjgl.org/license
* MACHINE GENERATED FILE, DO NOT EDIT
*/
package org.lwjgl.vulkan;
import javax.annotation.*;
import java.nio.*;
import org.lwjgl.*;
import org.lwjgl.system.*;
import static org.lwjgl.system.Checks.*;
import static org.lwjgl.system.MemoryUtil.*;
import static org.lwjgl.system.MemoryStack.*;
/**
* Structure specifying parameters of a newly created instance.
*
* Valid Usage (Implicit)
*
*
* - {@code sType} must be {@link VK10#VK_STRUCTURE_TYPE_INSTANCE_CREATE_INFO STRUCTURE_TYPE_INSTANCE_CREATE_INFO}
* - Each {@code pNext} member of any structure (including this one) in the {@code pNext} chain must be either {@code NULL} or a pointer to a valid instance of {@link VkDebugReportCallbackCreateInfoEXT} or {@link VkValidationFlagsEXT}
* - Each {@code sType} member in the {@code pNext} chain must be unique
* - {@code flags} must be 0
* - If {@code pApplicationInfo} is not {@code NULL}, {@code pApplicationInfo} must be a valid pointer to a valid {@link VkApplicationInfo} structure
* - If {@code enabledLayerCount} is not 0, {@code ppEnabledLayerNames} must be a valid pointer to an array of {@code enabledLayerCount} null-terminated UTF-8 strings
* - If {@code enabledExtensionCount} is not 0, {@code ppEnabledExtensionNames} must be a valid pointer to an array of {@code enabledExtensionCount} null-terminated UTF-8 strings
*
*
* See Also
*
* {@link VkApplicationInfo}, {@link VK10#vkCreateInstance CreateInstance}
*
* Member documentation
*
*
* - {@code sType} – the type of this structure.
* - {@code pNext} – {@code NULL} or a pointer to an extension-specific structure.
* - {@code flags} – reserved for future use.
* - {@code pApplicationInfo} – {@code NULL} or a pointer to an instance of {@link VkApplicationInfo}. If not {@code NULL}, this information helps implementations recognize behavior inherent to classes of applications. {@link VkApplicationInfo} is defined in detail below.
* - {@code enabledLayerCount} – the number of global layers to enable.
* - {@code ppEnabledLayerNames} – a pointer to an array of {@code enabledLayerCount} null-terminated UTF-8 strings containing the names of layers to enable for the created instance. See the Layers section for further details.
* - {@code enabledExtensionCount} – the number of global extensions to enable.
* - {@code ppEnabledExtensionNames} – a pointer to an array of {@code enabledExtensionCount} null-terminated UTF-8 strings containing the names of extensions to enable.
*
*
* Layout
*
*
* struct VkInstanceCreateInfo {
* VkStructureType sType;
* const void * pNext;
* VkInstanceCreateFlags flags;
* const {@link VkApplicationInfo VkApplicationInfo} * pApplicationInfo;
* uint32_t enabledLayerCount;
* const char * const * ppEnabledLayerNames;
* uint32_t enabledExtensionCount;
* const char * const * ppEnabledExtensionNames;
* }The created instance holds a strong reference to the container object.
*/
public VkInstanceCreateInfo(ByteBuffer container) {
this(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** Returns the value of the {@code sType} field. */
@NativeType("VkStructureType")
public int sType() { return nsType(address()); }
/** Returns the value of the {@code pNext} field. */
@NativeType("const void *")
public long pNext() { return npNext(address()); }
/** Returns the value of the {@code flags} field. */
@NativeType("VkInstanceCreateFlags")
public int flags() { return nflags(address()); }
/** Returns a {@link VkApplicationInfo} view of the struct pointed to by the {@code pApplicationInfo} field. */
@Nullable
@NativeType("const VkApplicationInfo *")
public VkApplicationInfo pApplicationInfo() { return npApplicationInfo(address()); }
/** Returns the value of the {@code enabledLayerCount} field. */
@NativeType("uint32_t")
public int enabledLayerCount() { return nenabledLayerCount(address()); }
/** Returns a {@link PointerBuffer} view of the data pointed to by the {@code ppEnabledLayerNames} field. */
@Nullable
@NativeType("const char * const *")
public PointerBuffer ppEnabledLayerNames() { return nppEnabledLayerNames(address()); }
/** Returns the value of the {@code enabledExtensionCount} field. */
@NativeType("uint32_t")
public int enabledExtensionCount() { return nenabledExtensionCount(address()); }
/** Returns a {@link PointerBuffer} view of the data pointed to by the {@code ppEnabledExtensionNames} field. */
@Nullable
@NativeType("const char * const *")
public PointerBuffer ppEnabledExtensionNames() { return nppEnabledExtensionNames(address()); }
/** Sets the specified value to the {@code sType} field. */
public VkInstanceCreateInfo sType(@NativeType("VkStructureType") int value) { nsType(address(), value); return this; }
/** Sets the specified value to the {@code pNext} field. */
public VkInstanceCreateInfo pNext(@NativeType("const void *") long value) { npNext(address(), value); return this; }
/** Sets the specified value to the {@code flags} field. */
public VkInstanceCreateInfo flags(@NativeType("VkInstanceCreateFlags") int value) { nflags(address(), value); return this; }
/** Sets the address of the specified {@link VkApplicationInfo} to the {@code pApplicationInfo} field. */
public VkInstanceCreateInfo pApplicationInfo(@Nullable @NativeType("const VkApplicationInfo *") VkApplicationInfo value) { npApplicationInfo(address(), value); return this; }
/** Sets the address of the specified {@link PointerBuffer} to the {@code ppEnabledLayerNames} field. */
public VkInstanceCreateInfo ppEnabledLayerNames(@Nullable @NativeType("const char * const *") PointerBuffer value) { nppEnabledLayerNames(address(), value); return this; }
/** Sets the address of the specified {@link PointerBuffer} to the {@code ppEnabledExtensionNames} field. */
public VkInstanceCreateInfo ppEnabledExtensionNames(@Nullable @NativeType("const char * const *") PointerBuffer value) { nppEnabledExtensionNames(address(), value); return this; }
/** Initializes this struct with the specified values. */
public VkInstanceCreateInfo set(
int sType,
long pNext,
int flags,
VkApplicationInfo pApplicationInfo,
PointerBuffer ppEnabledLayerNames,
PointerBuffer ppEnabledExtensionNames
) {
sType(sType);
pNext(pNext);
flags(flags);
pApplicationInfo(pApplicationInfo);
ppEnabledLayerNames(ppEnabledLayerNames);
ppEnabledExtensionNames(ppEnabledExtensionNames);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public VkInstanceCreateInfo set(VkInstanceCreateInfo src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@link VkInstanceCreateInfo} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkInstanceCreateInfo malloc() {
return create(nmemAllocChecked(SIZEOF));
}
/** Returns a new {@link VkInstanceCreateInfo} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkInstanceCreateInfo calloc() {
return create(nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@link VkInstanceCreateInfo} instance allocated with {@link BufferUtils}. */
public static VkInstanceCreateInfo create() {
return new VkInstanceCreateInfo(BufferUtils.createByteBuffer(SIZEOF));
}
/** Returns a new {@link VkInstanceCreateInfo} instance for the specified memory address. */
public static VkInstanceCreateInfo create(long address) {
return new VkInstanceCreateInfo(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkInstanceCreateInfo createSafe(long address) {
return address == NULL ? null : create(address);
}
/**
* Returns a new {@link VkInstanceCreateInfo.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkInstanceCreateInfo.Buffer malloc(int capacity) {
return create(__malloc(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkInstanceCreateInfo.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkInstanceCreateInfo.Buffer calloc(int capacity) {
return create(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkInstanceCreateInfo.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static VkInstanceCreateInfo.Buffer create(int capacity) {
return new Buffer(__create(capacity, SIZEOF));
}
/**
* Create a {@link VkInstanceCreateInfo.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static VkInstanceCreateInfo.Buffer create(long address, int capacity) {
return new Buffer(address, capacity);
}
/** Like {@link #create(long, int) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkInstanceCreateInfo.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : create(address, capacity);
}
// -----------------------------------
/** Returns a new {@link VkInstanceCreateInfo} instance allocated on the thread-local {@link MemoryStack}. */
public static VkInstanceCreateInfo mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link VkInstanceCreateInfo} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static VkInstanceCreateInfo callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link VkInstanceCreateInfo} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkInstanceCreateInfo mallocStack(MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link VkInstanceCreateInfo} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VkInstanceCreateInfo callocStack(MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkInstanceCreateInfo.Buffer} instance allocated on the thread-local {@link MemoryStack}.
*
* @param capacity the buffer capacity
*/
public static VkInstanceCreateInfo.Buffer mallocStack(int capacity) {
return mallocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkInstanceCreateInfo.Buffer} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero.
*
* @param capacity the buffer capacity
*/
public static VkInstanceCreateInfo.Buffer callocStack(int capacity) {
return callocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkInstanceCreateInfo.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static VkInstanceCreateInfo.Buffer mallocStack(int capacity, MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link VkInstanceCreateInfo.Buffer} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static VkInstanceCreateInfo.Buffer callocStack(int capacity, MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #sType}. */
public static int nsType(long struct) { return memGetInt(struct + VkInstanceCreateInfo.STYPE); }
/** Unsafe version of {@link #pNext}. */
public static long npNext(long struct) { return memGetAddress(struct + VkInstanceCreateInfo.PNEXT); }
/** Unsafe version of {@link #flags}. */
public static int nflags(long struct) { return memGetInt(struct + VkInstanceCreateInfo.FLAGS); }
/** Unsafe version of {@link #pApplicationInfo}. */
@Nullable public static VkApplicationInfo npApplicationInfo(long struct) { return VkApplicationInfo.createSafe(memGetAddress(struct + VkInstanceCreateInfo.PAPPLICATIONINFO)); }
/** Unsafe version of {@link #enabledLayerCount}. */
public static int nenabledLayerCount(long struct) { return memGetInt(struct + VkInstanceCreateInfo.ENABLEDLAYERCOUNT); }
/** Unsafe version of {@link #ppEnabledLayerNames() ppEnabledLayerNames}. */
@Nullable public static PointerBuffer nppEnabledLayerNames(long struct) { return memPointerBufferSafe(memGetAddress(struct + VkInstanceCreateInfo.PPENABLEDLAYERNAMES), nenabledLayerCount(struct)); }
/** Unsafe version of {@link #enabledExtensionCount}. */
public static int nenabledExtensionCount(long struct) { return memGetInt(struct + VkInstanceCreateInfo.ENABLEDEXTENSIONCOUNT); }
/** Unsafe version of {@link #ppEnabledExtensionNames() ppEnabledExtensionNames}. */
@Nullable public static PointerBuffer nppEnabledExtensionNames(long struct) { return memPointerBufferSafe(memGetAddress(struct + VkInstanceCreateInfo.PPENABLEDEXTENSIONNAMES), nenabledExtensionCount(struct)); }
/** Unsafe version of {@link #sType(int) sType}. */
public static void nsType(long struct, int value) { memPutInt(struct + VkInstanceCreateInfo.STYPE, value); }
/** Unsafe version of {@link #pNext(long) pNext}. */
public static void npNext(long struct, long value) { memPutAddress(struct + VkInstanceCreateInfo.PNEXT, value); }
/** Unsafe version of {@link #flags(int) flags}. */
public static void nflags(long struct, int value) { memPutInt(struct + VkInstanceCreateInfo.FLAGS, value); }
/** Unsafe version of {@link #pApplicationInfo(VkApplicationInfo) pApplicationInfo}. */
public static void npApplicationInfo(long struct, @Nullable VkApplicationInfo value) { memPutAddress(struct + VkInstanceCreateInfo.PAPPLICATIONINFO, memAddressSafe(value)); }
/** Sets the specified value to the {@code enabledLayerCount} field of the specified {@code struct}. */
public static void nenabledLayerCount(long struct, int value) { memPutInt(struct + VkInstanceCreateInfo.ENABLEDLAYERCOUNT, value); }
/** Unsafe version of {@link #ppEnabledLayerNames(PointerBuffer) ppEnabledLayerNames}. */
public static void nppEnabledLayerNames(long struct, @Nullable PointerBuffer value) { memPutAddress(struct + VkInstanceCreateInfo.PPENABLEDLAYERNAMES, memAddressSafe(value)); nenabledLayerCount(struct, value == null ? 0 : value.remaining()); }
/** Sets the specified value to the {@code enabledExtensionCount} field of the specified {@code struct}. */
public static void nenabledExtensionCount(long struct, int value) { memPutInt(struct + VkInstanceCreateInfo.ENABLEDEXTENSIONCOUNT, value); }
/** Unsafe version of {@link #ppEnabledExtensionNames(PointerBuffer) ppEnabledExtensionNames}. */
public static void nppEnabledExtensionNames(long struct, @Nullable PointerBuffer value) { memPutAddress(struct + VkInstanceCreateInfo.PPENABLEDEXTENSIONNAMES, memAddressSafe(value)); nenabledExtensionCount(struct, value == null ? 0 : value.remaining()); }
/**
* Validates pointer members that should not be {@code NULL}.
*
* @param struct the struct to validate
*/
public static void validate(long struct) {
if (nenabledLayerCount(struct) != 0) {
check(memGetAddress(struct + VkInstanceCreateInfo.PPENABLEDLAYERNAMES));
}
if (nenabledExtensionCount(struct) != 0) {
check(memGetAddress(struct + VkInstanceCreateInfo.PPENABLEDEXTENSIONNAMES));
}
}
/**
* Calls {@link #validate(long)} for each struct contained in the specified struct array.
*
* @param array the struct array to validate
* @param count the number of structs in {@code array}
*/
public static void validate(long array, int count) {
for (int i = 0; i < count; i++) {
validate(array + i * SIZEOF);
}
}
// -----------------------------------
/** An array of {@link VkInstanceCreateInfo} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
/**
* Creates a new {@link VkInstanceCreateInfo.Buffer} instance backed by the specified container.
*
* Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values
* will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided
* by {@link VkInstanceCreateInfo#SIZEOF}, and its mark will be undefined.
*
* The created buffer instance holds a strong reference to the container object.
*/
public Buffer(ByteBuffer container) {
super(container, container.remaining() / SIZEOF);
}
public Buffer(long address, int cap) {
super(address, null, -1, 0, cap, cap);
}
Buffer(long address, @Nullable ByteBuffer container, int mark, int pos, int lim, int cap) {
super(address, container, mark, pos, lim, cap);
}
@Override
protected Buffer self() {
return this;
}
@Override
protected Buffer newBufferInstance(long address, @Nullable ByteBuffer container, int mark, int pos, int lim, int cap) {
return new Buffer(address, container, mark, pos, lim, cap);
}
@Override
protected VkInstanceCreateInfo newInstance(long address) {
return new VkInstanceCreateInfo(address, container);
}
@Override
public int sizeof() {
return SIZEOF;
}
/** Returns the value of the {@code sType} field. */
@NativeType("VkStructureType")
public int sType() { return VkInstanceCreateInfo.nsType(address()); }
/** Returns the value of the {@code pNext} field. */
@NativeType("const void *")
public long pNext() { return VkInstanceCreateInfo.npNext(address()); }
/** Returns the value of the {@code flags} field. */
@NativeType("VkInstanceCreateFlags")
public int flags() { return VkInstanceCreateInfo.nflags(address()); }
/** Returns a {@link VkApplicationInfo} view of the struct pointed to by the {@code pApplicationInfo} field. */
@Nullable
@NativeType("const VkApplicationInfo *")
public VkApplicationInfo pApplicationInfo() { return VkInstanceCreateInfo.npApplicationInfo(address()); }
/** Returns the value of the {@code enabledLayerCount} field. */
@NativeType("uint32_t")
public int enabledLayerCount() { return VkInstanceCreateInfo.nenabledLayerCount(address()); }
/** Returns a {@link PointerBuffer} view of the data pointed to by the {@code ppEnabledLayerNames} field. */
@Nullable
@NativeType("const char * const *")
public PointerBuffer ppEnabledLayerNames() { return VkInstanceCreateInfo.nppEnabledLayerNames(address()); }
/** Returns the value of the {@code enabledExtensionCount} field. */
@NativeType("uint32_t")
public int enabledExtensionCount() { return VkInstanceCreateInfo.nenabledExtensionCount(address()); }
/** Returns a {@link PointerBuffer} view of the data pointed to by the {@code ppEnabledExtensionNames} field. */
@Nullable
@NativeType("const char * const *")
public PointerBuffer ppEnabledExtensionNames() { return VkInstanceCreateInfo.nppEnabledExtensionNames(address()); }
/** Sets the specified value to the {@code sType} field. */
public VkInstanceCreateInfo.Buffer sType(@NativeType("VkStructureType") int value) { VkInstanceCreateInfo.nsType(address(), value); return this; }
/** Sets the specified value to the {@code pNext} field. */
public VkInstanceCreateInfo.Buffer pNext(@NativeType("const void *") long value) { VkInstanceCreateInfo.npNext(address(), value); return this; }
/** Sets the specified value to the {@code flags} field. */
public VkInstanceCreateInfo.Buffer flags(@NativeType("VkInstanceCreateFlags") int value) { VkInstanceCreateInfo.nflags(address(), value); return this; }
/** Sets the address of the specified {@link VkApplicationInfo} to the {@code pApplicationInfo} field. */
public VkInstanceCreateInfo.Buffer pApplicationInfo(@Nullable @NativeType("const VkApplicationInfo *") VkApplicationInfo value) { VkInstanceCreateInfo.npApplicationInfo(address(), value); return this; }
/** Sets the address of the specified {@link PointerBuffer} to the {@code ppEnabledLayerNames} field. */
public VkInstanceCreateInfo.Buffer ppEnabledLayerNames(@Nullable @NativeType("const char * const *") PointerBuffer value) { VkInstanceCreateInfo.nppEnabledLayerNames(address(), value); return this; }
/** Sets the address of the specified {@link PointerBuffer} to the {@code ppEnabledExtensionNames} field. */
public VkInstanceCreateInfo.Buffer ppEnabledExtensionNames(@Nullable @NativeType("const char * const *") PointerBuffer value) { VkInstanceCreateInfo.nppEnabledExtensionNames(address(), value); return this; }
}
}