(This is the legacy documentation for SDL2, the previous stable version; SDL3 is the current stable version.)

SDL_iPhoneSetAnimationCallback

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

Header File

Syntax

int SDL_iPhoneSetAnimationCallback(SDL_Window * window, int interval, SDL_iOSAnimationCallback callback, void *callbackParam);


#define SDL_iOSSetAnimationCallback(window, interval, callback, callbackParam) SDL_iPhoneSetAnimationCallback(window, interval, callback, callbackParam)

Function Parameters

SDL_Window *	window	the window for which the animation callback should be set.
int	interval	the number of frames after which callback will be called.
SDL_iOSAnimationCallback	callback	the function to call for every frame.
void *	callbackParam	a pointer that is passed to `callback`.

Return Value

(int) Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.

Remarks

The function prototype for callback is:

void callback(void* callbackParam);

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

This function is only available on Apple iOS.

For more information see: https://github.com/libsdl-org/SDL/blob/main/docs/README-ios.md

This functions is also accessible using the macro SDL_iOSSetAnimationCallback() since SDL 2.0.4.

Version

This function is available since SDL 2.0.0.