gi-gst-1.0.25: GStreamer bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.Gst.Structs.AllocationParams

Description

Parameters to control the allocation of memory

Synopsis

Exported types

newtype AllocationParams Source #

Memory-managed wrapper type.

newZeroAllocationParams :: MonadIO m => m AllocationParams Source #

Construct a AllocationParams struct initialized to zero.

Methods

Click to display all available methods, including inherited ones

Expand

Methods

copy, free, init.

Getters

None.

Setters

None.

copy

allocationParamsCopy Source #

Create a copy of params.

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

new

allocationParamsNew Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> m AllocationParams

Returns: a new AllocationParams

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 ]