GI.GstVideo.Interfaces.ColorBalance

This interface is implemented by elements which can perform some color balance operation on video frames they process. For example, modifying the brightness, contrast, hue or saturation.

Example elements are 'xvimagesink' and 'colorbalance'

Exported types

newtype ColorBalance

Memory-managed wrapper type.

Constructors

ColorBalance (ManagedPtr ColorBalance)

Instances

Eq ColorBalance

Defined in GI.GstVideo.Interfaces.ColorBalance

Methods

(==) :: ColorBalance -> ColorBalance -> Bool

(/=) :: ColorBalance -> ColorBalance -> Bool

GObject ColorBalance

Defined in GI.GstVideo.Interfaces.ColorBalance

Methods

gobjectType :: IO GType

IsGValue ColorBalance

Convert ColorBalance to and from GValue with toGValue and fromGValue.

Defined in GI.GstVideo.Interfaces.ColorBalance

Methods

toGValue :: ColorBalance -> IO GValue

fromGValue :: GValue -> IO ColorBalance

HasParentTypes ColorBalance

Defined in GI.GstVideo.Interfaces.ColorBalance

type ParentTypes ColorBalance

Defined in GI.GstVideo.Interfaces.ColorBalance

type ParentTypes ColorBalance = '[Object]

noColorBalance :: Maybe ColorBalance

A convenience alias for Nothing :: Maybe ColorBalance.

class (GObject o, IsDescendantOf ColorBalance o) => IsColorBalance o

Type class for types which can be safely cast to ColorBalance, for instance with toColorBalance.

Instances

(GObject o, IsDescendantOf ColorBalance o) => IsColorBalance o

Defined in GI.GstVideo.Interfaces.ColorBalance

toColorBalance :: (MonadIO m, IsColorBalance o) => o -> m ColorBalance

Cast to ColorBalance, for types for which this is known to be safe. For general casts, use castTo.

Methods

Overloaded methods

getBalanceType

colorBalanceGetBalanceType

Arguments

:: (HasCallStack, MonadIO m, IsColorBalance a)

=> a

balance: The ColorBalance implementation

-> m ColorBalanceType

Returns: A the ColorBalanceType.

Get the ColorBalanceType of this implementation.

getValue

colorBalanceGetValue

Arguments

:: (HasCallStack, MonadIO m, IsColorBalance a, IsColorBalanceChannel b)

=> a

balance: A ColorBalance instance

-> b

channel: A ColorBalanceChannel instance

-> m Int32

Returns: The current value of the channel.

Retrieve the current value of the indicated channel, between min_value and max_value.

See Also: The ColorBalanceChannel.min_value and ColorBalanceChannel.max_value members of the ColorBalanceChannel object.

listChannels

colorBalanceListChannels

Arguments

:: (HasCallStack, MonadIO m, IsColorBalance a)

=> a

balance: A ColorBalance instance

-> m [ColorBalanceChannel]

Returns: A GList containing pointers to ColorBalanceChannel objects. The list is owned by the ColorBalance instance and must not be freed.

Retrieve a list of the available channels.

setValue

colorBalanceSetValue

Arguments

:: (HasCallStack, MonadIO m, IsColorBalance a, IsColorBalanceChannel b)

=> a

balance: A ColorBalance instance

-> b

channel: A ColorBalanceChannel instance

-> Int32

value: The new value for the channel.

-> m ()

Sets the current value of the channel to the passed value, which must be between min_value and max_value.

See Also: The ColorBalanceChannel.min_value and ColorBalanceChannel.max_value members of the ColorBalanceChannel object.

valueChanged

colorBalanceValueChanged

Arguments

:: (HasCallStack, MonadIO m, IsColorBalance a, IsColorBalanceChannel b)

=> a

balance: A ColorBalance instance

-> b

channel: A ColorBalanceChannel whose value has changed

-> Int32

value: The new value of the channel

-> m ()

A helper function called by implementations of the GstColorBalance interface. It fires the valueChanged signal on the instance, and the valueChanged signal on the channel object.

Signals

valueChanged

type C_ColorBalanceValueChangedCallback = Ptr () -> Ptr ColorBalanceChannel -> Int32 -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type ColorBalanceValueChangedCallback

Arguments

 = ColorBalanceChannel

channel: The ColorBalanceChannel

-> Int32

value: The new value

-> IO ()

Fired when the value of the indicated channel has changed.

afterColorBalanceValueChanged :: (IsColorBalance a, MonadIO m) => a -> ColorBalanceValueChangedCallback -> m SignalHandlerId

Connect a signal handler for the valueChanged signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after colorBalance #valueChanged callback

genClosure_ColorBalanceValueChanged :: MonadIO m => ColorBalanceValueChangedCallback -> m (GClosure C_ColorBalanceValueChangedCallback)

Wrap the callback into a GClosure.

mk_ColorBalanceValueChangedCallback :: C_ColorBalanceValueChangedCallback -> IO (FunPtr C_ColorBalanceValueChangedCallback)

Generate a function pointer callable from C code, from a C_ColorBalanceValueChangedCallback.

noColorBalanceValueChangedCallback :: Maybe ColorBalanceValueChangedCallback

A convenience synonym for Nothing :: Maybe ColorBalanceValueChangedCallback.

onColorBalanceValueChanged :: (IsColorBalance a, MonadIO m) => a -> ColorBalanceValueChangedCallback -> m SignalHandlerId

Connect a signal handler for the valueChanged signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on colorBalance #valueChanged callback

wrap_ColorBalanceValueChangedCallback :: ColorBalanceValueChangedCallback -> C_ColorBalanceValueChangedCallback

Wrap a ColorBalanceValueChangedCallback into a C_ColorBalanceValueChangedCallback.