Package org.lwjgl.vulkan

Class VkBindSparseInfo

  • All Implemented Interfaces:
    java.lang.AutoCloseable, NativeResource, Pointer

    public class VkBindSparseInfo
extends Struct
    Khronos Reference Page
    Vulkan Specification

    Describes a set of sparse binding operations.

    Valid Usage
    • sType must be STRUCTURE_TYPE_BIND_SPARSE_INFO
    • pNext must be NULL
    • If waitSemaphoreCount is not 0, pWaitSemaphores must be a pointer to an array of waitSemaphoreCount valid VkSemaphore handles
    • If bufferBindCount is not 0, pBufferBinds must be a pointer to an array of bufferBindCount valid VkSparseBufferMemoryBindInfo structures
    • If imageOpaqueBindCount is not 0, pImageOpaqueBinds must be a pointer to an array of imageOpaqueBindCount valid VkSparseImageOpaqueMemoryBindInfo structures
    • If imageBindCount is not 0, pImageBinds must be a pointer to an array of imageBindCount valid VkSparseImageMemoryBindInfo structures
    • If signalSemaphoreCount is not 0, pSignalSemaphores must be a pointer to an array of signalSemaphoreCount valid VkSemaphore handles
    • Each of the elements of pWaitSemaphores and the elements of pSignalSemaphores that are valid handles must have been created, allocated or retrieved from the same VkDevice

    Member documentation

    • sType – the type of this structure. Must be: STRUCTURE_TYPE_BIND_SPARSE_INFO
    • pNext – reserved for use by extensions
    • waitSemaphoreCount – the number of semaphores upon which to wait before executing the sparse binding operations for the batch
    • pWaitSemaphores – a pointer to an array of semaphores upon which to wait before executing the sparse binding operations in the batch
    • bufferBindCount – the number of sparse buffer bindings to perform
    • pBufferBinds – an array of VkSparseBufferMemoryBindInfo structures, indicating sparse buffer bindings to perform
    • imageOpaqueBindCount – the number of opaque sparse image bindings to perform
    • pImageOpaqueBinds – an array of VkSparseImageOpaqueMemoryBindInfo structures, indicating opaque sparse image bindings to perform
    • imageBindCount – the number of sparse image bindings to perform
    • pImageBinds – an array of VkSparseImageMemoryBindInfo structures, indicating sparse image bindings to perform
    • signalSemaphoreCount – the number of semaphores to be signaled once the sparse binding operations specified by the structure have completed execution
    • pSignalSemaphores – a pointer to an array of semaphores which will be signaled when the sparse binding operations for this batch have completed execution

    Layout

    struct VkBindSparseInfo {
    VkStructureType sType;
    const void * pNext;
    uint32_t waitSemaphoreCount;
    const VkSemaphore * pWaitSemaphores;
    uint32_t bufferBindCount;
    const VkSparseBufferMemoryBindInfo * pBufferBinds;
    uint32_t imageOpaqueBindCount;
    const VkSparseImageOpaqueMemoryBindInfo * pImageOpaqueBinds;
    uint32_t imageBindCount;
    const VkSparseImageMemoryBindInfo * pImageBinds;
    uint32_t signalSemaphoreCount;
    const VkSemaphore * pSignalSemaphores;
}