Ecore Animator functions
[Ecore - Main Loop and Job Functions.]

Functions

EAPI Ecore_Animatorecore_animator_add (Ecore_Task_Cb func, const void *data)
 Add a animator to tick off at every animaton tick during main loop execution.
EAPI void * ecore_animator_del (Ecore_Animator *animator)
 Delete the specified animator from the animator list.
EAPI void ecore_animator_freeze (Ecore_Animator *animator)
 Suspend the specified animator.
EAPI void ecore_animator_thaw (Ecore_Animator *animator)
 Restore execution of the specified animator.
EAPI void ecore_animator_frametime_set (double frametime)
 Set the animator call interval in seconds.
EAPI double ecore_animator_frametime_get (void)
 Get the animator call interval in seconds.

Function Documentation

EAPI Ecore_Animator * ecore_animator_add ( Ecore_Task_Cb  func,
const void *  data 
)

Add a animator to tick off at every animaton tick during main loop execution.

Parameters:
func The function to call when it ticks off
data The data to pass to the function
Returns:
A handle to the new animator

This function adds a animator and returns its handle on success and NULL on failure. The function func will be called every N seconds where N is the frametime interval set by ecore_animator_frametime_set(). The function will be passed the data pointer as its parameter.

When the animator func is called, it must return a value of either 1 or 0. If it returns 1 (or ECORE_CALLBACK_RENEW), it will be called again at the next tick, or if it returns 0 (or ECORE_CALLBACK_CANCEL) it will be deleted automatically making any references/handles for it invalid.

References ecore_loop_time_get(), ecore_timer_delay(), and ecore_timer_loop_add().

Referenced by ecore_init().

EAPI void * ecore_animator_del ( Ecore_Animator animator  ) 

Delete the specified animator from the animator list.

Parameters:
animator The animator to delete
Returns:
The data pointer set for the animator

Delete the specified aqnimator from the set of animators that are executed during main loop execution. This function returns the data parameter that was being passed to the callback on success, or NULL on failure. After this call returns the specified animator object animator is invalid and should not be used again. It will not get called again after deletion.

EAPI double ecore_animator_frametime_get ( void   ) 

Get the animator call interval in seconds.

Returns:
The time in second in between animator ticks.

this function retrieves the time between animator ticks, in seconds.

EAPI void ecore_animator_frametime_set ( double  frametime  ) 

Set the animator call interval in seconds.

Parameters:
frametime The time in seconds in between animator ticks.

This function sets the time interval (in seconds) between animator ticks.

References ecore_timer_add(), and ecore_timer_del().

EAPI void ecore_animator_freeze ( Ecore_Animator animator  ) 

Suspend the specified animator.

Parameters:
animator The animator to delete

The specified animator will be temporarly removed from the set of animators that are executed during main loop execution.

EAPI void ecore_animator_thaw ( Ecore_Animator animator  ) 

Restore execution of the specified animator.

Parameters:
animator The animator to delete

The specified animator will be put back in the set of animators that are executed during main loop execution.