Copyright	Will Thompson and Iñaki García Etxebarria
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	Safe-Inferred
Language	Haskell2010

GI.GstVideo.Structs.VideoColorimetry

Contents

Exported types
Methods
Properties

Description

Structure describing the color info.

Synopsis

newtype VideoColorimetry = VideoColorimetry (ManagedPtr VideoColorimetry)
newZeroVideoColorimetry :: MonadIO m => m VideoColorimetry
videoColorimetryFromString :: (HasCallStack, MonadIO m) => VideoColorimetry -> Text -> m Bool
videoColorimetryIsEqual :: (HasCallStack, MonadIO m) => VideoColorimetry -> VideoColorimetry -> m Bool
videoColorimetryIsEquivalent :: (HasCallStack, MonadIO m) => VideoColorimetry -> Word32 -> VideoColorimetry -> Word32 -> m Bool
videoColorimetryMatches :: (HasCallStack, MonadIO m) => VideoColorimetry -> Text -> m Bool
videoColorimetryToString :: (HasCallStack, MonadIO m) => VideoColorimetry -> m (Maybe Text)
getVideoColorimetryMatrix :: MonadIO m => VideoColorimetry -> m VideoColorMatrix
setVideoColorimetryMatrix :: MonadIO m => VideoColorimetry -> VideoColorMatrix -> m ()
getVideoColorimetryPrimaries :: MonadIO m => VideoColorimetry -> m VideoColorPrimaries
setVideoColorimetryPrimaries :: MonadIO m => VideoColorimetry -> VideoColorPrimaries -> m ()
getVideoColorimetryRange :: MonadIO m => VideoColorimetry -> m VideoColorRange
setVideoColorimetryRange :: MonadIO m => VideoColorimetry -> VideoColorRange -> m ()
getVideoColorimetryTransfer :: MonadIO m => VideoColorimetry -> m VideoTransferFunction
setVideoColorimetryTransfer :: MonadIO m => VideoColorimetry -> VideoTransferFunction -> m ()

Exported types

newtype VideoColorimetry Source #

Memory-managed wrapper type.

Constructors

VideoColorimetry (ManagedPtr VideoColorimetry)

Instances

Instances details

Eq VideoColorimetry Source #
Instance details Defined in GI.GstVideo.Structs.VideoColorimetry Methods (==) :: VideoColorimetry -> VideoColorimetry -> Bool # (/=) :: VideoColorimetry -> VideoColorimetry -> Bool #
BoxedPtr VideoColorimetry Source #
Instance details Defined in GI.GstVideo.Structs.VideoColorimetry Methods boxedPtrCopy :: VideoColorimetry -> IO VideoColorimetry boxedPtrFree :: VideoColorimetry -> IO ()
CallocPtr VideoColorimetry Source #
Instance details Defined in GI.GstVideo.Structs.VideoColorimetry Methods boxedPtrCalloc :: IO (Ptr VideoColorimetry)
ManagedPtrNewtype VideoColorimetry Source #
Instance details Defined in GI.GstVideo.Structs.VideoColorimetry Methods toManagedPtr :: VideoColorimetry -> ManagedPtr VideoColorimetry
tag ~ 'AttrSet => Constructible VideoColorimetry tag Source #
Instance details Defined in GI.GstVideo.Structs.VideoColorimetry Methods new :: MonadIO m => (ManagedPtr VideoColorimetry -> VideoColorimetry) -> [AttrOp VideoColorimetry tag] -> m VideoColorimetry

newZeroVideoColorimetry :: MonadIO m => m VideoColorimetry Source #

Construct a VideoColorimetry struct initialized to zero.

Methods

Click to display all available methods, including inherited ones

Expand

Methods

fromString, isEqual, isEquivalent, matches, toString.

Getters

None.

Setters

None.

fromString

videoColorimetryFromString Source #

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 Source #

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

isEquivalent

videoColorimetryIsEquivalent Source #

Arguments

:: (HasCallStack, MonadIO m)
=> VideoColorimetry	`cinfo`: a `VideoColorimetry`
-> Word32	`bitdepth`: bitdepth of a format associated with `cinfo`
-> VideoColorimetry	`other`: another `VideoColorimetry`
-> Word32	`otherBitdepth`: bitdepth of a format associated with `other`
-> m Bool	Returns: `True` if `cinfo` and `other` are equivalent.

Compare the 2 colorimetry sets for functionally equality

Since: 1.22

matches

videoColorimetryMatches Source #

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 Source #

Arguments

:: (HasCallStack, MonadIO m)
=> VideoColorimetry	`cinfo`: a `VideoColorimetry`
-> m (Maybe Text)	Returns: a string representation of `cinfo` or `Nothing` if all the entries of `cinfo` are unknown values.

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 Source #

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

get videoColorimetry #matrix

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

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 Source #

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

get videoColorimetry #primaries

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

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 Source #

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

get videoColorimetry #range

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

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 Source #

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

get videoColorimetry #transfer

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

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

set videoColorimetry [ #transfer := value ]