Package org.lwjgl.vulkan

Class VkSparseMemoryBind

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

    public class VkSparseMemoryBind
extends Struct
    Khronos Reference Page
    Vulkan Specification

    Describes a sparse memory binding.

    Valid Usage
    • If memory is not NULL_HANDLE, memory must be a valid VkDeviceMemory handle
    • flags must be a valid combination of VkSparseMemoryBindFlagBits values
    • If memory is not NULL_HANDLE, memory and memoryOffset must match the memory requirements of the resource
    • If memory is not NULL_HANDLE, memory must not have been created with a memory type that reports MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT bit set
    • size must be greater than 0
    • resourceOffset must be less than the size of the resource
    • size must be less than or equal to the size of the resource minus resourceOffset
    • memoryOffset must be less than the size of memory
    • size must be less than or equal to the size of memory minus memoryOffset

    Member documentation

    • resourceOffset – the offset into the resource
    • size – the size of the memory region to be bound
    • memory – the VkDeviceMemory object that the range of the resource is bound to
    • memoryOffset – the offset into the VkDeviceMemory object to bind the resource range to
    • flags – are sparse memory binding flags. One or more of:
      SPARSE_MEMORY_BIND_METADATA_BIT

    Layout

    struct VkSparseMemoryBind {
    VkDeviceSize resourceOffset;
    VkDeviceSize size;
    VkDeviceMemory memory;
    VkDeviceSize memoryOffset;
    VkSparseMemoryBindFlags flags;
}