GI.Gst.Structs.Memory

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.

Exported types

newtype Memory

Constructors

Memory (ManagedPtr Memory)

Instances

BoxedObject Memory

Methods

boxedType :: Memory -> IO GType

(~) AttrOpTag tag AttrSet => Constructible Memory tag

Methods

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

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

Methods

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

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

Methods

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

HasAttributeList * Memory

((~) * signature (MapInfo -> m ()), MonadIO m) => MethodInfo * MemoryUnmapMethodInfo Memory signature

Methods

overloadedMethod :: MethodProxy MemoryUnmapMethodInfo Memory -> signature -> s

((~) * signature (Int64 -> Int64 -> m Memory), MonadIO m) => MethodInfo * MemoryShareMethodInfo Memory signature

Methods

overloadedMethod :: MethodProxy MemoryShareMethodInfo Memory -> signature -> s

((~) * signature (Int64 -> Word64 -> m ()), MonadIO m) => MethodInfo * MemoryResizeMethodInfo Memory signature

Methods

overloadedMethod :: MethodProxy MemoryResizeMethodInfo Memory -> signature -> s

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

Methods

overloadedMethod :: MethodProxy MemoryMapMethodInfo Memory -> signature -> s

((~) * signature ([MapFlags] -> m (Maybe Memory, MapInfo)), MonadIO m) => MethodInfo * MemoryMakeMappedMethodInfo Memory signature

Methods

overloadedMethod :: MethodProxy MemoryMakeMappedMethodInfo Memory -> signature -> s

((~) * signature (Text -> m Bool), MonadIO m) => MethodInfo * MemoryIsTypeMethodInfo Memory signature

Methods

overloadedMethod :: MethodProxy MemoryIsTypeMethodInfo Memory -> signature -> s

((~) * signature (Memory -> Word64 -> m Bool), MonadIO m) => MethodInfo * MemoryIsSpanMethodInfo Memory signature

Methods

overloadedMethod :: MethodProxy MemoryIsSpanMethodInfo Memory -> signature -> s

((~) * signature (Word64 -> Word64 -> m Word64), MonadIO m) => MethodInfo * MemoryGetSizesMethodInfo Memory signature

Methods

overloadedMethod :: MethodProxy MemoryGetSizesMethodInfo Memory -> signature -> s

((~) * signature (Int64 -> Int64 -> m Memory), MonadIO m) => MethodInfo * MemoryCopyMethodInfo Memory signature

Methods

overloadedMethod :: MethodProxy MemoryCopyMethodInfo Memory -> signature -> s

type AttributeList Memory

type AttributeList Memory

newZeroMemory :: MonadIO m => m Memory

Construct a Memory struct initialized to zero.

noMemory :: Maybe Memory

Methods

copy

data MemoryCopyMethodInfo

Instances

((~) * signature (Int64 -> Int64 -> m Memory), MonadIO m) => MethodInfo * MemoryCopyMethodInfo Memory signature

Methods

overloadedMethod :: MethodProxy MemoryCopyMethodInfo Memory -> signature -> s

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

getSizes

data MemoryGetSizesMethodInfo

Instances

((~) * signature (Word64 -> Word64 -> m Word64), MonadIO m) => MethodInfo * MemoryGetSizesMethodInfo Memory signature

Methods

overloadedMethod :: MethodProxy MemoryGetSizesMethodInfo Memory -> signature -> s

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

isSpan

data MemoryIsSpanMethodInfo

Instances

((~) * signature (Memory -> Word64 -> m Bool), MonadIO m) => MethodInfo * MemoryIsSpanMethodInfo Memory signature

Methods

overloadedMethod :: MethodProxy MemoryIsSpanMethodInfo Memory -> signature -> s

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

isType

data MemoryIsTypeMethodInfo

Instances

((~) * signature (Text -> m Bool), MonadIO m) => MethodInfo * MemoryIsTypeMethodInfo Memory signature

Methods

overloadedMethod :: MethodProxy MemoryIsTypeMethodInfo Memory -> signature -> s

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

makeMapped

data MemoryMakeMappedMethodInfo

Instances

((~) * signature ([MapFlags] -> m (Maybe Memory, MapInfo)), MonadIO m) => MethodInfo * MemoryMakeMappedMethodInfo Memory signature

Methods

overloadedMethod :: MethodProxy MemoryMakeMappedMethodInfo Memory -> signature -> s

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

map

data MemoryMapMethodInfo

Instances

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

Methods

overloadedMethod :: MethodProxy MemoryMapMethodInfo Memory -> signature -> s

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

newWrapped

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

resize

data MemoryResizeMethodInfo

Instances

((~) * signature (Int64 -> Word64 -> m ()), MonadIO m) => MethodInfo * MemoryResizeMethodInfo Memory signature

Methods

overloadedMethod :: MethodProxy MemoryResizeMethodInfo Memory -> signature -> s

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

share

data MemoryShareMethodInfo

Instances

((~) * signature (Int64 -> Int64 -> m Memory), MonadIO m) => MethodInfo * MemoryShareMethodInfo Memory signature

Methods

overloadedMethod :: MethodProxy MemoryShareMethodInfo Memory -> signature -> s

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

unmap

data MemoryUnmapMethodInfo

Instances

((~) * signature (MapInfo -> m ()), MonadIO m) => MethodInfo * MemoryUnmapMethodInfo Memory signature

Methods

overloadedMethod :: MethodProxy MemoryUnmapMethodInfo Memory -> signature -> s

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

Properties

align

getMemoryAlign :: MonadIO m => Memory -> m Word64

memory_align :: AttrLabelProxy "align"

setMemoryAlign :: MonadIO m => Memory -> Word64 -> m ()

allocator

clearMemoryAllocator :: MonadIO m => Memory -> m ()

getMemoryAllocator :: MonadIO m => Memory -> m (Maybe Allocator)

memory_allocator :: AttrLabelProxy "allocator"

setMemoryAllocator :: MonadIO m => Memory -> Ptr Allocator -> m ()

maxsize

getMemoryMaxsize :: MonadIO m => Memory -> m Word64

memory_maxsize :: AttrLabelProxy "maxsize"

setMemoryMaxsize :: MonadIO m => Memory -> Word64 -> m ()

miniObject

getMemoryMiniObject :: MonadIO m => Memory -> m MiniObject

memory_miniObject :: AttrLabelProxy "miniObject"

offset

getMemoryOffset :: MonadIO m => Memory -> m Word64

memory_offset :: AttrLabelProxy "offset"

setMemoryOffset :: MonadIO m => Memory -> Word64 -> m ()

parent

clearMemoryParent :: MonadIO m => Memory -> m ()

getMemoryParent :: MonadIO m => Memory -> m (Maybe Memory)

memory_parent :: AttrLabelProxy "parent"

setMemoryParent :: MonadIO m => Memory -> Ptr Memory -> m ()

size

getMemorySize :: MonadIO m => Memory -> m Word64

memory_size :: AttrLabelProxy "size"

setMemorySize :: MonadIO m => Memory -> Word64 -> m ()