Record Class VkDisplaySurfaceCreateInfoKHR

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

Represents a pointer to a VkDisplaySurfaceCreateInfoKHR structure in native memory.

Structure

typedef struct VkDisplaySurfaceCreateInfoKHR {
    VkStructureType sType;
    void const* pNext; // optional
    VkDisplaySurfaceCreateFlagsKHR flags; // optional
    VkDisplayModeKHR displayMode;
    uint32_t planeIndex;
    uint32_t planeStackIndex;
    VkSurfaceTransformFlagsKHR transform;
    float globalAlpha;
    VkDisplayPlaneAlphaFlagsKHR alphaMode;
    VkExtent2D imageExtent;
} VkDisplaySurfaceCreateInfoKHR;

Auto initialization

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

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