|
Size: 1904
Comment: minor change - add question to address w/ edits
|
Size: 2142
Comment: update content (in progress)
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 21: | Line 21: |
| Returns an [[SDL_assert_state]] value of how to handle the assertion failure. <<Color2(green,This seems to be the RV for the callback. Since this function has a void RV. Should it be listed here anyway?)>> |
Returns a value from the callback. ??? or delete this section? |
| Line 33: | Line 31: |
| '''handler''' calls the following callback function: | '''handler''' has the following form: |
| Line 38: | Line 36: |
| <<Color2(green,Should this be formatted like a regular function?)>> . where `(SDLCALL *SDL_AssertionHandler)` is the name of the callback, `data` is a pointer to an [[SDL_assert_data]] struct, and `userdata` takes what is passed in '''userdata'''. <<Color2(green,Should the callback info be described here?)>> .The callback returns an [[SDL_assert_state]] value of how to handle the assertion failure. |
|
| Line 39: | Line 41: |
| <<Color2(green,Should the callback params be described here? ie: where `SDL_assert_data` is <something> and `userdata` is <something>.)>> | <<Color2(green,This seems to be the RV for the callback. Since this function has a void RV. Should it be listed here anyway?)>> |
DRAFT |
SDL_SetAssertionHandler
Use this function to set an application-defined assertion handler.
Contents
Syntax
void SDL_SetAssertionHandler(SDL_AssertionHandler handler,
void* userdata)
Function Parameters
handler |
the callback function called when an assertion fails; see Remarks for details |
userdata |
a pointer passed to the callback as-is |
Return Value
Returns a value from the callback. ??? or delete this section?
Code Examples
You can add your code example here
Remarks
This function allows an app to show its own assertion UI and/or force the response to an assertion failure. If the app doesn't provide this, SDL will try to do the right thing, popping up a system-specific GUI dialog, and probably minimizing any fullscreen windows.
handler has the following form:
SDL_assert_state (SDLCALL *SDL_AssertionHandler)( const SDL_assert_data*, void* userdata)
green
where (SDLCALL *SDL_AssertionHandler) is the name of the callback, data is a pointer to an SDL_assert_data struct, and userdata takes what is passed in userdata.
green
The callback returns an SDL_assert_state value of how to handle the assertion failure.
green
This callback may fire from any thread, but it runs wrapped in a mutex, so it will only fire from one thread at a time.
Setting the callback to NULL restores SDL's original internal handler.
This callback is NOT reset to SDL's internal handler upon SDL_Quit()!
