Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- newtype Alpha = Alpha (ManagedPtr Alpha)
- class (GObject o, IsDescendantOf Alpha o) => IsAlpha o
- toAlpha :: (MonadIO m, IsAlpha o) => o -> m Alpha
- alphaGetAlpha :: (HasCallStack, MonadIO m, IsAlpha a) => a -> m Double
- alphaGetMode :: (HasCallStack, MonadIO m, IsAlpha a) => a -> m CULong
- alphaGetTimeline :: (HasCallStack, MonadIO m, IsAlpha a) => a -> m Timeline
- alphaNew :: (HasCallStack, MonadIO m) => m Alpha
- alphaNewFull :: (HasCallStack, MonadIO m, IsTimeline a) => a -> CULong -> m Alpha
- alphaNewWithFunc :: (HasCallStack, MonadIO m, IsTimeline a) => a -> AlphaFunc -> m Alpha
- alphaRegisterFunc :: (HasCallStack, MonadIO m) => GClosure a -> m CULong
- alphaSetClosure :: (HasCallStack, MonadIO m, IsAlpha a) => a -> GClosure b -> m ()
- alphaSetFunc :: (HasCallStack, MonadIO m, IsAlpha a) => a -> AlphaFunc -> m ()
- alphaSetMode :: (HasCallStack, MonadIO m, IsAlpha a) => a -> CULong -> m ()
- alphaSetTimeline :: (HasCallStack, MonadIO m, IsAlpha a, IsTimeline b) => a -> b -> m ()
- getAlphaAlpha :: (MonadIO m, IsAlpha o) => o -> m Double
- constructAlphaMode :: (IsAlpha o, MonadIO m) => CULong -> m (GValueConstruct o)
- getAlphaMode :: (MonadIO m, IsAlpha o) => o -> m CULong
- setAlphaMode :: (MonadIO m, IsAlpha o) => o -> CULong -> m ()
- constructAlphaTimeline :: (IsAlpha o, MonadIO m, IsTimeline a) => a -> m (GValueConstruct o)
- getAlphaTimeline :: (MonadIO m, IsAlpha o) => o -> m Timeline
- setAlphaTimeline :: (MonadIO m, IsAlpha o, IsTimeline a) => o -> a -> m ()
Exported types
Memory-managed wrapper type.
Instances
Eq Alpha Source # | |
GObject Alpha Source # | |
Defined in GI.Clutter.Objects.Alpha | |
ManagedPtrNewtype Alpha Source # | |
Defined in GI.Clutter.Objects.Alpha toManagedPtr :: Alpha -> ManagedPtr Alpha | |
TypedObject Alpha Source # | |
Defined in GI.Clutter.Objects.Alpha | |
HasParentTypes Alpha Source # | |
Defined in GI.Clutter.Objects.Alpha | |
IsGValue (Maybe Alpha) Source # | Convert |
Defined in GI.Clutter.Objects.Alpha gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe Alpha -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe Alpha) | |
type ParentTypes Alpha Source # | |
Defined in GI.Clutter.Objects.Alpha |
class (GObject o, IsDescendantOf Alpha o) => IsAlpha o Source #
Instances
(GObject o, IsDescendantOf Alpha o) => IsAlpha o Source # | |
Defined in GI.Clutter.Objects.Alpha |
Methods
Click to display all available methods, including inherited ones
Methods
bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, parseCustomNode, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.
Getters
getAlpha, getData, getId, getMode, getProperty, getQdata, getTimeline.
Setters
setClosure, setCustomProperty, setData, setDataFull, setFunc, setId, setMode, setProperty, setTimeline.
getAlpha
:: (HasCallStack, MonadIO m, IsAlpha a) | |
=> a |
|
-> m Double | Returns: The current alpha value for the alpha |
getMode
:: (HasCallStack, MonadIO m, IsAlpha a) | |
=> a |
|
-> m CULong | Returns: the animation mode |
Deprecated: (Since version 1.12)Use Timeline
instead
Retrieves the AnimationMode
used by alpha
.
Since: 1.0
getTimeline
new
:: (HasCallStack, MonadIO m) | |
=> m Alpha | Returns: the newly created empty |
Deprecated: (Since version 1.12)Use Timeline
instead
Creates a new Alpha
instance. You must set a function
to compute the alpha value using alphaSetFunc
and
bind a Timeline
object to the Alpha
instance
using alphaSetTimeline
.
You should use the newly created Alpha
instance inside
a Behaviour
object.
Since: 0.2
newFull
:: (HasCallStack, MonadIO m, IsTimeline a) | |
=> a |
|
-> CULong |
|
-> m Alpha | Returns: the newly created |
Deprecated: (Since version 1.12)Use Timeline
instead
Creates a new Alpha
instance and sets the timeline
and animation mode.
See also alphaSetTimeline
and alphaSetMode
.
Since: 1.0
newWithFunc
:: (HasCallStack, MonadIO m, IsTimeline a) | |
=> a |
|
-> AlphaFunc |
|
-> m Alpha | Returns: the newly created |
Deprecated: (Since version 1.12)Use Timeline
instead
Creates a new Alpha
instances and sets the timeline
and the alpha function.
This function will not register func
as a global alpha function.
See also alphaSetTimeline
and alphaSetFunc
.
Since: 1.0
registerFunc
:: (HasCallStack, MonadIO m) | |
=> GClosure a |
|
-> m CULong | Returns: the logical id of the alpha function |
Deprecated: (Since version 1.12)There is no direct replacement for this function. Use timelineSetProgressFunc
on each specific Timeline
instance
Closure
variant of clutter_alpha_register_func()
.
Registers a global alpha function and returns its logical id
to be used by alphaSetMode
or by Animation
.
The logical id is always greater than AnimationModeAnimationLast
.
Since: 1.0
setClosure
:: (HasCallStack, MonadIO m, IsAlpha a) | |
=> a |
|
-> GClosure b |
|
-> m () |
Deprecated: (Since version 1.12)Use timelineSetProgressFunc
Sets the Closure
used to compute the alpha value at each
frame of the Timeline
bound to alpha
.
Since: 0.8
setFunc
Deprecated: (Since version 1.12)Use timelineSetProgressFunc
Sets the AlphaFunc
function used to compute
the alpha value at each frame of the Timeline
bound to alpha
.
This function will not register func
as a global alpha function.
Since: 0.2
setMode
:: (HasCallStack, MonadIO m, IsAlpha a) | |
=> a |
|
-> CULong |
|
-> m () |
Deprecated: (Since version 1.12)Use Timeline
and timelineSetProgressMode
instead
Sets the progress function of alpha
using the symbolic value
of mode
, as taken by the AnimationMode
enumeration or
using the value returned by clutter_alpha_register_func()
.
Since: 1.0
setTimeline
:: (HasCallStack, MonadIO m, IsAlpha a, IsTimeline b) | |
=> a |
|
-> b |
|
-> m () |
Properties
alpha
The alpha value as computed by the alpha function. The linear interval is 0.0 to 1.0, but the Alpha allows overshooting by one unit in each direction, so the valid interval is -1.0 to 2.0.
Since: 0.2
getAlphaAlpha :: (MonadIO m, IsAlpha o) => o -> m Double Source #
Get the value of the “alpha
” property.
When overloading is enabled, this is equivalent to
get
alpha #alpha
mode
The progress function logical id - either a value from the
AnimationMode
enumeration or a value returned by
clutter_alpha_register_func()
.
If AnimationModeCustomMode
is used then the function set using
alphaSetClosure
or alphaSetFunc
will be used.
Since: 1.0
constructAlphaMode :: (IsAlpha o, MonadIO m) => CULong -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “mode
” property. This is rarely needed directly, but it is used by new
.
getAlphaMode :: (MonadIO m, IsAlpha o) => o -> m CULong Source #
Get the value of the “mode
” property.
When overloading is enabled, this is equivalent to
get
alpha #mode
setAlphaMode :: (MonadIO m, IsAlpha o) => o -> CULong -> m () Source #
Set the value of the “mode
” property.
When overloading is enabled, this is equivalent to
set
alpha [ #mode:=
value ]
timeline
A Timeline
instance used to drive the alpha function.
Since: 0.2
constructAlphaTimeline :: (IsAlpha o, MonadIO m, IsTimeline a) => a -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “timeline
” property. This is rarely needed directly, but it is used by new
.
getAlphaTimeline :: (MonadIO m, IsAlpha o) => o -> m Timeline Source #
Get the value of the “timeline
” property.
When overloading is enabled, this is equivalent to
get
alpha #timeline
setAlphaTimeline :: (MonadIO m, IsAlpha o, IsTimeline a) => o -> a -> m () Source #
Set the value of the “timeline
” property.
When overloading is enabled, this is equivalent to
set
alpha [ #timeline:=
value ]