Record Class VkVideoFormatPropertiesKHR

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

Represents a pointer to a VkVideoFormatPropertiesKHR structure in native memory.

Structure

typedef struct VkVideoFormatPropertiesKHR {
    VkStructureType sType;
    void* pNext; // optional
    VkFormat format;
    VkComponentMapping componentMapping;
    VkImageCreateFlags imageCreateFlags;
    VkImageType imageType;
    VkImageTiling imageTiling;
    VkImageUsageFlags imageUsageFlags;
} VkVideoFormatPropertiesKHR;

Auto initialization

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

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