GI.Gst.Structs.AllocationParams

Parameters to control the allocation of memory

Exported types

newtype AllocationParams

Memory-managed wrapper type.

Constructors

AllocationParams (ManagedPtr AllocationParams)

Instances

BoxedObject AllocationParams

Defined in GI.Gst.Structs.AllocationParams

Methods

boxedType :: AllocationParams -> IO GType

tag ~ AttrSet => Constructible AllocationParams tag

Defined in GI.Gst.Structs.AllocationParams

Methods

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

newZeroAllocationParams :: MonadIO m => m AllocationParams

Construct a AllocationParams struct initialized to zero.

noAllocationParams :: Maybe AllocationParams

A convenience alias for Nothing :: Maybe AllocationParams.

Methods

copy

allocationParamsCopy

Arguments

:: (HasCallStack, MonadIO m)

=> AllocationParams

params: a AllocationParams

-> m (Maybe AllocationParams)

Returns: a new #AllocationParams, free with allocationParamsFree.

Create a copy of params.

Free-function: gst_allocation_params_free

free

allocationParamsFree

Arguments

:: (HasCallStack, MonadIO m)

=> AllocationParams

params: a AllocationParams

-> m ()

Free params

init

allocationParamsInit

Arguments

:: (HasCallStack, MonadIO m)

=> AllocationParams

params: a AllocationParams

-> m ()

Initialize params to its default values

Properties

align

the desired alignment of the memory

getAllocationParamsAlign :: MonadIO m => AllocationParams -> m Word64

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

get allocationParams #align

setAllocationParamsAlign :: MonadIO m => AllocationParams -> Word64 -> m ()

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]

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

get allocationParams #flags

setAllocationParamsFlags :: MonadIO m => AllocationParams -> [MemoryFlags] -> m ()

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

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

get allocationParams #padding

setAllocationParamsPadding :: MonadIO m => AllocationParams -> Word64 -> m ()

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

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

get allocationParams #prefix

setAllocationParamsPrefix :: MonadIO m => AllocationParams -> Word64 -> m ()

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

set allocationParams [ #prefix := value ]