Record Class VkHdrMetadataEXT

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

Represents a pointer to a VkHdrMetadataEXT structure in native memory.

Structure

typedef struct VkHdrMetadataEXT {
    VkStructureType sType;
    void const* pNext; // optional
    VkXYColorEXT displayPrimaryRed;
    VkXYColorEXT displayPrimaryGreen;
    VkXYColorEXT displayPrimaryBlue;
    VkXYColorEXT whitePoint;
    float maxLuminance;
    float minLuminance;
    float maxContentLightLevel;
    float maxFrameAverageLightLevel;
} VkHdrMetadataEXT;

Auto initialization

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

  • sType = VK_STRUCTURE_TYPE_HDR_METADATA_EXT

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:

  • Field Details

    • LAYOUT

      public static final StructLayout LAYOUT

    • BYTES

      public static final long BYTES

    • PATH$sType

      public static final MemoryLayout.PathElement PATH$sType

    • PATH$pNext

      public static final MemoryLayout.PathElement PATH$pNext

    • PATH$displayPrimaryRed

      public static final MemoryLayout.PathElement PATH$displayPrimaryRed

    • PATH$displayPrimaryGreen

      public static final MemoryLayout.PathElement PATH$displayPrimaryGreen

    • PATH$displayPrimaryBlue

      public static final MemoryLayout.PathElement PATH$displayPrimaryBlue

    • PATH$whitePoint

      public static final MemoryLayout.PathElement PATH$whitePoint

    • PATH$maxLuminance

      public static final MemoryLayout.PathElement PATH$maxLuminance

    • PATH$minLuminance

      public static final MemoryLayout.PathElement PATH$minLuminance

    • PATH$maxContentLightLevel

      public static final MemoryLayout.PathElement PATH$maxContentLightLevel

    • PATH$maxFrameAverageLightLevel

      public static final MemoryLayout.PathElement PATH$maxFrameAverageLightLevel

    • LAYOUT$sType

      public static final ValueLayout.OfInt LAYOUT$sType

    • LAYOUT$pNext

      public static final AddressLayout LAYOUT$pNext

    • LAYOUT$displayPrimaryRed

      public static final StructLayout LAYOUT$displayPrimaryRed

    • LAYOUT$displayPrimaryGreen

      public static final StructLayout LAYOUT$displayPrimaryGreen

    • LAYOUT$displayPrimaryBlue

      public static final StructLayout LAYOUT$displayPrimaryBlue

    • LAYOUT$whitePoint

      public static final StructLayout LAYOUT$whitePoint

    • LAYOUT$maxLuminance

      public static final ValueLayout.OfFloat LAYOUT$maxLuminance

    • LAYOUT$minLuminance

      public static final ValueLayout.OfFloat LAYOUT$minLuminance

    • LAYOUT$maxContentLightLevel

      public static final ValueLayout.OfFloat LAYOUT$maxContentLightLevel

    • LAYOUT$maxFrameAverageLightLevel

      public static final ValueLayout.OfFloat LAYOUT$maxFrameAverageLightLevel

    • SIZE$sType

      public static final long SIZE$sType

    • SIZE$pNext

      public static final long SIZE$pNext

    • SIZE$displayPrimaryRed

      public static final long SIZE$displayPrimaryRed

    • SIZE$displayPrimaryGreen

      public static final long SIZE$displayPrimaryGreen

    • SIZE$displayPrimaryBlue

      public static final long SIZE$displayPrimaryBlue

    • SIZE$whitePoint

      public static final long SIZE$whitePoint

    • SIZE$maxLuminance

      public static final long SIZE$maxLuminance

    • SIZE$minLuminance

      public static final long SIZE$minLuminance

    • SIZE$maxContentLightLevel

      public static final long SIZE$maxContentLightLevel

    • SIZE$maxFrameAverageLightLevel

      public static final long SIZE$maxFrameAverageLightLevel

    • OFFSET$sType

      public static final long OFFSET$sType

    • OFFSET$pNext

      public static final long OFFSET$pNext

    • OFFSET$displayPrimaryRed

      public static final long OFFSET$displayPrimaryRed

    • OFFSET$displayPrimaryGreen

      public static final long OFFSET$displayPrimaryGreen

    • OFFSET$displayPrimaryBlue

      public static final long OFFSET$displayPrimaryBlue

    • OFFSET$whitePoint

      public static final long OFFSET$whitePoint

    • OFFSET$maxLuminance

      public static final long OFFSET$maxLuminance

    • OFFSET$minLuminance

      public static final long OFFSET$minLuminance

    • OFFSET$maxContentLightLevel

      public static final long OFFSET$maxContentLightLevel

    • OFFSET$maxFrameAverageLightLevel

      public static final long OFFSET$maxFrameAverageLightLevel

  • Constructor Details

    • VkHdrMetadataEXT

      public VkHdrMetadataEXT(@NotNull @NotNull MemorySegment segment)
      Creates an instance of a VkHdrMetadataEXT record class.
      Parameters:
      segment - the value for the segment record component

  • Method Details