org.lwjgl.vulkan.VkSubmitInfo 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 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 a queue submit operation.
*
* Description
*
* The order that command buffers appear in {@code pCommandBuffers} is used to determine submission order, and thus all the implicit ordering guarantees that respect it. Other than these implicit ordering guarantees and any explicit synchronization primitives, these command buffers may overlap or otherwise execute out of order.
*
* Valid Usage
*
*
* - Any given element of {@code pCommandBuffers} must not have been allocated with {@link VK10#VK_COMMAND_BUFFER_LEVEL_SECONDARY COMMAND_BUFFER_LEVEL_SECONDARY}
* - If the geometry shaders feature is not enabled, any given element of {@code pWaitDstStageMask} must not contain {@link VK10#VK_PIPELINE_STAGE_GEOMETRY_SHADER_BIT PIPELINE_STAGE_GEOMETRY_SHADER_BIT}
* - If the tessellation shaders feature is not enabled, any given element of {@code pWaitDstStageMask} must not contain {@link VK10#VK_PIPELINE_STAGE_TESSELLATION_CONTROL_SHADER_BIT PIPELINE_STAGE_TESSELLATION_CONTROL_SHADER_BIT} or {@link VK10#VK_PIPELINE_STAGE_TESSELLATION_EVALUATION_SHADER_BIT PIPELINE_STAGE_TESSELLATION_EVALUATION_SHADER_BIT}
* - Any given element of {@code pWaitDstStageMask} must not include {@link VK10#VK_PIPELINE_STAGE_HOST_BIT PIPELINE_STAGE_HOST_BIT}.
*
*
* Valid Usage (Implicit)
*
*
* - {@code sType} must be {@link VK10#VK_STRUCTURE_TYPE_SUBMIT_INFO STRUCTURE_TYPE_SUBMIT_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 VkD3D12FenceSubmitInfoKHR}, {@link VkDeviceGroupSubmitInfoKHX}, {@link VkWin32KeyedMutexAcquireReleaseInfoKHR}, or {@link VkWin32KeyedMutexAcquireReleaseInfoNV}
* - Each {@code sType} member in the {@code pNext} chain must be unique
* - If {@code waitSemaphoreCount} is not 0, {@code pWaitSemaphores} must be a pointer to an array of {@code waitSemaphoreCount} valid {@code VkSemaphore} handles
* - If {@code waitSemaphoreCount} is not 0, {@code pWaitDstStageMask} must be a pointer to an array of {@code waitSemaphoreCount} valid combinations of {@code VkPipelineStageFlagBits} values
* - Each element of {@code pWaitDstStageMask} must not be 0
* - If {@code commandBufferCount} is not 0, {@code pCommandBuffers} must be a pointer to an array of {@code commandBufferCount} valid {@code VkCommandBuffer} handles
* - If {@code signalSemaphoreCount} is not 0, {@code pSignalSemaphores} must be a pointer to an array of {@code signalSemaphoreCount} valid {@code VkSemaphore} handles
* - Each of the elements of {@code pCommandBuffers}, the elements of {@code pSignalSemaphores}, and the elements of {@code pWaitSemaphores} that are valid handles must have been created, allocated, or retrieved from the same {@code VkDevice}
*
*
* See Also
*
* {@link VK10#vkQueueSubmit QueueSubmit}
*
* Member documentation
*
*
* - {@code sType} – the type of this structure.
* - {@code pNext} – {@code NULL} or a pointer to an extension-specific structure.
* - {@code waitSemaphoreCount} – the number of semaphores upon which to wait before executing the command buffers for the batch.
* - {@code pWaitSemaphores} – a pointer to an array of semaphores upon which to wait before the command buffers for this batch begin execution. If semaphores to wait on are provided, they define a semaphore wait operation.
* - {@code pWaitDstStageMask} – a pointer to an array of pipeline stages at which each corresponding semaphore wait will occur.
* - {@code commandBufferCount} – the number of command buffers to execute in the batch.
* - {@code pCommandBuffers} – a pointer to an array of command buffers to execute in the batch.
* - {@code signalSemaphoreCount} – the number of semaphores to be signaled once the commands specified in {@code pCommandBuffers} have completed execution.
* - {@code pSignalSemaphores} – a pointer to an array of semaphores which will be signaled when the command buffers for this batch have completed execution. If semaphores to be signaled are provided, they define a semaphore signal operation.
*
*
* Layout
*
*
* struct VkSubmitInfo {
* VkStructureType sType;
* const void * pNext;
* uint32_t waitSemaphoreCount;
* const VkSemaphore * pWaitSemaphores;
* const VkPipelineStageFlags * pWaitDstStageMask;
* uint32_t commandBufferCount;
* const VkCommandBuffer * pCommandBuffers;
* uint32_t signalSemaphoreCount;
* const VkSemaphore * pSignalSemaphores;
* }The created instance holds a strong reference to the container object.
*/
public VkSubmitInfo(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 waitSemaphoreCount} field. */
@NativeType("uint32_t")
public int waitSemaphoreCount() { return nwaitSemaphoreCount(address()); }
/** Returns a {@link LongBuffer} view of the data pointed to by the {@code pWaitSemaphores} field. */
@NativeType("const VkSemaphore *")
public LongBuffer pWaitSemaphores() { return npWaitSemaphores(address()); }
/** Returns a {@link IntBuffer} view of the data pointed to by the {@code pWaitDstStageMask} field. */
@NativeType("const VkPipelineStageFlags *")
public IntBuffer pWaitDstStageMask() { return npWaitDstStageMask(address()); }
/** Returns the value of the {@code commandBufferCount} field. */
@NativeType("uint32_t")
public int commandBufferCount() { return ncommandBufferCount(address()); }
/** Returns a {@link PointerBuffer} view of the data pointed to by the {@code pCommandBuffers} field. */
@NativeType("const VkCommandBuffer *")
public PointerBuffer pCommandBuffers() { return npCommandBuffers(address()); }
/** Returns the value of the {@code signalSemaphoreCount} field. */
@NativeType("uint32_t")
public int signalSemaphoreCount() { return nsignalSemaphoreCount(address()); }
/** Returns a {@link LongBuffer} view of the data pointed to by the {@code pSignalSemaphores} field. */
@NativeType("const VkSemaphore *")
public LongBuffer pSignalSemaphores() { return npSignalSemaphores(address()); }
/** Sets the specified value to the {@code sType} field. */
public VkSubmitInfo sType(@NativeType("VkStructureType") int value) { nsType(address(), value); return this; }
/** Sets the specified value to the {@code pNext} field. */
public VkSubmitInfo pNext(@NativeType("const void *") long value) { npNext(address(), value); return this; }
/** Sets the specified value to the {@code waitSemaphoreCount} field. */
public VkSubmitInfo waitSemaphoreCount(@NativeType("uint32_t") int value) { nwaitSemaphoreCount(address(), value); return this; }
/** Sets the address of the specified {@link LongBuffer} to the {@code pWaitSemaphores} field. */
public VkSubmitInfo pWaitSemaphores(@NativeType("const VkSemaphore *") LongBuffer value) { npWaitSemaphores(address(), value); return this; }
/** Sets the address of the specified {@link IntBuffer} to the {@code pWaitDstStageMask} field. */
public VkSubmitInfo pWaitDstStageMask(@NativeType("const VkPipelineStageFlags *") IntBuffer value) { npWaitDstStageMask(address(), value); return this; }
/** Sets the address of the specified {@link PointerBuffer} to the {@code pCommandBuffers} field. */
public VkSubmitInfo pCommandBuffers(@NativeType("const VkCommandBuffer *") PointerBuffer value) { npCommandBuffers(address(), value); return this; }
/** Sets the address of the specified {@link LongBuffer} to the {@code pSignalSemaphores} field. */
public VkSubmitInfo pSignalSemaphores(@NativeType("const VkSemaphore *") LongBuffer value) { npSignalSemaphores(address(), value); return this; }
/** Initializes this struct with the specified values. */
public VkSubmitInfo set(
int sType,
long pNext,
int waitSemaphoreCount,
LongBuffer pWaitSemaphores,
IntBuffer pWaitDstStageMask,
PointerBuffer pCommandBuffers,
LongBuffer pSignalSemaphores
) {
sType(sType);
pNext(pNext);
waitSemaphoreCount(waitSemaphoreCount);
pWaitSemaphores(pWaitSemaphores);
pWaitDstStageMask(pWaitDstStageMask);
pCommandBuffers(pCommandBuffers);
pSignalSemaphores(pSignalSemaphores);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public VkSubmitInfo set(VkSubmitInfo src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@link VkSubmitInfo} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkSubmitInfo malloc() {
return create(nmemAlloc(SIZEOF));
}
/** Returns a new {@link VkSubmitInfo} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkSubmitInfo calloc() {
return create(nmemCalloc(1, SIZEOF));
}
/** Returns a new {@link VkSubmitInfo} instance allocated with {@link BufferUtils}. */
public static VkSubmitInfo create() {
return new VkSubmitInfo(BufferUtils.createByteBuffer(SIZEOF));
}
/** Returns a new {@link VkSubmitInfo} instance for the specified memory address or {@code null} if the address is {@code NULL}. */
public static VkSubmitInfo create(long address) {
return address == NULL ? null : new VkSubmitInfo(address, null);
}
/**
* Returns a new {@link VkSubmitInfo.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static Buffer malloc(int capacity) {
return create(__malloc(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkSubmitInfo.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static Buffer calloc(int capacity) {
return create(nmemCalloc(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkSubmitInfo.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static Buffer create(int capacity) {
return new Buffer(__create(capacity, SIZEOF));
}
/**
* Create a {@link VkSubmitInfo.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static Buffer create(long address, int capacity) {
return address == NULL ? null : new Buffer(address, null, -1, 0, capacity, capacity);
}
// -----------------------------------
/** Returns a new {@link VkSubmitInfo} instance allocated on the thread-local {@link MemoryStack}. */
public static VkSubmitInfo mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link VkSubmitInfo} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static VkSubmitInfo callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link VkSubmitInfo} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkSubmitInfo mallocStack(MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link VkSubmitInfo} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VkSubmitInfo callocStack(MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkSubmitInfo.Buffer} instance allocated on the thread-local {@link MemoryStack}.
*
* @param capacity the buffer capacity
*/
public static Buffer mallocStack(int capacity) {
return mallocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkSubmitInfo.Buffer} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero.
*
* @param capacity the buffer capacity
*/
public static Buffer callocStack(int capacity) {
return callocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkSubmitInfo.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static Buffer mallocStack(int capacity, MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link VkSubmitInfo.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 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 + VkSubmitInfo.STYPE); }
/** Unsafe version of {@link #pNext}. */
public static long npNext(long struct) { return memGetAddress(struct + VkSubmitInfo.PNEXT); }
/** Unsafe version of {@link #waitSemaphoreCount}. */
public static int nwaitSemaphoreCount(long struct) { return memGetInt(struct + VkSubmitInfo.WAITSEMAPHORECOUNT); }
/** Unsafe version of {@link #pWaitSemaphores() pWaitSemaphores}. */
public static LongBuffer npWaitSemaphores(long struct) { return memLongBuffer(memGetAddress(struct + VkSubmitInfo.PWAITSEMAPHORES), nwaitSemaphoreCount(struct)); }
/** Unsafe version of {@link #pWaitDstStageMask() pWaitDstStageMask}. */
public static IntBuffer npWaitDstStageMask(long struct) { return memIntBuffer(memGetAddress(struct + VkSubmitInfo.PWAITDSTSTAGEMASK), nwaitSemaphoreCount(struct)); }
/** Unsafe version of {@link #commandBufferCount}. */
public static int ncommandBufferCount(long struct) { return memGetInt(struct + VkSubmitInfo.COMMANDBUFFERCOUNT); }
/** Unsafe version of {@link #pCommandBuffers() pCommandBuffers}. */
public static PointerBuffer npCommandBuffers(long struct) { return memPointerBuffer(memGetAddress(struct + VkSubmitInfo.PCOMMANDBUFFERS), ncommandBufferCount(struct)); }
/** Unsafe version of {@link #signalSemaphoreCount}. */
public static int nsignalSemaphoreCount(long struct) { return memGetInt(struct + VkSubmitInfo.SIGNALSEMAPHORECOUNT); }
/** Unsafe version of {@link #pSignalSemaphores() pSignalSemaphores}. */
public static LongBuffer npSignalSemaphores(long struct) { return memLongBuffer(memGetAddress(struct + VkSubmitInfo.PSIGNALSEMAPHORES), nsignalSemaphoreCount(struct)); }
/** Unsafe version of {@link #sType(int) sType}. */
public static void nsType(long struct, int value) { memPutInt(struct + VkSubmitInfo.STYPE, value); }
/** Unsafe version of {@link #pNext(long) pNext}. */
public static void npNext(long struct, long value) { memPutAddress(struct + VkSubmitInfo.PNEXT, value); }
/** Sets the specified value to the {@code waitSemaphoreCount} field of the specified {@code struct}. */
public static void nwaitSemaphoreCount(long struct, int value) { memPutInt(struct + VkSubmitInfo.WAITSEMAPHORECOUNT, value); }
/** Unsafe version of {@link #pWaitSemaphores(LongBuffer) pWaitSemaphores}. */
public static void npWaitSemaphores(long struct, LongBuffer value) { memPutAddress(struct + VkSubmitInfo.PWAITSEMAPHORES, memAddressSafe(value)); }
/** Unsafe version of {@link #pWaitDstStageMask(IntBuffer) pWaitDstStageMask}. */
public static void npWaitDstStageMask(long struct, IntBuffer value) { memPutAddress(struct + VkSubmitInfo.PWAITDSTSTAGEMASK, memAddressSafe(value)); }
/** Sets the specified value to the {@code commandBufferCount} field of the specified {@code struct}. */
public static void ncommandBufferCount(long struct, int value) { memPutInt(struct + VkSubmitInfo.COMMANDBUFFERCOUNT, value); }
/** Unsafe version of {@link #pCommandBuffers(PointerBuffer) pCommandBuffers}. */
public static void npCommandBuffers(long struct, PointerBuffer value) { memPutAddress(struct + VkSubmitInfo.PCOMMANDBUFFERS, memAddressSafe(value)); ncommandBufferCount(struct, value == null ? 0 : value.remaining()); }
/** Sets the specified value to the {@code signalSemaphoreCount} field of the specified {@code struct}. */
public static void nsignalSemaphoreCount(long struct, int value) { memPutInt(struct + VkSubmitInfo.SIGNALSEMAPHORECOUNT, value); }
/** Unsafe version of {@link #pSignalSemaphores(LongBuffer) pSignalSemaphores}. */
public static void npSignalSemaphores(long struct, LongBuffer value) { memPutAddress(struct + VkSubmitInfo.PSIGNALSEMAPHORES, memAddressSafe(value)); nsignalSemaphoreCount(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 (nwaitSemaphoreCount(struct) != 0) {
check(memGetAddress(struct + VkSubmitInfo.PWAITSEMAPHORES));
check(memGetAddress(struct + VkSubmitInfo.PWAITDSTSTAGEMASK));
}
if (ncommandBufferCount(struct) != 0) {
check(memGetAddress(struct + VkSubmitInfo.PCOMMANDBUFFERS));
}
if (nsignalSemaphoreCount(struct) != 0) {
check(memGetAddress(struct + VkSubmitInfo.PSIGNALSEMAPHORES));
}
}
/**
* 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 VkSubmitInfo} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
/**
* Creates a new {@link VkSubmitInfo.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 VkSubmitInfo#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);
}
Buffer(long address, 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, ByteBuffer container, int mark, int pos, int lim, int cap) {
return new Buffer(address, container, mark, pos, lim, cap);
}
@Override
protected VkSubmitInfo newInstance(long address) {
return new VkSubmitInfo(address, container);
}
@Override
public int sizeof() {
return SIZEOF;
}
/** Returns the value of the {@code sType} field. */
@NativeType("VkStructureType")
public int sType() { return VkSubmitInfo.nsType(address()); }
/** Returns the value of the {@code pNext} field. */
@NativeType("const void *")
public long pNext() { return VkSubmitInfo.npNext(address()); }
/** Returns the value of the {@code waitSemaphoreCount} field. */
@NativeType("uint32_t")
public int waitSemaphoreCount() { return VkSubmitInfo.nwaitSemaphoreCount(address()); }
/** Returns a {@link LongBuffer} view of the data pointed to by the {@code pWaitSemaphores} field. */
@NativeType("const VkSemaphore *")
public LongBuffer pWaitSemaphores() { return VkSubmitInfo.npWaitSemaphores(address()); }
/** Returns a {@link IntBuffer} view of the data pointed to by the {@code pWaitDstStageMask} field. */
@NativeType("const VkPipelineStageFlags *")
public IntBuffer pWaitDstStageMask() { return VkSubmitInfo.npWaitDstStageMask(address()); }
/** Returns the value of the {@code commandBufferCount} field. */
@NativeType("uint32_t")
public int commandBufferCount() { return VkSubmitInfo.ncommandBufferCount(address()); }
/** Returns a {@link PointerBuffer} view of the data pointed to by the {@code pCommandBuffers} field. */
@NativeType("const VkCommandBuffer *")
public PointerBuffer pCommandBuffers() { return VkSubmitInfo.npCommandBuffers(address()); }
/** Returns the value of the {@code signalSemaphoreCount} field. */
@NativeType("uint32_t")
public int signalSemaphoreCount() { return VkSubmitInfo.nsignalSemaphoreCount(address()); }
/** Returns a {@link LongBuffer} view of the data pointed to by the {@code pSignalSemaphores} field. */
@NativeType("const VkSemaphore *")
public LongBuffer pSignalSemaphores() { return VkSubmitInfo.npSignalSemaphores(address()); }
/** Sets the specified value to the {@code sType} field. */
public VkSubmitInfo.Buffer sType(@NativeType("VkStructureType") int value) { VkSubmitInfo.nsType(address(), value); return this; }
/** Sets the specified value to the {@code pNext} field. */
public VkSubmitInfo.Buffer pNext(@NativeType("const void *") long value) { VkSubmitInfo.npNext(address(), value); return this; }
/** Sets the specified value to the {@code waitSemaphoreCount} field. */
public VkSubmitInfo.Buffer waitSemaphoreCount(@NativeType("uint32_t") int value) { VkSubmitInfo.nwaitSemaphoreCount(address(), value); return this; }
/** Sets the address of the specified {@link LongBuffer} to the {@code pWaitSemaphores} field. */
public VkSubmitInfo.Buffer pWaitSemaphores(@NativeType("const VkSemaphore *") LongBuffer value) { VkSubmitInfo.npWaitSemaphores(address(), value); return this; }
/** Sets the address of the specified {@link IntBuffer} to the {@code pWaitDstStageMask} field. */
public VkSubmitInfo.Buffer pWaitDstStageMask(@NativeType("const VkPipelineStageFlags *") IntBuffer value) { VkSubmitInfo.npWaitDstStageMask(address(), value); return this; }
/** Sets the address of the specified {@link PointerBuffer} to the {@code pCommandBuffers} field. */
public VkSubmitInfo.Buffer pCommandBuffers(@NativeType("const VkCommandBuffer *") PointerBuffer value) { VkSubmitInfo.npCommandBuffers(address(), value); return this; }
/** Sets the address of the specified {@link LongBuffer} to the {@code pSignalSemaphores} field. */
public VkSubmitInfo.Buffer pSignalSemaphores(@NativeType("const VkSemaphore *") LongBuffer value) { VkSubmitInfo.npSignalSemaphores(address(), value); return this; }
}
}