Class VkHdrMetadataEXT

  • All Implemented Interfaces:
    java.lang.AutoCloseable, NativeResource, Pointer

    public class VkHdrMetadataEXT
    extends Struct
    implements NativeResource
    structure to specify Hdr metadata.

    The validity and use of this data is outside the scope of Vulkan and thus no +Valid Usage+ is given.

    See Also

    VkXYColorEXT, SetHdrMetadataEXT

    Member documentation

    • sType – the type of this structure.
    • pNextNULL or a pointer to an extension-specific structure.
    • displayPrimaryRed – the mastering display’s red primary in chromaticity coordinates
    • displayPrimaryGreen – the mastering display’s green primary in chromaticity coordinates
    • displayPrimaryBlue – the mastering display’s blue primary in chromaticity coordinates
    • whitePoint – the mastering display’s white-point in chromaticity coordinates
    • maxLuminance – the maximum luminance of the mastering display in nits
    • minLuminance – the minimum luminance of the mastering display in nits
    • maxContentLightLevel – content’s maximum luminance in nits
    • maxFrameAverageLightLevel – the maximum frame average light level in nits


     struct VkHdrMetadataEXT {
         VkStructureType sType;
         void const * pNext;
         VkXYColorEXT displayPrimaryRed;
         VkXYColorEXT displayPrimaryGreen;
         VkXYColorEXT displayPrimaryBlue;
         VkXYColorEXT whitePoint;
         float maxLuminance;
         float minLuminance;
         float maxContentLightLevel;
         float maxFrameAverageLightLevel;
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.

        The struct member offsets.
    • Constructor Detail

      • VkHdrMetadataEXT

        public VkHdrMetadataEXT​(java.nio.ByteBuffer container)
        Creates a VkHdrMetadataEXT instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.

        The created instance holds a strong reference to the container object.

    • Method Detail

      • sizeof

        public int sizeof()
        Description copied from class: Struct
        Returns sizeof(struct).
        Specified by:
        sizeof in class Struct
      • sType

        public int sType()
        Returns the value of the sType field.
      • pNext

        public long pNext()
        Returns the value of the pNext field.
      • displayPrimaryRed

        public VkXYColorEXT displayPrimaryRed()
        Returns a VkXYColorEXT view of the displayPrimaryRed field.
      • displayPrimaryRed

        public VkHdrMetadataEXT displayPrimaryRed​(java.util.function.Consumer<VkXYColorEXT> consumer)
        Passes the displayPrimaryRed field to the specified Consumer.
      • displayPrimaryGreen

        public VkXYColorEXT displayPrimaryGreen()
        Returns a VkXYColorEXT view of the displayPrimaryGreen field.
      • displayPrimaryGreen

        public VkHdrMetadataEXT displayPrimaryGreen​(java.util.function.Consumer<VkXYColorEXT> consumer)
        Passes the displayPrimaryGreen field to the specified Consumer.
      • displayPrimaryBlue

        public VkXYColorEXT displayPrimaryBlue()
        Returns a VkXYColorEXT view of the displayPrimaryBlue field.
      • displayPrimaryBlue

        public VkHdrMetadataEXT displayPrimaryBlue​(java.util.function.Consumer<VkXYColorEXT> consumer)
        Passes the displayPrimaryBlue field to the specified Consumer.
      • whitePoint

        public VkHdrMetadataEXT whitePoint​(java.util.function.Consumer<VkXYColorEXT> consumer)
        Passes the whitePoint field to the specified Consumer.
      • maxLuminance

        public float maxLuminance()
        Returns the value of the maxLuminance field.
      • minLuminance

        public float minLuminance()
        Returns the value of the minLuminance field.
      • maxContentLightLevel

        public float maxContentLightLevel()
        Returns the value of the maxContentLightLevel field.
      • maxFrameAverageLightLevel

        public float maxFrameAverageLightLevel()
        Returns the value of the maxFrameAverageLightLevel field.
      • sType

        public VkHdrMetadataEXT sType​(int value)
        Sets the specified value to the sType field.
      • pNext

        public VkHdrMetadataEXT pNext​(long value)
        Sets the specified value to the pNext field.
      • maxLuminance

        public VkHdrMetadataEXT maxLuminance​(float value)
        Sets the specified value to the maxLuminance field.
      • minLuminance

        public VkHdrMetadataEXT minLuminance​(float value)
        Sets the specified value to the minLuminance field.
      • maxContentLightLevel

        public VkHdrMetadataEXT maxContentLightLevel​(float value)
        Sets the specified value to the maxContentLightLevel field.
      • maxFrameAverageLightLevel

        public VkHdrMetadataEXT maxFrameAverageLightLevel​(float value)
        Sets the specified value to the maxFrameAverageLightLevel field.
      • set

        public VkHdrMetadataEXT set​(int sType,
                                    long pNext,
                                    VkXYColorEXT displayPrimaryRed,
                                    VkXYColorEXT displayPrimaryGreen,
                                    VkXYColorEXT displayPrimaryBlue,
                                    VkXYColorEXT whitePoint,
                                    float maxLuminance,
                                    float minLuminance,
                                    float maxContentLightLevel,
                                    float maxFrameAverageLightLevel)
        Initializes this struct with the specified values.
      • set

        public VkHdrMetadataEXT set​(VkHdrMetadataEXT src)
        Copies the specified struct data to this struct.
        src - the source struct
        this struct
      • createSafe

        public static VkHdrMetadataEXT createSafe​(long address)
        Like create, but returns null if address is NULL.
      • createSafe

        public static VkHdrMetadataEXT.Buffer createSafe​(long address,
                                                         int capacity)
        Like create, but returns null if address is NULL.
      • nsType

        public static int nsType​(long struct)
        Unsafe version of sType().
      • npNext

        public static long npNext​(long struct)
        Unsafe version of pNext().
      • nmaxLuminance

        public static float nmaxLuminance​(long struct)
        Unsafe version of maxLuminance().
      • nminLuminance

        public static float nminLuminance​(long struct)
        Unsafe version of minLuminance().
      • nmaxContentLightLevel

        public static float nmaxContentLightLevel​(long struct)
        Unsafe version of maxContentLightLevel().
      • nmaxFrameAverageLightLevel

        public static float nmaxFrameAverageLightLevel​(long struct)
        Unsafe version of maxFrameAverageLightLevel().
      • nsType

        public static void nsType​(long struct,
                                  int value)
        Unsafe version of sType.
      • npNext

        public static void npNext​(long struct,
                                  long value)
        Unsafe version of pNext.
      • nwhitePoint

        public static void nwhitePoint​(long struct,
                                       VkXYColorEXT value)
        Unsafe version of whitePoint.
      • nmaxLuminance

        public static void nmaxLuminance​(long struct,
                                         float value)
        Unsafe version of maxLuminance.
      • nminLuminance

        public static void nminLuminance​(long struct,
                                         float value)
        Unsafe version of minLuminance.
      • nmaxContentLightLevel

        public static void nmaxContentLightLevel​(long struct,
                                                 float value)
        Unsafe version of maxContentLightLevel.
      • nmaxFrameAverageLightLevel

        public static void nmaxFrameAverageLightLevel​(long struct,
                                                      float value)
        Unsafe version of maxFrameAverageLightLevel.