Record Class VkPhysicalDeviceSparseImageFormatInfo2

java.lang.Object
java.lang.Record
club.doki7.vulkan.datatype.VkPhysicalDeviceSparseImageFormatInfo2
All Implemented Interfaces:
IPointer, IVkPhysicalDeviceSparseImageFormatInfo2

@ValueBasedCandidate @UnsafeConstructor public record VkPhysicalDeviceSparseImageFormatInfo2(@NotNull MemorySegment segment) extends Record implements IVkPhysicalDeviceSparseImageFormatInfo2

Represents a pointer to a VkPhysicalDeviceSparseImageFormatInfo2 structure in native memory.

Structure

typedef struct VkPhysicalDeviceSparseImageFormatInfo2 {
    VkStructureType sType;
    void const* pNext; // optional
    VkFormat format;
    VkImageType type;
    VkSampleCountFlags samples;
    VkImageUsageFlags usage;
    VkImageTiling tiling;
} VkPhysicalDeviceSparseImageFormatInfo2;

Auto initialization

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

  • sType = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_SPARSE_IMAGE_FORMAT_INFO_2

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: