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 |
Parameters to control the allocation of memory
Synopsis
- newtype AllocationParams = AllocationParams (ManagedPtr AllocationParams)
- newZeroAllocationParams :: MonadIO m => m AllocationParams
- allocationParamsCopy :: (HasCallStack, MonadIO m) => AllocationParams -> m (Maybe AllocationParams)
- allocationParamsFree :: (HasCallStack, MonadIO m) => AllocationParams -> m ()
- allocationParamsInit :: (HasCallStack, MonadIO m) => AllocationParams -> m ()
- allocationParamsNew :: (HasCallStack, MonadIO m) => m AllocationParams
- getAllocationParamsAlign :: MonadIO m => AllocationParams -> m Word64
- setAllocationParamsAlign :: MonadIO m => AllocationParams -> Word64 -> m ()
- getAllocationParamsFlags :: MonadIO m => AllocationParams -> m [MemoryFlags]
- setAllocationParamsFlags :: MonadIO m => AllocationParams -> [MemoryFlags] -> m ()
- getAllocationParamsPadding :: MonadIO m => AllocationParams -> m Word64
- setAllocationParamsPadding :: MonadIO m => AllocationParams -> Word64 -> m ()
- getAllocationParamsPrefix :: MonadIO m => AllocationParams -> m Word64
- setAllocationParamsPrefix :: MonadIO m => AllocationParams -> Word64 -> m ()
Exported types
newtype AllocationParams Source #
Memory-managed wrapper type.
AllocationParams (ManagedPtr AllocationParams) |
Instances
newZeroAllocationParams :: MonadIO m => m AllocationParams Source #
Construct a AllocationParams
struct initialized to zero.
Methods
Click to display all available methods, including inherited ones
copy
:: (HasCallStack, MonadIO m) | |
=> AllocationParams |
|
-> m (Maybe AllocationParams) | Returns: a new |
Create a copy of params
.
free
:: (HasCallStack, MonadIO m) | |
=> AllocationParams |
|
-> m () |
Free params
init
:: (HasCallStack, MonadIO m) | |
=> AllocationParams |
|
-> m () |
Initialize params
to its default values
new
:: (HasCallStack, MonadIO m) | |
=> m AllocationParams | Returns: a new |
Create a new AllocationParams
on the heap. This function is for
use in GStreamer language bindings. In your own code, you can just
declare a AllocationParams
on the stack or in a struct, and
call allocationParamsInit
to initialize it.
You do not need to call allocationParamsInit
on the instance
returned by this function.
Since: 1.20
Properties
align
the desired alignment of the memory
getAllocationParamsAlign :: MonadIO m => AllocationParams -> m Word64 Source #
Get the value of the “align
” field.
When overloading is enabled, this is equivalent to
get
allocationParams #align
setAllocationParamsAlign :: MonadIO m => AllocationParams -> Word64 -> m () Source #
Set the value of the “align
” field.
When overloading is enabled, this is equivalent to
set
allocationParams [ #align:=
value ]
flags
flags to control allocation
getAllocationParamsFlags :: MonadIO m => AllocationParams -> m [MemoryFlags] Source #
Get the value of the “flags
” field.
When overloading is enabled, this is equivalent to
get
allocationParams #flags
setAllocationParamsFlags :: MonadIO m => AllocationParams -> [MemoryFlags] -> m () Source #
Set the value of the “flags
” field.
When overloading is enabled, this is equivalent to
set
allocationParams [ #flags:=
value ]
padding
the desired padding
getAllocationParamsPadding :: MonadIO m => AllocationParams -> m Word64 Source #
Get the value of the “padding
” field.
When overloading is enabled, this is equivalent to
get
allocationParams #padding
setAllocationParamsPadding :: MonadIO m => AllocationParams -> Word64 -> m () Source #
Set the value of the “padding
” field.
When overloading is enabled, this is equivalent to
set
allocationParams [ #padding:=
value ]
prefix
the desired prefix
getAllocationParamsPrefix :: MonadIO m => AllocationParams -> m Word64 Source #
Get the value of the “prefix
” field.
When overloading is enabled, this is equivalent to
get
allocationParams #prefix
setAllocationParamsPrefix :: MonadIO m => AllocationParams -> Word64 -> m () Source #
Set the value of the “prefix
” field.
When overloading is enabled, this is equivalent to
set
allocationParams [ #prefix:=
value ]