GI.GstVideo.Structs.VideoMasteringDisplayInfo

Mastering display color volume information defined by SMPTE ST 2086 (a.k.a static HDR metadata).

Since: 1.18

Exported types

newtype VideoMasteringDisplayInfo

Memory-managed wrapper type.

Constructors

VideoMasteringDisplayInfo (ManagedPtr VideoMasteringDisplayInfo)

Instances

Eq VideoMasteringDisplayInfo

Defined in GI.GstVideo.Structs.VideoMasteringDisplayInfo

Methods

(==) :: VideoMasteringDisplayInfo -> VideoMasteringDisplayInfo -> Bool

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

BoxedPtr VideoMasteringDisplayInfo

Defined in GI.GstVideo.Structs.VideoMasteringDisplayInfo

Methods

boxedPtrCopy :: VideoMasteringDisplayInfo -> IO VideoMasteringDisplayInfo

boxedPtrFree :: VideoMasteringDisplayInfo -> IO ()

CallocPtr VideoMasteringDisplayInfo

Defined in GI.GstVideo.Structs.VideoMasteringDisplayInfo

Methods

boxedPtrCalloc :: IO (Ptr VideoMasteringDisplayInfo)

ManagedPtrNewtype VideoMasteringDisplayInfo

Defined in GI.GstVideo.Structs.VideoMasteringDisplayInfo

Methods

toManagedPtr :: VideoMasteringDisplayInfo -> ManagedPtr VideoMasteringDisplayInfo

tag ~ 'AttrSet => Constructible VideoMasteringDisplayInfo tag

Defined in GI.GstVideo.Structs.VideoMasteringDisplayInfo

Methods

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

newZeroVideoMasteringDisplayInfo :: MonadIO m => m VideoMasteringDisplayInfo

Construct a VideoMasteringDisplayInfo struct initialized to zero.

Methods

Click to display all available methods, including inherited ones

Methods

addToCaps, fromCaps, init, isEqual, toString.

Getters

None.

Setters

None.

addToCaps

videoMasteringDisplayInfoAddToCaps

Arguments

:: (HasCallStack, MonadIO m)

=> VideoMasteringDisplayInfo

minfo: a VideoMasteringDisplayInfo

-> Caps

caps: a Caps

-> m Bool

Returns: True if minfo was successfully set to caps

Set string representation of minfo to caps

Since: 1.18

fromCaps

videoMasteringDisplayInfoFromCaps

Arguments

:: (HasCallStack, MonadIO m)

=> VideoMasteringDisplayInfo

minfo: a VideoMasteringDisplayInfo

-> Caps

caps: a Caps

-> m Bool

Returns: True if caps has VideoMasteringDisplayInfo and could be parsed

Parse caps and update minfo

Since: 1.18

fromString

videoMasteringDisplayInfoFromString

Arguments

:: (HasCallStack, MonadIO m)

=> Text

mastering: a Structure representing VideoMasteringDisplayInfo

-> m (Bool, VideoMasteringDisplayInfo)

Returns: True if minfo was filled with mastering

Extract VideoMasteringDisplayInfo from mastering

Since: 1.18

init

videoMasteringDisplayInfoInit

Arguments

:: (HasCallStack, MonadIO m)

=> VideoMasteringDisplayInfo

minfo: a VideoMasteringDisplayInfo

-> m ()

Initialize minfo

Since: 1.18

isEqual

videoMasteringDisplayInfoIsEqual

Arguments

:: (HasCallStack, MonadIO m)

=> VideoMasteringDisplayInfo

minfo: a VideoMasteringDisplayInfo

-> VideoMasteringDisplayInfo

other: a VideoMasteringDisplayInfo

-> m Bool

Returns: True if minfo and other are equal.

Checks equality between minfo and other.

Since: 1.18

toString

videoMasteringDisplayInfoToString

Arguments

:: (HasCallStack, MonadIO m)

=> VideoMasteringDisplayInfo

minfo: a VideoMasteringDisplayInfo

-> m Text

Returns: a string representation of minfo

Convert minfo to its string representation

Since: 1.18

Properties

maxDisplayMasteringLuminance

the maximum value of display luminance in unit of 0.0001 candelas per square metre (cd/m^2 and nit)

getVideoMasteringDisplayInfoMaxDisplayMasteringLuminance :: MonadIO m => VideoMasteringDisplayInfo -> m Word32

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

get videoMasteringDisplayInfo #maxDisplayMasteringLuminance

setVideoMasteringDisplayInfoMaxDisplayMasteringLuminance :: MonadIO m => VideoMasteringDisplayInfo -> Word32 -> m ()

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

set videoMasteringDisplayInfo [ #maxDisplayMasteringLuminance := value ]

minDisplayMasteringLuminance

the minimum value of display luminance in unit of 0.0001 candelas per square metre (cd/m^2 and nit)

getVideoMasteringDisplayInfoMinDisplayMasteringLuminance :: MonadIO m => VideoMasteringDisplayInfo -> m Word32

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

get videoMasteringDisplayInfo #minDisplayMasteringLuminance

setVideoMasteringDisplayInfoMinDisplayMasteringLuminance :: MonadIO m => VideoMasteringDisplayInfo -> Word32 -> m ()

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

set videoMasteringDisplayInfo [ #minDisplayMasteringLuminance := value ]

whitePoint

the xy coordinates of white point in the CIE 1931 color space. each value is normalized to 50000 (meaning that in unit of 0.00002)

getVideoMasteringDisplayInfoWhitePoint :: MonadIO m => VideoMasteringDisplayInfo -> m VideoMasteringDisplayInfoCoordinates

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

get videoMasteringDisplayInfo #whitePoint