Copyright	Will Thompson Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria ([email protected])
Safe Haskell	None
Language	Haskell2010

GI.Gst.Structs.AllocationParams

Contents

Exported types
Methods
Properties

Description

Parameters to control the allocation of memory

Synopsis

newtype AllocationParams = AllocationParams (ManagedPtr AllocationParams)
newZeroAllocationParams :: MonadIO m => m AllocationParams
noAllocationParams :: Maybe AllocationParams
allocationParamsCopy :: (HasCallStack, MonadIO m) => AllocationParams -> m (Maybe AllocationParams)
allocationParamsFree :: (HasCallStack, MonadIO m) => AllocationParams -> m ()
allocationParamsInit :: (HasCallStack, MonadIO m) => AllocationParams -> m ()
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.

Constructors

AllocationParams (ManagedPtr AllocationParams)

Instances

BoxedObject AllocationParams Source #
Instance details Defined in GI.Gst.Structs.AllocationParams Methods boxedType :: AllocationParams -> IO GType #
tag ~ AttrSet => Constructible AllocationParams tag Source #
Instance details Defined in GI.Gst.Structs.AllocationParams Methods new :: MonadIO m => (ManagedPtr AllocationParams -> AllocationParams) -> [AttrOp AllocationParams tag] -> m AllocationParams #

newZeroAllocationParams :: MonadIO m => m AllocationParams Source #

Construct a AllocationParams struct initialized to zero.

noAllocationParams :: Maybe AllocationParams Source #

A convenience alias for Nothing :: Maybe AllocationParams.

Methods

copy

allocationParamsCopy Source #

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 Source #

Arguments

:: (HasCallStack, MonadIO m)
=> AllocationParams	`params`: a `AllocationParams`
-> m ()

Free params

init

allocationParamsInit Source #

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 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 ]