Record Class VkBindSparseInfo

java.lang.Object
java.lang.Record
club.doki7.vulkan.datatype.VkBindSparseInfo
All Implemented Interfaces:
IPointer, IVkBindSparseInfo
@ValueBasedCandidate @UnsafeConstructor public record VkBindSparseInfo(@NotNull MemorySegment segment) extends Record implements IVkBindSparseInfo

Represents a pointer to a VkBindSparseInfo structure in native memory.

Structure

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

Auto initialization

This structure has the following members that can be automatically initialized:

  • sType = VK_STRUCTURE_TYPE_BIND_SPARSE_INFO

The allocate (allocate(Arena), allocate(Arena, long)) functions will automatically initialize these fields. Also, you may call autoInit() to initialize these fields manually for non-allocated instances.

Contracts

The property segment() should always be not-null (segment != NULL && !segment.equals(MemorySegment.NULL)), and properly aligned to LAYOUT.byteAlignment() bytes. To represent null pointer, you may use a Java null instead. See the documentation of IPointer.segment() for more details.

The constructor of this class is marked as UnsafeConstructor, because it does not perform any runtime check. The constructor can be useful for automatic code generators.

See Also: