| 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 |
GI.Gst.Structs.ParentBufferMeta
Description
The ParentBufferMeta is a Meta which can be attached to a Buffer
to hold a reference to another buffer that is only released when the child
Buffer is released.
Typically, ParentBufferMeta is used when the child buffer is directly
using the Memory of the parent buffer, and wants to prevent the parent
buffer from being returned to a buffer pool until the Memory is available
for re-use.
Since: 1.6
Synopsis
- newtype ParentBufferMeta = ParentBufferMeta (ManagedPtr ParentBufferMeta)
- newZeroParentBufferMeta :: MonadIO m => m ParentBufferMeta
- parentBufferMetaGetInfo :: (HasCallStack, MonadIO m) => m MetaInfo
- clearParentBufferMetaBuffer :: MonadIO m => ParentBufferMeta -> m ()
- getParentBufferMetaBuffer :: MonadIO m => ParentBufferMeta -> m (Maybe Buffer)
- setParentBufferMetaBuffer :: MonadIO m => ParentBufferMeta -> Ptr Buffer -> m ()
- getParentBufferMetaParent :: MonadIO m => ParentBufferMeta -> m Meta
Exported types
newtype ParentBufferMeta Source #
Memory-managed wrapper type.
Constructors
| ParentBufferMeta (ManagedPtr ParentBufferMeta) |
Instances
| Eq ParentBufferMeta Source # | |
Defined in GI.Gst.Structs.ParentBufferMeta Methods (==) :: ParentBufferMeta -> ParentBufferMeta -> Bool # (/=) :: ParentBufferMeta -> ParentBufferMeta -> Bool # | |
| BoxedPtr ParentBufferMeta Source # | |
Defined in GI.Gst.Structs.ParentBufferMeta Methods boxedPtrCopy :: ParentBufferMeta -> IO ParentBufferMeta boxedPtrFree :: ParentBufferMeta -> IO () | |
| CallocPtr ParentBufferMeta Source # | |
Defined in GI.Gst.Structs.ParentBufferMeta Methods | |
| ManagedPtrNewtype ParentBufferMeta Source # | |
Defined in GI.Gst.Structs.ParentBufferMeta Methods toManagedPtr :: ParentBufferMeta -> ManagedPtr ParentBufferMeta | |
| tag ~ 'AttrSet => Constructible ParentBufferMeta tag Source # | |
Defined in GI.Gst.Structs.ParentBufferMeta Methods new :: MonadIO m => (ManagedPtr ParentBufferMeta -> ParentBufferMeta) -> [AttrOp ParentBufferMeta tag] -> m ParentBufferMeta | |
newZeroParentBufferMeta :: MonadIO m => m ParentBufferMeta Source #
Construct a ParentBufferMeta struct initialized to zero.
Methods
getInfo
parentBufferMetaGetInfo Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => m MetaInfo | Returns: The |
Gets the global MetaInfo describing the ParentBufferMeta meta.
Since: 1.6
Properties
buffer
the Buffer on which a reference is being held.
clearParentBufferMetaBuffer :: MonadIO m => ParentBufferMeta -> m () Source #
Set the value of the “buffer” field to Nothing.
When overloading is enabled, this is equivalent to
clear #buffer
getParentBufferMetaBuffer :: MonadIO m => ParentBufferMeta -> m (Maybe Buffer) Source #
Get the value of the “buffer” field.
When overloading is enabled, this is equivalent to
get parentBufferMeta #buffer
setParentBufferMetaBuffer :: MonadIO m => ParentBufferMeta -> Ptr Buffer -> m () Source #
Set the value of the “buffer” field.
When overloading is enabled, this is equivalent to
setparentBufferMeta [ #buffer:=value ]
parent
the parent Meta structure
getParentBufferMetaParent :: MonadIO m => ParentBufferMeta -> m Meta Source #
Get the value of the “parent” field.
When overloading is enabled, this is equivalent to
get parentBufferMeta #parent