gi-gst-0.1.6.13: Gst bindings

CopyrightWill Thompson, Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (garetxe@gmail.com)
Safe HaskellNone
LanguageHaskell2010

GI.Gst.Structs.Memory

Contents

Description

GstMemory is a lightweight refcounted object that wraps a region of memory. They are typically used to manage the data of a #GstBuffer.

A GstMemory object has an allocated region of memory of maxsize. The maximum size does not change during the lifetime of the memory object. The memory also has an offset and size property that specifies the valid range of memory in the allocated region.

Memory is usually created by allocators with a gst_allocator_alloc() method call. When %NULL is used as the allocator, the default allocator will be used.

New allocators can be registered with gst_allocator_register(). Allocators are identified by name and can be retrieved with gst_allocator_find(). gst_allocator_set_default() can be used to change the default allocator.

New memory can be created with gst_memory_new_wrapped() that wraps the memory allocated elsewhere.

Refcounting of the memory block is performed with gst_memory_ref() and gst_memory_unref().

The size of the memory can be retrieved and changed with gst_memory_get_sizes() and gst_memory_resize() respectively.

Getting access to the data of the memory is performed with gst_memory_map(). The call will return a pointer to offset bytes into the region of memory. After the memory access is completed, gst_memory_unmap() should be called.

Memory can be copied with gst_memory_copy(), which will return a writable copy. gst_memory_share() will create a new memory block that shares the memory with an existing memory block at a custom offset and with a custom size.

Memory can be efficiently merged when gst_memory_is_span() returns %TRUE.

Synopsis

Exported types

newtype Memory Source

Constructors

Memory (ForeignPtr Memory) 

Instances

BoxedObject Memory Source 

Methods

boxedType :: Memory -> IO GType

((~) * info (ResolveMemoryMethod t Memory), MethodInfo * info Memory p) => IsLabel t (Memory -> p) Source 

Methods

fromLabel :: Proxy# Symbol t -> Memory -> p

((~) * info (ResolveMemoryMethod t Memory), MethodInfo * info Memory p) => IsLabelProxy t (Memory -> p) Source 

Methods

fromLabelProxy :: Proxy Symbol t -> Memory -> p

((~) (TYPE Lifted) signature (MapInfo -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) MemoryUnmapMethodInfo Memory signature Source 
((~) (TYPE Lifted) signature (Int64 -> Int64 -> m Memory), MonadIO m) => MethodInfo (TYPE Lifted) MemoryShareMethodInfo Memory signature Source 
((~) (TYPE Lifted) signature (Int64 -> Word64 -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) MemoryResizeMethodInfo Memory signature Source 
((~) (TYPE Lifted) signature ([MapFlags] -> m (Bool, MapInfo)), MonadIO m) => MethodInfo (TYPE Lifted) MemoryMapMethodInfo Memory signature Source 
((~) (TYPE Lifted) signature ([MapFlags] -> m (Memory, MapInfo)), MonadIO m) => MethodInfo (TYPE Lifted) MemoryMakeMappedMethodInfo Memory signature Source 
((~) (TYPE Lifted) signature (Text -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) MemoryIsTypeMethodInfo Memory signature Source 
((~) (TYPE Lifted) signature (Memory -> Word64 -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) MemoryIsSpanMethodInfo Memory signature Source 
((~) (TYPE Lifted) signature (Word64 -> Word64 -> m Word64), MonadIO m) => MethodInfo (TYPE Lifted) MemoryGetSizesMethodInfo Memory signature Source 
((~) (TYPE Lifted) signature (Int64 -> Int64 -> m Memory), MonadIO m) => MethodInfo (TYPE Lifted) MemoryCopyMethodInfo Memory signature Source 

newZeroMemory :: MonadIO m => m Memory Source

Construct a Memory struct initialized to zero.

noMemory :: Maybe Memory Source

Methods

memoryCopy

data MemoryCopyMethodInfo Source

Instances

memoryCopy :: MonadIO m => Memory -> Int64 -> Int64 -> m Memory Source

memoryGetSizes

data MemoryGetSizesMethodInfo Source

Instances

memoryGetSizes :: MonadIO m => Memory -> Word64 -> Word64 -> m Word64 Source

memoryIsSpan

data MemoryIsSpanMethodInfo Source

Instances

memoryIsSpan :: MonadIO m => Memory -> Memory -> Word64 -> m Bool Source

memoryIsType

data MemoryIsTypeMethodInfo Source

Instances

memoryIsType :: MonadIO m => Memory -> Text -> m Bool Source

memoryMakeMapped

data MemoryMakeMappedMethodInfo Source

Instances

memoryMakeMapped :: MonadIO m => Memory -> [MapFlags] -> m (Memory, MapInfo) Source

memoryMap

data MemoryMapMethodInfo Source

Instances

((~) (TYPE Lifted) signature ([MapFlags] -> m (Bool, MapInfo)), MonadIO m) => MethodInfo (TYPE Lifted) MemoryMapMethodInfo Memory signature Source 

memoryMap :: MonadIO m => Memory -> [MapFlags] -> m (Bool, MapInfo) Source

memoryNewWrapped

memoryNewWrapped :: MonadIO m => [MemoryFlags] -> ByteString -> Word64 -> Word64 -> Maybe DestroyNotify -> m Memory Source

memoryResize

data MemoryResizeMethodInfo Source

Instances

((~) (TYPE Lifted) signature (Int64 -> Word64 -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) MemoryResizeMethodInfo Memory signature Source 

memoryResize :: MonadIO m => Memory -> Int64 -> Word64 -> m () Source

memoryShare

data MemoryShareMethodInfo Source

Instances

memoryShare :: MonadIO m => Memory -> Int64 -> Int64 -> m Memory Source

memoryUnmap

data MemoryUnmapMethodInfo Source

Instances

((~) (TYPE Lifted) signature (MapInfo -> m ()), MonadIO m) => MethodInfo (TYPE Lifted) MemoryUnmapMethodInfo Memory signature Source 

memoryUnmap :: MonadIO m => Memory -> MapInfo -> m () Source

Properties

Align

memoryReadAlign :: Memory -> IO Word64 Source

Allocator

memoryReadAllocator :: Memory -> IO Allocator Source

Maxsize

memoryReadMaxsize :: Memory -> IO Word64 Source

MiniObject

memoryReadMiniObject :: Memory -> IO MiniObject Source

Offset

memoryReadOffset :: Memory -> IO Word64 Source

Parent

memoryReadParent :: Memory -> IO Memory Source

Size

memoryReadSize :: Memory -> IO Word64 Source