Class VideoColorimetry

java.lang.Object
org.javagi.base.ProxyInstance
org.freedesktop.gstreamer.video.VideoColorimetry
All Implemented Interfaces:
Proxy
@Generated("org.javagi.JavaGI") public class VideoColorimetry extends ProxyInstance
Structure describing the color info.

  • Constructor Details

    • VideoColorimetry

      public VideoColorimetry(MemorySegment address)
      Create a VideoColorimetry proxy instance for the provided memory address.
      Parameters:
      address - the memory address of the native object

    • VideoColorimetry

      public VideoColorimetry(Arena arena)
      Allocate a new VideoColorimetry.
      Parameters:
      arena - to control the memory allocation scope

    • VideoColorimetry

      public VideoColorimetry()
      Allocate a new VideoColorimetry. The memory is allocated with Arena.ofAuto().

    • VideoColorimetry

      public VideoColorimetry(VideoColorRange range, VideoColorMatrix matrix, VideoTransferFunction transfer, VideoColorPrimaries primaries, Arena arena)
      Allocate a new VideoColorimetry with the fields set to the provided values.
      Parameters:
      range - value for the field range
      matrix - value for the field matrix
      transfer - value for the field transfer
      primaries - value for the field primaries
      arena - to control the memory allocation scope

    • VideoColorimetry

      public VideoColorimetry(VideoColorRange range, VideoColorMatrix matrix, VideoTransferFunction transfer, VideoColorPrimaries primaries)
      Allocate a new VideoColorimetry with the fields set to the provided values. The memory is allocated with Arena.ofAuto().
      Parameters:
      range - value for the field range
      matrix - value for the field matrix
      transfer - value for the field transfer
      primaries - value for the field primaries

  • Method Details

    • getMemoryLayout

      public static MemoryLayout getMemoryLayout()
      The memory layout of the native struct.
      Returns:
      the memory layout

    • readRange

      public VideoColorRange readRange()
      Read the value of the field range.
      Returns:
      The value of the field range

    • writeRange

      public void writeRange(VideoColorRange range)
      Write a value in the field range.
      Parameters:
      range - The new value for the field range

    • readMatrix

      public VideoColorMatrix readMatrix()
      Read the value of the field matrix.
      Returns:
      The value of the field matrix

    • writeMatrix

      public void writeMatrix(VideoColorMatrix matrix)
      Write a value in the field matrix.
      Parameters:
      matrix - The new value for the field matrix

    • readTransfer

      public VideoTransferFunction readTransfer()
      Read the value of the field transfer.
      Returns:
      The value of the field transfer

    • writeTransfer

      public void writeTransfer(VideoTransferFunction transfer)
      Write a value in the field transfer.
      Parameters:
      transfer - The new value for the field transfer

    • readPrimaries

      public VideoColorPrimaries readPrimaries()
      Read the value of the field primaries.
      Returns:
      The value of the field primaries

    • writePrimaries

      public void writePrimaries(VideoColorPrimaries primaries)
      Write a value in the field primaries.
      Parameters:
      primaries - The new value for the field primaries

    • fromString

      public boolean fromString(String color)
      Parse the colorimetry string and update this VideoColorimetry with the parsed values.
      Parameters:
      color - a colorimetry string
      Returns:
      true if color points to valid colorimetry info.

    • isEqual

      public boolean isEqual(VideoColorimetry other)
      Compare the 2 colorimetry sets for equality
      Parameters:
      other - another GstVideoColorimetry
      Returns:
      true if this VideoColorimetry and other are equal.
      Since:
      1.6

    • isEquivalent

      public boolean isEquivalent(int bitdepth, VideoColorimetry other, int otherBitdepth)
      Compare the 2 colorimetry sets for functionally equality
      Parameters:
      bitdepth - bitdepth of a format associated with this VideoColorimetry
      other - another GstVideoColorimetry
      otherBitdepth - bitdepth of a format associated with other
      Returns:
      true if this VideoColorimetry and other are equivalent.
      Since:
      1.22

    • matches

      public boolean matches(String color)
      Check if the colorimetry information in info matches that of the string color.
      Parameters:
      color - a colorimetry string
      Returns:
      true if color conveys the same colorimetry info as the color information in info.

    • toString

      public @Nullable String toString()
      Make a string representation of cinfo.
      Overrides:
      toString in class Object
      Returns:
      a string representation of this VideoColorimetry or null if all the entries of this VideoColorimetry are unknown values.