Class VkBindSparseInfo

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

    public class VkBindSparseInfo
    extends Struct
    implements NativeResource
    Structure specifying a sparse binding operation.
    Valid Usage (Implicit)
    • sType must be STRUCTURE_TYPE_BIND_SPARSE_INFO
    • pNext must be NULL or a pointer to a valid instance of VkDeviceGroupBindSparseInfo
    • If waitSemaphoreCount is not 0, pWaitSemaphores must be a valid pointer to an array of waitSemaphoreCount valid VkSemaphore handles
    • If bufferBindCount is not 0, pBufferBinds must be a valid pointer to an array of bufferBindCount valid VkSparseBufferMemoryBindInfo structures
    • If imageOpaqueBindCount is not 0, pImageOpaqueBinds must be a valid pointer to an array of imageOpaqueBindCount valid VkSparseImageOpaqueMemoryBindInfo structures
    • If imageBindCount is not 0, pImageBinds must be a valid pointer to an array of imageBindCount valid VkSparseImageMemoryBindInfo structures
    • If signalSemaphoreCount is not 0, pSignalSemaphores must be a valid pointer to an array of signalSemaphoreCount valid VkSemaphore handles
    • Both of the elements of pSignalSemaphores, and the elements of pWaitSemaphores that are valid handles must have been created, allocated, or retrieved from the same VkDevice
    See Also

    VkSparseBufferMemoryBindInfo, VkSparseImageMemoryBindInfo, VkSparseImageOpaqueMemoryBindInfo, QueueBindSparse

    Member documentation

    • sType – the type of this structure.
    • pNextNULL or a pointer to an extension-specific structure.
    • 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 on before the sparse binding operations for this batch begin execution. If semaphores to wait on are provided, they define a semaphore wait operation.
    • bufferBindCount – the number of sparse buffer bindings to perform in the batch.
    • pBufferBinds – a pointer to an array of VkSparseBufferMemoryBindInfo structures.
    • imageOpaqueBindCount – the number of opaque sparse image bindings to perform.
    • pImageOpaqueBinds – a pointer to an array of VkSparseImageOpaqueMemoryBindInfo structures, indicating opaque sparse image bindings to perform.
    • imageBindCount – the number of sparse image bindings to perform.
    • pImageBinds – a pointer to 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. If semaphores to be signaled are provided, they define a semaphore signal operation.

    Layout

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

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • STYPE, PNEXT, WAITSEMAPHORECOUNT, PWAITSEMAPHORES, BUFFERBINDCOUNT, PBUFFERBINDS, IMAGEOPAQUEBINDCOUNT, PIMAGEOPAQUEBINDS, IMAGEBINDCOUNT, PIMAGEBINDS, SIGNALSEMAPHORECOUNT, PSIGNALSEMAPHORES

        The struct member offsets.
    • Constructor Detail

      • VkBindSparseInfo

        public VkBindSparseInfo​(java.nio.ByteBuffer container)
        Creates a VkBindSparseInfo 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.