|
Size: 157
Comment: Added version info.
|
Size: 2434
Comment: Created complete page using content from header file.
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 3: | Line 3: |
| ||<tablewidth="100%" style="color: #FF0000;" :> DRAFT|| | |
| Line 4: | Line 5: |
| SDL_iPhoneSetAnimationCallback() has been replaced by [[SDL_iOSSetAnimationCallback]]() in SDL 2.0.4. | ##You will need to remove the line #acl All:read above in order to be able to save the new page. Do not remove any other content above this comment. You may delete this comment before you save. ##*^*^*^*^*See http://wiki.libsdl.org/moin.cgi/SGFunctions for details on editing this page*^*^*^*^* = SDL_iPhoneSetAnimationCallback = Use this function to set the animation callback on Apple iOS. <<TableOfContents()>> == Syntax == {{{#!highlight cpp int SDL_iPhoneSetAnimationCallback(SDL_Window* window, int interval, void (*callback)(void*), void* callbackParam) }}} == 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; see [[#Remarks|Remarks]] for details|| ||'''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. == Code Examples == {{{#!highlight cpp You can add your code example here }}} ##Leave this section as-is unless you have a code example to put in. In that case, replace You can add your code example here with your code example following the Style Guide instructions. Leave the rest of the markup alone and delete this comment. == Remarks == The function prototype for '''callback''' is: {{{#!highlight cpp void callback(void* callbackParam) }}} . where its parameters are: ||`callbackParam`||what was passed as '''callbackParam''' to [[SDL_iPhoneSetAnimationCallback]]()|| This function is only available on Apple iOS. For more information see: [[https://hg.libsdl.org/SDL/file/default/docs/README-ios.md|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. == Related Functions == .[[SDL_iPhoneSetEventPump]] ##Remove this section if empty ---- [[CategoryAPI]], [[CategorySystem]] ##See the Style Guide for instructions on editing the footer. |
DRAFT |
SDL_iPhoneSetAnimationCallback
Use this function to set the animation callback on Apple iOS.
Contents
Syntax
int SDL_iPhoneSetAnimationCallback(SDL_Window* window,
int interval,
void (*callback)(void*),
void* callbackParam)
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; see Remarks for details |
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.
Code Examples
You can add your code example here
Remarks
The function prototype for callback is:
void callback(void* callbackParam)- where its parameters are:
callbackParam
what was passed as callbackParam to SDL_iPhoneSetAnimationCallback()
This function is only available on Apple iOS.
For more information see: 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.
