GI.GstVideo.Structs.VideoFormatInfo

Information for a video format.

Exported types

newtype VideoFormatInfo

Memory-managed wrapper type.

Constructors

VideoFormatInfo (ManagedPtr VideoFormatInfo)

Instances

Eq VideoFormatInfo

Defined in GI.GstVideo.Structs.VideoFormatInfo

Methods

(==) :: VideoFormatInfo -> VideoFormatInfo -> Bool

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

BoxedPtr VideoFormatInfo

Defined in GI.GstVideo.Structs.VideoFormatInfo

Methods

boxedPtrCopy :: VideoFormatInfo -> IO VideoFormatInfo

boxedPtrFree :: VideoFormatInfo -> IO ()

CallocPtr VideoFormatInfo

Defined in GI.GstVideo.Structs.VideoFormatInfo

Methods

boxedPtrCalloc :: IO (Ptr VideoFormatInfo)

ManagedPtrNewtype VideoFormatInfo

Defined in GI.GstVideo.Structs.VideoFormatInfo

Methods

toManagedPtr :: VideoFormatInfo -> ManagedPtr VideoFormatInfo

tag ~ 'AttrSet => Constructible VideoFormatInfo tag

Defined in GI.GstVideo.Structs.VideoFormatInfo

Methods

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

newZeroVideoFormatInfo :: MonadIO m => m VideoFormatInfo

Construct a VideoFormatInfo struct initialized to zero.

Methods

Click to display all available methods, including inherited ones

Methods

component, extrapolateStride.

Getters

None.

Setters

None.

component

videoFormatInfoComponent

Arguments

:: (HasCallStack, MonadIO m)

=> VideoFormatInfo

info: VideoFormatInfo

-> Word32

plane: a plane number

-> m Int32

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.

Since: 1.18

extrapolateStride

videoFormatInfoExtrapolateStride

Arguments

:: (HasCallStack, MonadIO m)

=> VideoFormatInfo

finfo: VideoFormatInfo

-> Int32

plane: a plane number

-> Int32

stride: The fist plane stride

-> m Int32

Returns: The extrapolated stride for plane

Extrapolate plane stride from the first stride of an image. This helper is useful to support legacy API were only one stride is supported.

Since: 1.22

Properties

bits

The number of bits used to pack data items. This can be less than 8 when multiple pixels are stored in a byte. for values > 8 multiple bytes should be read according to the endianness flag before applying the shift and mask.

getVideoFormatInfoBits :: MonadIO m => VideoFormatInfo -> m Word32

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

get videoFormatInfo #bits

setVideoFormatInfoBits :: MonadIO m => VideoFormatInfo -> Word32 -> m ()

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

set videoFormatInfo [ #bits := value ]

description

use readable description of the format

clearVideoFormatInfoDescription :: MonadIO m => VideoFormatInfo -> m ()

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

clear #description

getVideoFormatInfoDescription :: MonadIO m => VideoFormatInfo -> m (Maybe Text)

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

get videoFormatInfo #description

setVideoFormatInfoDescription :: MonadIO m => VideoFormatInfo -> CString -> m ()

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

set videoFormatInfo [ #description := value ]

flags

VideoFormatFlags

getVideoFormatInfoFlags :: MonadIO m => VideoFormatInfo -> m [VideoFormatFlags]

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

get videoFormatInfo #flags

setVideoFormatInfoFlags :: MonadIO m => VideoFormatInfo -> [VideoFormatFlags] -> m ()

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

set videoFormatInfo [ #flags := value ]

format

VideoFormat

getVideoFormatInfoFormat :: MonadIO m => VideoFormatInfo -> m VideoFormat

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

get videoFormatInfo #format

setVideoFormatInfoFormat :: MonadIO m => VideoFormatInfo -> VideoFormat -> m ()

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

set videoFormatInfo [ #format := value ]

nComponents

the number of components in the video format.

getVideoFormatInfoNComponents :: MonadIO m => VideoFormatInfo -> m Word32

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

get videoFormatInfo #nComponents

setVideoFormatInfoNComponents :: MonadIO m => VideoFormatInfo -> Word32 -> m ()

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

set videoFormatInfo [ #nComponents := value ]

nPlanes

the number of planes for this format. The number of planes can be less than the amount of components when multiple components are packed into one plane.

getVideoFormatInfoNPlanes :: MonadIO m => VideoFormatInfo -> m Word32

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

get videoFormatInfo #nPlanes

setVideoFormatInfoNPlanes :: MonadIO m => VideoFormatInfo -> Word32 -> m ()

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

set videoFormatInfo [ #nPlanes := value ]

name

string representation of the format

clearVideoFormatInfoName :: MonadIO m => VideoFormatInfo -> m ()

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

clear #name

getVideoFormatInfoName :: MonadIO m => VideoFormatInfo -> m (Maybe Text)

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

get videoFormatInfo #name

setVideoFormatInfoName :: MonadIO m => VideoFormatInfo -> CString -> m ()

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

set videoFormatInfo [ #name := value ]

packFunc

an pack function for this format

clearVideoFormatInfoPackFunc :: MonadIO m => VideoFormatInfo -> m ()

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

clear #packFunc

getVideoFormatInfoPackFunc :: MonadIO m => VideoFormatInfo -> m (Maybe VideoFormatPack)

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

get videoFormatInfo #packFunc

setVideoFormatInfoPackFunc :: MonadIO m => VideoFormatInfo -> FunPtr C_VideoFormatPack -> m ()

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

set videoFormatInfo [ #packFunc := value ]

packLines

the amount of lines that will be packed

getVideoFormatInfoPackLines :: MonadIO m => VideoFormatInfo -> m Int32

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

get videoFormatInfo #packLines

setVideoFormatInfoPackLines :: MonadIO m => VideoFormatInfo -> Int32 -> m ()

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

set videoFormatInfo [ #packLines := value ]

tileHs

The height of a tile, in bytes, represented as a shift. DEPREACTED, use tile_info[] array instead.

getVideoFormatInfoTileHs :: MonadIO m => VideoFormatInfo -> m Word32

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

get videoFormatInfo #tileHs

setVideoFormatInfoTileHs :: MonadIO m => VideoFormatInfo -> Word32 -> m ()

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

set videoFormatInfo [ #tileHs := value ]

tileMode

The tiling mode

getVideoFormatInfoTileMode :: MonadIO m => VideoFormatInfo -> m VideoTileMode

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

get videoFormatInfo #tileMode

setVideoFormatInfoTileMode :: MonadIO m => VideoFormatInfo -> VideoTileMode -> m ()

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

set videoFormatInfo [ #tileMode := value ]

tileWs

The width of a tile, in bytes, represented as a shift. DEPRECATED, use tile_info[] array instead.

getVideoFormatInfoTileWs :: MonadIO m => VideoFormatInfo -> m Word32

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

get videoFormatInfo #tileWs

setVideoFormatInfoTileWs :: MonadIO m => VideoFormatInfo -> Word32 -> m ()

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

set videoFormatInfo [ #tileWs := value ]

unpackFormat

the format of the unpacked pixels. This format must have the GST_VIDEO_FORMAT_FLAG_UNPACK flag set.

getVideoFormatInfoUnpackFormat :: MonadIO m => VideoFormatInfo -> m VideoFormat

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

get videoFormatInfo #unpackFormat

setVideoFormatInfoUnpackFormat :: MonadIO m => VideoFormatInfo -> VideoFormat -> m ()

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

set videoFormatInfo [ #unpackFormat := value ]

unpackFunc

an unpack function for this format

clearVideoFormatInfoUnpackFunc :: MonadIO m => VideoFormatInfo -> m ()

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

clear #unpackFunc

getVideoFormatInfoUnpackFunc :: MonadIO m => VideoFormatInfo -> m (Maybe VideoFormatUnpack)

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

get videoFormatInfo #unpackFunc

setVideoFormatInfoUnpackFunc :: MonadIO m => VideoFormatInfo -> FunPtr C_VideoFormatUnpack -> m ()

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

set videoFormatInfo [ #unpackFunc := value ]