GI.Gst.Structs.MapInfo

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

MapInfo cannot be used with g_auto() because it is ambiguous whether it needs to be unmapped using bufferUnmap or memoryUnmap. Instead, GstBufferMapInfo and GstMemoryMapInfo can be used in that case.

Exported types

newtype MapInfo

Memory-managed wrapper type.

Constructors

MapInfo (ManagedPtr MapInfo)

Instances

Eq MapInfo

Defined in GI.Gst.Structs.MapInfo

Methods

(==) :: MapInfo -> MapInfo -> Bool

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

BoxedPtr MapInfo

Defined in GI.Gst.Structs.MapInfo

Methods

boxedPtrCopy :: MapInfo -> IO MapInfo

boxedPtrFree :: MapInfo -> IO ()

CallocPtr MapInfo

Defined in GI.Gst.Structs.MapInfo

Methods

boxedPtrCalloc :: IO (Ptr MapInfo)

ManagedPtrNewtype MapInfo

Defined in GI.Gst.Structs.MapInfo

Methods

toManagedPtr :: MapInfo -> ManagedPtr MapInfo

tag ~ 'AttrSet => Constructible MapInfo tag

Defined in GI.Gst.Structs.MapInfo

Methods

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

newZeroMapInfo :: MonadIO m => m MapInfo

Construct a MapInfo struct initialized to zero.

Methods

Properties

flags

flags used when mapping the memory

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

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

get mapInfo #flags

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

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

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

get mapInfo #maxsize

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

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 ()

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)

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 ()

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

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

get mapInfo #size

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

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

set mapInfo [ #size := value ]