gi-clutter-1.0.2: clutter GObject bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.Clutter.Objects.KeyframeTransition

Description

The ClutterKeyframeTransition structure contains only private data and should be accessed using the provided API.

Since: 1.12

Synopsis

Exported types

class (GObject o, IsDescendantOf KeyframeTransition o) => IsKeyframeTransition o Source #

Type class for types which can be safely cast to KeyframeTransition, for instance with toKeyframeTransition.

Instances

Instances details
(GObject o, IsDescendantOf KeyframeTransition o) => IsKeyframeTransition o Source # 
Instance details

Defined in GI.Clutter.Objects.KeyframeTransition

toKeyframeTransition :: (MonadIO m, IsKeyframeTransition o) => o -> m KeyframeTransition Source #

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

Methods

clear

keyframeTransitionClear Source #

Arguments

:: (HasCallStack, MonadIO m, IsKeyframeTransition a) 
=> a

transition: a KeyframeTransition

-> m () 

Removes all key frames from transition.

Since: 1.12

getKeyFrame

keyframeTransitionGetKeyFrame Source #

Arguments

:: (HasCallStack, MonadIO m, IsKeyframeTransition a) 
=> a

transition: a KeyframeTransition

-> Word32

index_: the index of the key frame

-> m (Double, AnimationMode, GValue) 

Retrieves the details of the key frame at index_ inside transition.

The transition must already have key frames set, and index_ must be smaller than the number of key frames.

Since: 1.12

getNKeyFrames

keyframeTransitionGetNKeyFrames Source #

Arguments

:: (HasCallStack, MonadIO m, IsKeyframeTransition a) 
=> a

transition: a KeyframeTransition

-> m Word32

Returns: the number of key frames

Retrieves the number of key frames inside transition.

Since: 1.12

new

keyframeTransitionNew Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Text

propertyName: the property to animate

-> m KeyframeTransition

Returns: the newly allocated KeyframeTransition instance. Use objectUnref when done to free its resources.

Creates a new KeyframeTransition for propertyName.

Since: 1.12

setKeyFrame

keyframeTransitionSetKeyFrame Source #

Arguments

:: (HasCallStack, MonadIO m, IsKeyframeTransition a) 
=> a

transition: a KeyframeTransition

-> Word32

index_: the index of the key frame

-> Double

key: the key of the key frame

-> AnimationMode

mode: the easing mode of the key frame

-> GValue

value: a Value containing the value of the key frame

-> m () 

Sets the details of the key frame at index_ inside transition.

The transition must already have a key frame at index_, and index_ must be smaller than the number of key frames inside transition.

Since: 1.12

setKeyFrames

keyframeTransitionSetKeyFrames Source #

Arguments

:: (HasCallStack, MonadIO m, IsKeyframeTransition a) 
=> a

transition: a KeyframeTransition

-> [Double]

keyFrames: an array of keys between 0.0 and 1.0, one for each key frame

-> m () 

Sets the keys for each key frame inside transition.

If transition does not hold any key frame, nKeyFrames key frames will be created; if transition already has key frames, keyFrames must have at least as many elements as the number of key frames.

Since: 1.12

setModes

keyframeTransitionSetModes Source #

Arguments

:: (HasCallStack, MonadIO m, IsKeyframeTransition a) 
=> a

transition: a KeyframeTransition

-> [AnimationMode]

modes: an array of easing modes, one for each key frame

-> m () 

Sets the easing modes for each key frame inside transition.

If transition does not hold any key frame, nModes key frames will be created; if transition already has key frames, modes must have at least as many elements as the number of key frames.

Since: 1.12

setValues

keyframeTransitionSetValues Source #

Arguments

:: (HasCallStack, MonadIO m, IsKeyframeTransition a) 
=> a

transition: a KeyframeTransition

-> [GValue]

values: an array of values, one for each key frame

-> m () 

Sets the values for each key frame inside transition.

If transition does not hold any key frame, nValues key frames will be created; if transition already has key frames, values must have at least as many elements as the number of key frames.

Since: 1.12