SDL_SetiOSAnimationCallback

sdl3_sys::system

Function SDL_SetiOSAnimationCallback 

Source 
pub unsafe extern "C" fn SDL_SetiOSAnimationCallback(
    window: *mut SDL_Window,
    interval: c_int,
    callback: SDL_iOSAnimationCallback,
    callbackParam: *mut c_void,
) -> bool
Expand description

Use this function to set the animation callback on Apple iOS.

The function prototype for callback is:

void callback(void *callbackParam);

Where its parameter, callbackParam, is what was passed as callbackParam to SDL_SetiOSAnimationCallback().

This function is only available on Apple iOS.

For more information see:

https://wiki.libsdl.org/SDL3/README-ios

Note that if you use the “main callbacks” instead of a standard C main function, you don’t have to use this API, as SDL will manage this for you.

Details on main callbacks are here:

https://wiki.libsdl.org/SDL3/README-main-functions

§Parameters

  • window: the window for which the animation callback should be set.
  • interval: the number of frames after which callback will be called.
  • callback: the function to call for every frame.
  • callbackParam: a pointer that is passed to callback.

§Return value

Returns true on success or false on failure; call SDL_GetError() for more information.

§Availability

This function is available since SDL 3.2.0.

§See also