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 |
Information for a video format.
Synopsis
- newtype VideoFormatInfo = VideoFormatInfo (ManagedPtr VideoFormatInfo)
- newZeroVideoFormatInfo :: MonadIO m => m VideoFormatInfo
- videoFormatInfoComponent :: (HasCallStack, MonadIO m) => VideoFormatInfo -> Word32 -> m Int32
- getVideoFormatInfoBits :: MonadIO m => VideoFormatInfo -> m Word32
- setVideoFormatInfoBits :: MonadIO m => VideoFormatInfo -> Word32 -> m ()
- clearVideoFormatInfoDescription :: MonadIO m => VideoFormatInfo -> m ()
- getVideoFormatInfoDescription :: MonadIO m => VideoFormatInfo -> m (Maybe Text)
- setVideoFormatInfoDescription :: MonadIO m => VideoFormatInfo -> CString -> m ()
- getVideoFormatInfoFlags :: MonadIO m => VideoFormatInfo -> m [VideoFormatFlags]
- setVideoFormatInfoFlags :: MonadIO m => VideoFormatInfo -> [VideoFormatFlags] -> m ()
- getVideoFormatInfoFormat :: MonadIO m => VideoFormatInfo -> m VideoFormat
- setVideoFormatInfoFormat :: MonadIO m => VideoFormatInfo -> VideoFormat -> m ()
- getVideoFormatInfoNComponents :: MonadIO m => VideoFormatInfo -> m Word32
- setVideoFormatInfoNComponents :: MonadIO m => VideoFormatInfo -> Word32 -> m ()
- getVideoFormatInfoNPlanes :: MonadIO m => VideoFormatInfo -> m Word32
- setVideoFormatInfoNPlanes :: MonadIO m => VideoFormatInfo -> Word32 -> m ()
- clearVideoFormatInfoName :: MonadIO m => VideoFormatInfo -> m ()
- getVideoFormatInfoName :: MonadIO m => VideoFormatInfo -> m (Maybe Text)
- setVideoFormatInfoName :: MonadIO m => VideoFormatInfo -> CString -> m ()
- clearVideoFormatInfoPackFunc :: MonadIO m => VideoFormatInfo -> m ()
- getVideoFormatInfoPackFunc :: MonadIO m => VideoFormatInfo -> m (Maybe VideoFormatPack)
- setVideoFormatInfoPackFunc :: MonadIO m => VideoFormatInfo -> FunPtr C_VideoFormatPack -> m ()
- getVideoFormatInfoPackLines :: MonadIO m => VideoFormatInfo -> m Int32
- setVideoFormatInfoPackLines :: MonadIO m => VideoFormatInfo -> Int32 -> m ()
- getVideoFormatInfoTileHs :: MonadIO m => VideoFormatInfo -> m Word32
- setVideoFormatInfoTileHs :: MonadIO m => VideoFormatInfo -> Word32 -> m ()
- getVideoFormatInfoTileMode :: MonadIO m => VideoFormatInfo -> m VideoTileMode
- setVideoFormatInfoTileMode :: MonadIO m => VideoFormatInfo -> VideoTileMode -> m ()
- getVideoFormatInfoTileWs :: MonadIO m => VideoFormatInfo -> m Word32
- setVideoFormatInfoTileWs :: MonadIO m => VideoFormatInfo -> Word32 -> m ()
- getVideoFormatInfoUnpackFormat :: MonadIO m => VideoFormatInfo -> m VideoFormat
- setVideoFormatInfoUnpackFormat :: MonadIO m => VideoFormatInfo -> VideoFormat -> m ()
- clearVideoFormatInfoUnpackFunc :: MonadIO m => VideoFormatInfo -> m ()
- getVideoFormatInfoUnpackFunc :: MonadIO m => VideoFormatInfo -> m (Maybe VideoFormatUnpack)
- setVideoFormatInfoUnpackFunc :: MonadIO m => VideoFormatInfo -> FunPtr C_VideoFormatUnpack -> m ()
Exported types
newtype VideoFormatInfo Source #
Memory-managed wrapper type.
Instances
Eq VideoFormatInfo Source # | |
Defined in GI.GstVideo.Structs.VideoFormatInfo (==) :: VideoFormatInfo -> VideoFormatInfo -> Bool # (/=) :: VideoFormatInfo -> VideoFormatInfo -> Bool # | |
BoxedPtr VideoFormatInfo Source # | |
Defined in GI.GstVideo.Structs.VideoFormatInfo boxedPtrCopy :: VideoFormatInfo -> IO VideoFormatInfo # boxedPtrFree :: VideoFormatInfo -> IO () # | |
CallocPtr VideoFormatInfo Source # | |
Defined in GI.GstVideo.Structs.VideoFormatInfo boxedPtrCalloc :: IO (Ptr VideoFormatInfo) # | |
ManagedPtrNewtype VideoFormatInfo Source # | |
Defined in GI.GstVideo.Structs.VideoFormatInfo | |
tag ~ 'AttrSet => Constructible VideoFormatInfo tag Source # | |
Defined in GI.GstVideo.Structs.VideoFormatInfo new :: MonadIO m => (ManagedPtr VideoFormatInfo -> VideoFormatInfo) -> [AttrOp VideoFormatInfo tag] -> m VideoFormatInfo # |
newZeroVideoFormatInfo :: MonadIO m => m VideoFormatInfo Source #
Construct a VideoFormatInfo
struct initialized to zero.
Methods
Click to display all available methods, including inherited ones
component
videoFormatInfoComponent Source #
:: (HasCallStack, MonadIO m) | |
=> VideoFormatInfo |
|
-> Word32 |
|
-> 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
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 Source #
Get the value of the “bits
” field.
When overloading is enabled, this is equivalent to
get
videoFormatInfo #bits
setVideoFormatInfoBits :: MonadIO m => VideoFormatInfo -> Word32 -> m () Source #
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 () Source #
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) Source #
Get the value of the “description
” field.
When overloading is enabled, this is equivalent to
get
videoFormatInfo #description
setVideoFormatInfoDescription :: MonadIO m => VideoFormatInfo -> CString -> m () Source #
Set the value of the “description
” field.
When overloading is enabled, this is equivalent to
set
videoFormatInfo [ #description:=
value ]
flags
getVideoFormatInfoFlags :: MonadIO m => VideoFormatInfo -> m [VideoFormatFlags] Source #
Get the value of the “flags
” field.
When overloading is enabled, this is equivalent to
get
videoFormatInfo #flags
setVideoFormatInfoFlags :: MonadIO m => VideoFormatInfo -> [VideoFormatFlags] -> m () Source #
Set the value of the “flags
” field.
When overloading is enabled, this is equivalent to
set
videoFormatInfo [ #flags:=
value ]
format
getVideoFormatInfoFormat :: MonadIO m => VideoFormatInfo -> m VideoFormat Source #
Get the value of the “format
” field.
When overloading is enabled, this is equivalent to
get
videoFormatInfo #format
setVideoFormatInfoFormat :: MonadIO m => VideoFormatInfo -> VideoFormat -> m () Source #
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 Source #
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 () Source #
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 Source #
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 () Source #
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 () Source #
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) Source #
Get the value of the “name
” field.
When overloading is enabled, this is equivalent to
get
videoFormatInfo #name
setVideoFormatInfoName :: MonadIO m => VideoFormatInfo -> CString -> m () Source #
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 () Source #
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) Source #
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 () Source #
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 Source #
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 () Source #
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
getVideoFormatInfoTileHs :: MonadIO m => VideoFormatInfo -> m Word32 Source #
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 () Source #
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 Source #
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 () Source #
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
getVideoFormatInfoTileWs :: MonadIO m => VideoFormatInfo -> m Word32 Source #
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 () Source #
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 Source #
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 () Source #
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 () Source #
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) Source #
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 () Source #
Set the value of the “unpack_func
” field.
When overloading is enabled, this is equivalent to
set
videoFormatInfo [ #unpackFunc:=
value ]