NAME¶

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

HEADER FILE¶

Defined in SDL3/SDL_system.h

SYNOPSIS¶

#include "SDL3/SDL.h"

int SDL_iOSSetAnimationCallback(SDL_Window * window, int interval, void (SDLCALL *callback)(void*), void *callbackParam);

DESCRIPTION¶

The function prototype for callback is:

c void callback(void* callbackParam);

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

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

FUNCTION 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 0 on success or a negative error code on failure; call

SDL_GetError () for more information.

AVAILABILITY¶

This function is available since SDL 3.0.0.

SEE ALSO¶

SDL_iOSSetEventPump(3)