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.GstVideo.Interfaces.ColorBalance

Contents

Exported types
Methods
Signals
- valueChanged

Description

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'

Synopsis

newtype ColorBalance = ColorBalance (ManagedPtr ColorBalance)
noColorBalance :: Maybe ColorBalance
class (GObject o, IsDescendantOf ColorBalance o) => IsColorBalance o
toColorBalance :: (MonadIO m, IsColorBalance o) => o -> m ColorBalance
colorBalanceGetBalanceType :: (HasCallStack, MonadIO m, IsColorBalance a) => a -> m ColorBalanceType
colorBalanceGetValue :: (HasCallStack, MonadIO m, IsColorBalance a, IsColorBalanceChannel b) => a -> b -> m Int32
colorBalanceListChannels :: (HasCallStack, MonadIO m, IsColorBalance a) => a -> m [ColorBalanceChannel]
colorBalanceSetValue :: (HasCallStack, MonadIO m, IsColorBalance a, IsColorBalanceChannel b) => a -> b -> Int32 -> m ()
colorBalanceValueChanged :: (HasCallStack, MonadIO m, IsColorBalance a, IsColorBalanceChannel b) => a -> b -> Int32 -> m ()
type C_ColorBalanceValueChangedCallback = Ptr () -> Ptr ColorBalanceChannel -> Int32 -> Ptr () -> IO ()
type ColorBalanceValueChangedCallback = ColorBalanceChannel -> Int32 -> IO ()
afterColorBalanceValueChanged :: (IsColorBalance a, MonadIO m) => a -> ColorBalanceValueChangedCallback -> m SignalHandlerId
genClosure_ColorBalanceValueChanged :: MonadIO m => ColorBalanceValueChangedCallback -> m (GClosure C_ColorBalanceValueChangedCallback)
mk_ColorBalanceValueChangedCallback :: C_ColorBalanceValueChangedCallback -> IO (FunPtr C_ColorBalanceValueChangedCallback)
noColorBalanceValueChangedCallback :: Maybe ColorBalanceValueChangedCallback
onColorBalanceValueChanged :: (IsColorBalance a, MonadIO m) => a -> ColorBalanceValueChangedCallback -> m SignalHandlerId
wrap_ColorBalanceValueChangedCallback :: ColorBalanceValueChangedCallback -> C_ColorBalanceValueChangedCallback

Exported types

newtype ColorBalance Source #

Memory-managed wrapper type.

Constructors

ColorBalance (ManagedPtr ColorBalance)

Instances

GObject ColorBalance Source #
Instance details Defined in GI.GstVideo.Interfaces.ColorBalance Methods gobjectType :: IO GType #
HasParentTypes ColorBalance Source #
Instance details Defined in GI.GstVideo.Interfaces.ColorBalance
type ParentTypes ColorBalance Source #
Instance details Defined in GI.GstVideo.Interfaces.ColorBalance type ParentTypes ColorBalance = Object ': ([] :: [Type])

noColorBalance :: Maybe ColorBalance Source #

A convenience alias for Nothing :: Maybe ColorBalance.

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

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

Instances

(GObject o, IsDescendantOf ColorBalance o) => IsColorBalance o Source #
Instance details Defined in GI.GstVideo.Interfaces.ColorBalance

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

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

Methods

getBalanceType

colorBalanceGetBalanceType Source #

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

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

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

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

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 ColorBalance::value-changed signal on the instance, and the ColorBalanceChannel::value-changed signal on the channel object.

Signals

valueChanged

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

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

type ColorBalanceValueChangedCallback Source #

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

Connect a signal handler for the “value-changed” 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) Source #

Wrap the callback into a GClosure.

mk_ColorBalanceValueChangedCallback :: C_ColorBalanceValueChangedCallback -> IO (FunPtr C_ColorBalanceValueChangedCallback) Source #

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

noColorBalanceValueChangedCallback :: Maybe ColorBalanceValueChangedCallback Source #

A convenience synonym for Nothing :: Maybe ColorBalanceValueChangedCallback.

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

Connect a signal handler for the “value-changed” 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 Source #

Wrap a ColorBalanceValueChangedCallback into a C_ColorBalanceValueChangedCallback.