gi-gst-1.0.20: GStreamer bindings

CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (inaki@blueleaf.cc)
Safe HaskellNone
LanguageHaskell2010

GI.Gst.Structs.MapInfo

Contents

Description

A structure containing the result of a map operation such as memoryMap. It contains the data and size.

Synopsis

Exported types

newtype MapInfo Source #

Memory-managed wrapper type.

Constructors

MapInfo (ManagedPtr MapInfo) 
Instances
WrappedPtr MapInfo Source # 
Instance details

Defined in GI.Gst.Structs.MapInfo

tag ~ AttrSet => Constructible MapInfo tag Source # 
Instance details

Defined in GI.Gst.Structs.MapInfo

Methods

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

newZeroMapInfo :: MonadIO m => m MapInfo Source #

Construct a MapInfo struct initialized to zero.

noMapInfo :: Maybe MapInfo Source #

A convenience alias for Nothing :: Maybe MapInfo.

Properties

flags

flags used when mapping the memory

getMapInfoFlags :: MonadIO m => MapInfo -> m [MapFlags] Source #

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

get mapInfo #flags

setMapInfoFlags :: MonadIO m => MapInfo -> [MapFlags] -> m () Source #

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

set mapInfo [ #flags := value ]

maxsize

the maximum bytes in data

getMapInfoMaxsize :: MonadIO m => MapInfo -> m Word64 Source #

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

get mapInfo #maxsize

setMapInfoMaxsize :: MonadIO m => MapInfo -> Word64 -> m () Source #

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

set mapInfo [ #maxsize := value ]

memory

a pointer to the mapped memory

clearMapInfoMemory :: MonadIO m => MapInfo -> m () Source #

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

clear #memory

getMapInfoMemory :: MonadIO m => MapInfo -> m (Maybe Memory) Source #

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

get mapInfo #memory

setMapInfoMemory :: MonadIO m => MapInfo -> Ptr Memory -> m () Source #

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

set mapInfo [ #memory := value ]

size

the valid size in data

getMapInfoSize :: MonadIO m => MapInfo -> m Word64 Source #

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

get mapInfo #size

setMapInfoSize :: MonadIO m => MapInfo -> Word64 -> m () Source #

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

set mapInfo [ #size := value ]