Class VideoFormatInfo

java.lang.Object
org.javagi.base.ProxyInstance
org.freedesktop.gstreamer.video.VideoFormatInfo
All Implemented Interfaces:
Proxy
@Generated("org.javagi.JavaGI") public class VideoFormatInfo extends ProxyInstance
Information for a video format.

  • Constructor Details

    • VideoFormatInfo

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

    • VideoFormatInfo

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

    • VideoFormatInfo

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

    • VideoFormatInfo

      public VideoFormatInfo(VideoFormat format, String name, String description, Set<VideoFormatFlags> flags, int bits, int nComponents, int[] shift, int[] depth, int[] pixelStride, int nPlanes, int[] plane, int[] poffset, int[] wSub, int[] hSub, VideoFormat unpackFormat, VideoFormatUnpack unpackFunc, int packLines, VideoFormatPack packFunc, VideoTileMode tileMode, int tileWs, int tileHs, VideoTileInfo[] tileInfo, Arena arena)
      Allocate a new VideoFormatInfo with the fields set to the provided values.
      Parameters:
      format - value for the field format
      name - value for the field name
      description - value for the field description
      flags - value for the field flags
      bits - value for the field bits
      nComponents - value for the field nComponents
      shift - value for the field shift
      depth - value for the field depth
      pixelStride - value for the field pixelStride
      nPlanes - value for the field nPlanes
      plane - value for the field plane
      poffset - value for the field poffset
      wSub - value for the field wSub
      hSub - value for the field hSub
      unpackFormat - value for the field unpackFormat
      unpackFunc - value for the field unpackFunc
      packLines - value for the field packLines
      packFunc - value for the field packFunc
      tileMode - value for the field tileMode
      tileWs - value for the field tileWs
      tileHs - value for the field tileHs
      tileInfo - value for the field tileInfo
      arena - to control the memory allocation scope

    • VideoFormatInfo

      public VideoFormatInfo(VideoFormat format, String name, String description, Set<VideoFormatFlags> flags, int bits, int nComponents, int[] shift, int[] depth, int[] pixelStride, int nPlanes, int[] plane, int[] poffset, int[] wSub, int[] hSub, VideoFormat unpackFormat, VideoFormatUnpack unpackFunc, int packLines, VideoFormatPack packFunc, VideoTileMode tileMode, int tileWs, int tileHs, VideoTileInfo[] tileInfo)
      Allocate a new VideoFormatInfo with the fields set to the provided values. The memory is allocated with Arena.ofAuto().
      Parameters:
      format - value for the field format
      name - value for the field name
      description - value for the field description
      flags - value for the field flags
      bits - value for the field bits
      nComponents - value for the field nComponents
      shift - value for the field shift
      depth - value for the field depth
      pixelStride - value for the field pixelStride
      nPlanes - value for the field nPlanes
      plane - value for the field plane
      poffset - value for the field poffset
      wSub - value for the field wSub
      hSub - value for the field hSub
      unpackFormat - value for the field unpackFormat
      unpackFunc - value for the field unpackFunc
      packLines - value for the field packLines
      packFunc - value for the field packFunc
      tileMode - value for the field tileMode
      tileWs - value for the field tileWs
      tileHs - value for the field tileHs
      tileInfo - value for the field tileInfo

  • Method Details

    • getMemoryLayout

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

    • readFormat

      public VideoFormat readFormat()
      Read the value of the field format.
      Returns:
      The value of the field format

    • writeFormat

      public void writeFormat(VideoFormat format)
      Write a value in the field format.
      Parameters:
      format - The new value for the field format

    • readName

      public String readName()
      Read the value of the field name.
      Returns:
      The value of the field name

    • writeName

      public void writeName(String name, Arena _arena)
      Write a value in the field name.
      Parameters:
      name - The new value for the field name
      _arena - to control the memory allocation scope

    • readDescription

      public String readDescription()
      Read the value of the field description.
      Returns:
      The value of the field description

    • writeDescription

      public void writeDescription(String description, Arena _arena)
      Write a value in the field description.
      Parameters:
      description - The new value for the field description
      _arena - to control the memory allocation scope

    • readFlags

      public Set<VideoFormatFlags> readFlags()
      Read the value of the field flags.
      Returns:
      The value of the field flags

    • writeFlags

      public void writeFlags(Set<VideoFormatFlags> flags)
      Write a value in the field flags.
      Parameters:
      flags - The new value for the field flags

    • readBits

      public int readBits()
      Read the value of the field bits.
      Returns:
      The value of the field bits

    • writeBits

      public void writeBits(int bits)
      Write a value in the field bits.
      Parameters:
      bits - The new value for the field bits

    • readNComponents

      public int readNComponents()
      Read the value of the field n_components.
      Returns:
      The value of the field n_components

    • writeNComponents

      public void writeNComponents(int nComponents)
      Write a value in the field n_components.
      Parameters:
      nComponents - The new value for the field n_components

    • readShift

      public @Nullable int @Nullable [] readShift()
      Read the value of the field shift.
      Returns:
      The value of the field shift

    • writeShift

      public void writeShift(@Nullable int @Nullable [] shift, Arena _arena)
      Write a value in the field shift.
      Parameters:
      shift - The new value for the field shift

    • readDepth

      public @Nullable int @Nullable [] readDepth()
      Read the value of the field depth.
      Returns:
      The value of the field depth

    • writeDepth

      public void writeDepth(@Nullable int @Nullable [] depth, Arena _arena)
      Write a value in the field depth.
      Parameters:
      depth - The new value for the field depth

    • readPixelStride

      public @Nullable int @Nullable [] readPixelStride()
      Read the value of the field pixel_stride.
      Returns:
      The value of the field pixel_stride

    • writePixelStride

      public void writePixelStride(@Nullable int @Nullable [] pixelStride, Arena _arena)
      Write a value in the field pixel_stride.
      Parameters:
      pixelStride - The new value for the field pixel_stride

    • readNPlanes

      public int readNPlanes()
      Read the value of the field n_planes.
      Returns:
      The value of the field n_planes

    • writeNPlanes

      public void writeNPlanes(int nPlanes)
      Write a value in the field n_planes.
      Parameters:
      nPlanes - The new value for the field n_planes

    • readPlane

      public @Nullable int @Nullable [] readPlane()
      Read the value of the field plane.
      Returns:
      The value of the field plane

    • writePlane

      public void writePlane(@Nullable int @Nullable [] plane, Arena _arena)
      Write a value in the field plane.
      Parameters:
      plane - The new value for the field plane

    • readPoffset

      public @Nullable int @Nullable [] readPoffset()
      Read the value of the field poffset.
      Returns:
      The value of the field poffset

    • writePoffset

      public void writePoffset(@Nullable int @Nullable [] poffset, Arena _arena)
      Write a value in the field poffset.
      Parameters:
      poffset - The new value for the field poffset

    • readWSub

      public @Nullable int @Nullable [] readWSub()
      Read the value of the field w_sub.
      Returns:
      The value of the field w_sub

    • writeWSub

      public void writeWSub(@Nullable int @Nullable [] wSub, Arena _arena)
      Write a value in the field w_sub.
      Parameters:
      wSub - The new value for the field w_sub

    • readHSub

      public @Nullable int @Nullable [] readHSub()
      Read the value of the field h_sub.
      Returns:
      The value of the field h_sub

    • writeHSub

      public void writeHSub(@Nullable int @Nullable [] hSub, Arena _arena)
      Write a value in the field h_sub.
      Parameters:
      hSub - The new value for the field h_sub

    • readUnpackFormat

      public VideoFormat readUnpackFormat()
      Read the value of the field unpack_format.
      Returns:
      The value of the field unpack_format

    • writeUnpackFormat

      public void writeUnpackFormat(VideoFormat unpackFormat)
      Write a value in the field unpack_format.
      Parameters:
      unpackFormat - The new value for the field unpack_format

    • readUnpackFunc

      public @Nullable VideoFormatUnpack readUnpackFunc()
      Read the value of the field unpack_func.
      Returns:
      The value of the field unpack_func

    • writeUnpackFunc

      public void writeUnpackFunc(@Nullable VideoFormatUnpack unpackFunc, Arena _arena)
      Write a value in the field unpack_func.
      Parameters:
      unpackFunc - The new value for the field unpack_func
      _arena - to control the memory allocation scope

    • readPackLines

      public int readPackLines()
      Read the value of the field pack_lines.
      Returns:
      The value of the field pack_lines

    • writePackLines

      public void writePackLines(int packLines)
      Write a value in the field pack_lines.
      Parameters:
      packLines - The new value for the field pack_lines

    • readPackFunc

      public @Nullable VideoFormatPack readPackFunc()
      Read the value of the field pack_func.
      Returns:
      The value of the field pack_func

    • writePackFunc

      public void writePackFunc(@Nullable VideoFormatPack packFunc, Arena _arena)
      Write a value in the field pack_func.
      Parameters:
      packFunc - The new value for the field pack_func
      _arena - to control the memory allocation scope

    • readTileMode

      public VideoTileMode readTileMode()
      Read the value of the field tile_mode.
      Returns:
      The value of the field tile_mode

    • writeTileMode

      public void writeTileMode(VideoTileMode tileMode)
      Write a value in the field tile_mode.
      Parameters:
      tileMode - The new value for the field tile_mode

    • readTileWs

      public int readTileWs()
      Read the value of the field tile_ws.
      Returns:
      The value of the field tile_ws

    • writeTileWs

      public void writeTileWs(int tileWs)
      Write a value in the field tile_ws.
      Parameters:
      tileWs - The new value for the field tile_ws

    • readTileHs

      public int readTileHs()
      Read the value of the field tile_hs.
      Returns:
      The value of the field tile_hs

    • writeTileHs

      public void writeTileHs(int tileHs)
      Write a value in the field tile_hs.
      Parameters:
      tileHs - The new value for the field tile_hs

    • readTileInfo

      public @Nullable VideoTileInfo @Nullable [] readTileInfo()
      Read the value of the field tile_info.
      Returns:
      The value of the field tile_info

    • writeTileInfo

      public void writeTileInfo(@Nullable VideoTileInfo @Nullable [] tileInfo, Arena _arena)
      Write a value in the field tile_info.
      Parameters:
      tileInfo - The new value for the field tile_info

    • component

      public void component(int plane, Out<Integer> components)
      Fill components with the number of all the components packed in plane p for the format info. A value of -1 in components indicates that no more components are packed in the plane.
      Parameters:
      plane - a plane number
      components - array used to store component numbers
      Since:
      1.18

    • extrapolateStride

      public int extrapolateStride(int plane, int stride)
      Extrapolate plane stride from the first stride of an image. This helper is useful to support legacy API were only one stride is supported.
      Parameters:
      plane - a plane number
      stride - The fist plane stride
      Returns:
      The extrapolated stride for plane
      Since:
      1.22