sdlSetiOsAnimationCallback function

bool sdlSetiOsAnimationCallback(Pointer<SdlWindow> window, int interval, Pointer<NativeFunction<SdlIOsAnimationCallback>> callback, Pointer<NativeType> callbackParam,)

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

\param window the window for which the animation callback should be set. \param interval the number of frames after which callback will be called. \param callback the function to call for every frame. \param callbackParam a pointer that is passed to callback. \returns true on success or false on failure; call SDL_GetError() for more information.

\since This function is available since SDL 3.1.3.

\sa SDL_SetiOSEventPump

extern SDL_DECLSPEC bool SDLCALL SDL_SetiOSAnimationCallback(SDL_Window *window, int interval, SDL_iOSAnimationCallback callback, void *callbackParam)

Implementation

bool sdlSetiOsAnimationCallback(
    Pointer<SdlWindow> window,
    int interval,
    Pointer<NativeFunction<SdlIOsAnimationCallback>> callback,
    Pointer<NativeType> callbackParam) {
  final sdlSetiOsAnimationCallbackLookupFunction = libSdl3.lookupFunction<
      Uint8 Function(
          Pointer<SdlWindow> window,
          Int32 interval,
          Pointer<NativeFunction<SdlIOsAnimationCallback>> callback,
          Pointer<NativeType> callbackParam),
      int Function(
          Pointer<SdlWindow> window,
          int interval,
          Pointer<NativeFunction<SdlIOsAnimationCallback>> callback,
          Pointer<NativeType> callbackParam)>('SDL_SetiOSAnimationCallback');
  return sdlSetiOsAnimationCallbackLookupFunction(
          window, interval, callback, callbackParam) ==
      1;
}