Record Class VkSwapchainCreateInfoKHR

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

Represents a pointer to a VkSwapchainCreateInfoKHR structure in native memory.

Structure

typedef struct VkSwapchainCreateInfoKHR {
    VkStructureType sType;
    void const* pNext; // optional
    VkSwapchainCreateFlagsKHR flags; // optional
    VkSurfaceKHR surface;
    uint32_t minImageCount;
    VkFormat imageFormat;
    VkColorSpaceKHR imageColorSpace;
    VkExtent2D imageExtent;
    uint32_t imageArrayLayers;
    VkImageUsageFlags imageUsage;
    VkSharingMode imageSharingMode;
    uint32_t queueFamilyIndexCount; // optional
    uint32_t const* pQueueFamilyIndices; // optional
    VkSurfaceTransformFlagsKHR preTransform;
    VkCompositeAlphaFlagsKHR compositeAlpha;
    VkPresentModeKHR presentMode;
    VkBool32 clipped;
    VkSwapchainKHR oldSwapchain; // optional
} VkSwapchainCreateInfoKHR;

Auto initialization

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

  • sType = VK_STRUCTURE_TYPE_SWAPCHAIN_CREATE_INFO_KHR

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: