Record Class VkImageCreateInfo

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

Represents a pointer to a VkImageCreateInfo structure in native memory.

Structure

typedef struct VkImageCreateInfo {
    VkStructureType sType;
    void const* pNext; // optional
    VkImageCreateFlags flags; // optional
    VkImageType imageType;
    VkFormat format;
    VkExtent3D extent;
    uint32_t mipLevels;
    uint32_t arrayLayers;
    VkSampleCountFlags samples;
    VkImageTiling tiling;
    VkImageUsageFlags usage;
    VkSharingMode sharingMode;
    uint32_t queueFamilyIndexCount; // optional
    uint32_t const* pQueueFamilyIndices;
    VkImageLayout initialLayout;
} VkImageCreateInfo;

Auto initialization

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

  • sType = VK_STRUCTURE_TYPE_IMAGE_CREATE_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: