GI.Clutter.Structs.AnimatorKey

A key frame inside a Animator

Since: 1.2

Exported types

newtype AnimatorKey

Memory-managed wrapper type.

Constructors

AnimatorKey (ManagedPtr AnimatorKey)

Instances

Eq AnimatorKey

Defined in GI.Clutter.Structs.AnimatorKey

Methods

(==) :: AnimatorKey -> AnimatorKey -> Bool

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

GBoxed AnimatorKey

Defined in GI.Clutter.Structs.AnimatorKey

ManagedPtrNewtype AnimatorKey

Defined in GI.Clutter.Structs.AnimatorKey

Methods

toManagedPtr :: AnimatorKey -> ManagedPtr AnimatorKey

TypedObject AnimatorKey

Defined in GI.Clutter.Structs.AnimatorKey

Methods

glibType :: IO GType

HasParentTypes AnimatorKey

Defined in GI.Clutter.Structs.AnimatorKey

IsGValue (Maybe AnimatorKey)

Convert AnimatorKey to and from GValue. See toGValue and fromGValue.

Defined in GI.Clutter.Structs.AnimatorKey

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe AnimatorKey -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe AnimatorKey)

type ParentTypes AnimatorKey

Defined in GI.Clutter.Structs.AnimatorKey

type ParentTypes AnimatorKey = '[] :: [Type]

Methods

Click to display all available methods, including inherited ones

Methods

None.

Getters

getMode, getObject, getProgress, getPropertyName, getPropertyType, getValue.

Setters

None.

getMode

animatorKeyGetMode

Arguments

:: (HasCallStack, MonadIO m)

=> AnimatorKey

key: a AnimatorKey

-> m CULong

Returns: the mode of a AnimatorKey

Deprecated: (Since version 1.12)Use KeyframeTransition instead

Retrieves the mode of a Animator key, for the first key of a property for an object this represents the whether the animation is open ended and or curved for the remainding keys for the property it represents the easing mode.

Since: 1.2

getObject

animatorKeyGetObject

Arguments

:: (HasCallStack, MonadIO m)

=> AnimatorKey

key: a AnimatorKey

-> m Object

Returns: the object an animator_key exist for.

Deprecated: (Since version 1.12)Use KeyframeTransition instead

Retrieves the object a key applies to.

Since: 1.2

getProgress

animatorKeyGetProgress

Arguments

:: (HasCallStack, MonadIO m)

=> AnimatorKey

key: a AnimatorKey

-> m Double

Returns: the progress defined for a Animator key.

Deprecated: (Since version 1.12)Use KeyframeTransition instead

Retrieves the progress of an clutter_animator_key

Since: 1.2

getPropertyName

animatorKeyGetPropertyName

Arguments

:: (HasCallStack, MonadIO m)

=> AnimatorKey

key: a AnimatorKey

-> m Text

Returns: the name of the property an animator_key exist for.

Deprecated: (Since version 1.12)Use KeyframeTransition instead

Retrieves the name of the property a key applies to.

Since: 1.2

getPropertyType

animatorKeyGetPropertyType

Arguments

:: (HasCallStack, MonadIO m)

=> AnimatorKey

key: a AnimatorKey

-> m GType

Returns: the GType of the property

Deprecated: (Since version 1.12)Use KeyframeTransition instead

Retrieves the GType of the property a key applies to

You can use this type to initialize the Value to pass to animatorKeyGetValue

Since: 1.2

getValue

animatorKeyGetValue

Arguments

:: (HasCallStack, MonadIO m)

=> AnimatorKey

key: a AnimatorKey

-> GValue

value: a Value initialized with the correct type for the animator key

-> m Bool

Returns: True if the passed Value was successfully set, and False otherwise

Deprecated: (Since version 1.12)Use KeyframeTransition instead

Retrieves a copy of the value for a AnimatorKey.

The passed in Value needs to be already initialized for the value type of the key or to a type that allow transformation from the value type of the key.

Use valueUnset when done.

Since: 1.2