Record Class VkDisplayPlaneProperties2KHR

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

Represents a pointer to a VkDisplayPlaneProperties2KHR structure in native memory.

Structure

typedef struct VkDisplayPlaneProperties2KHR {
    VkStructureType sType;
    void* pNext; // optional
    VkDisplayPlanePropertiesKHR displayPlaneProperties;
} VkDisplayPlaneProperties2KHR;

Auto initialization

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

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