GI.GstVideo.Structs.VideoColorimetry

Structure describing the color info.

Exported types

newtype VideoColorimetry

Memory-managed wrapper type.

Constructors

VideoColorimetry (ManagedPtr VideoColorimetry)

Instances

Eq VideoColorimetry

Defined in GI.GstVideo.Structs.VideoColorimetry

Methods

(==) :: VideoColorimetry -> VideoColorimetry -> Bool

(/=) :: VideoColorimetry -> VideoColorimetry -> Bool

WrappedPtr VideoColorimetry

Defined in GI.GstVideo.Structs.VideoColorimetry

Methods

wrappedPtrCalloc :: IO (Ptr VideoColorimetry)

wrappedPtrCopy :: VideoColorimetry -> IO VideoColorimetry

wrappedPtrFree :: Maybe (GDestroyNotify VideoColorimetry)

tag ~ 'AttrSet => Constructible VideoColorimetry tag

Defined in GI.GstVideo.Structs.VideoColorimetry

Methods

new :: MonadIO m => (ManagedPtr VideoColorimetry -> VideoColorimetry) -> [AttrOp VideoColorimetry tag] -> m VideoColorimetry

newZeroVideoColorimetry :: MonadIO m => m VideoColorimetry

Construct a VideoColorimetry struct initialized to zero.

noVideoColorimetry :: Maybe VideoColorimetry

A convenience alias for Nothing :: Maybe VideoColorimetry.

Methods

Overloaded methods

fromString

videoColorimetryFromString

Arguments

:: (HasCallStack, MonadIO m)

=> VideoColorimetry

cinfo: a VideoColorimetry

-> Text

color: a colorimetry string

-> m Bool

Returns: True if color points to valid colorimetry info.

Parse the colorimetry string and update cinfo with the parsed values.

isEqual

videoColorimetryIsEqual

Arguments

:: (HasCallStack, MonadIO m)

=> VideoColorimetry

cinfo: a VideoColorimetry

-> VideoColorimetry

other: another VideoColorimetry

-> m Bool

Returns: True if cinfo and other are equal.

Compare the 2 colorimetry sets for equality

Since: 1.6

matches

videoColorimetryMatches

Arguments

:: (HasCallStack, MonadIO m)

=> VideoColorimetry

cinfo: a VideoInfo

-> Text

color: a colorimetry string

-> m Bool

Returns: True if color conveys the same colorimetry info as the color information in info.

Check if the colorimetry information in info matches that of the string color.

toString

videoColorimetryToString

Arguments

:: (HasCallStack, MonadIO m)

=> VideoColorimetry

cinfo: a VideoColorimetry

-> m Text

Returns: a string representation of cinfo.

Make a string representation of cinfo.

Properties

matrix

the color matrix. Used to convert between Y'PbPr and non-linear RGB (R'G'B')

getVideoColorimetryMatrix :: MonadIO m => VideoColorimetry -> m VideoColorMatrix

Get the value of the “matrix” field. When overloading is enabled, this is equivalent to

get videoColorimetry #matrix

setVideoColorimetryMatrix :: MonadIO m => VideoColorimetry -> VideoColorMatrix -> m ()

Set the value of the “matrix” field. When overloading is enabled, this is equivalent to

set videoColorimetry [ #matrix := value ]

primaries

color primaries. used to convert between R'G'B' and CIE XYZ

getVideoColorimetryPrimaries :: MonadIO m => VideoColorimetry -> m VideoColorPrimaries

Get the value of the “primaries” field. When overloading is enabled, this is equivalent to

get videoColorimetry #primaries

setVideoColorimetryPrimaries :: MonadIO m => VideoColorimetry -> VideoColorPrimaries -> m ()

Set the value of the “primaries” field. When overloading is enabled, this is equivalent to

set videoColorimetry [ #primaries := value ]

range

the color range. This is the valid range for the samples. It is used to convert the samples to Y'PbPr values.

getVideoColorimetryRange :: MonadIO m => VideoColorimetry -> m VideoColorRange

Get the value of the “range” field. When overloading is enabled, this is equivalent to

get videoColorimetry #range

setVideoColorimetryRange :: MonadIO m => VideoColorimetry -> VideoColorRange -> m ()

Set the value of the “range” field. When overloading is enabled, this is equivalent to

set videoColorimetry [ #range := value ]

transfer

the transfer function. used to convert between R'G'B' and RGB

getVideoColorimetryTransfer :: MonadIO m => VideoColorimetry -> m VideoTransferFunction

Get the value of the “transfer” field. When overloading is enabled, this is equivalent to

get videoColorimetry #transfer

setVideoColorimetryTransfer :: MonadIO m => VideoColorimetry -> VideoTransferFunction -> m ()

Set the value of the “transfer” field. When overloading is enabled, this is equivalent to

set videoColorimetry [ #transfer := value ]