|
Size: 1586
Comment: update content for consistency - callback (table); camelcase
|
← Revision 7 as of 2013-08-08 22:36:07 ⇥
Size: 983
Comment: Edited
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 3: | Line 3: |
| ||<tablewidth="100%" style="color: #FF0000;" :> DRAFT|| | |
| Line 6: | Line 5: |
| Use this function to return the current event filter. | Use this function to query the current event filter. |
| Line 17: | Line 16: |
| ||'''filter'''||the callback function to get; see [[#Remarks|Remarks]] for details|| ||'''userdata'''||a pointer to a pointer that is passed to '''filter'''|| |
||'''filter'''||the current callback function will be stored here; see [[#Remarks|Remarks]] for details|| ||'''userdata'''||the pointer that is passed to the current event filter will be stored here|| |
| Line 21: | Line 20: |
| Returns SDL_TRUE on success or SDL_FALSE if there is no event filter set,,; call [[SDL_GetError]]() for more information.,, <<Color2(green,The header says it "Returns the current event filter" but I suspect this isn't referring to the actual return value but the output of the function. Should that be included here?)>> |
Returns SDL_TRUE on success or SDL_FALSE if there is no event filter set. |
| Line 31: | Line 28: |
| This function can be used to "chain" filters. <<Color2(green,Should the following be included here as it is in [[SDL_SetEventFilter]]()? Right now this is different.)>> The function prototype for '''filter''' is: {{{ int SDL_EventFilter(void* userdata, SDL_Event* event) }}} . where its parameters are: ||`userdata`||what was passed as '''userdata''' to [[SDL_GetEventFilter]]()|| ||`event`||the desired event to query from the queue ???|| |
This function can be used to "chain" filters, by saving the existing filter before replacing it with a function that will call that saved filter. |
SDL_GetEventFilter
Use this function to query the current event filter.
Contents
Syntax
SDL_bool SDL_GetEventFilter(SDL_EventFilter* filter,
void** userdata)
Function Parameters
filter |
the current callback function will be stored here; see Remarks for details |
userdata |
the pointer that is passed to the current event filter will be stored here |
Return Value
Returns SDL_TRUE on success or SDL_FALSE if there is no event filter set.
Code Examples
You can add your code example here
Remarks
This function can be used to "chain" filters, by saving the existing filter before replacing it with a function that will call that saved filter.
