Wiki Page Content

Differences between revisions 4 and 5
Revision 4 as of 2010-10-11 05:18:11
Size: 1738
Editor: SheenaSmith
Comment: update content
Revision 5 as of 2010-10-18 04:38:27
Size: 1472
Editor: SheenaSmith
Comment: update content - SDL_EventFilter
Deletions are marked like this. Additions are marked like this.
Line 21: Line 21:
||'''filter'''||^the SDL_!EventFilter to be referenced/run ???^; see [[#Remarks|Remarks]] for details||
||'''userdata'''||^a pointer to the user-specified information to be filtered^||

<<Color2(green,There is currently no page for SDL_!EventFilter. Is it a macro or callback function? Should it be referenced in Remarks based on the [[SDL_SetEventFilter]]() info? See below...)>>

<<Color2(green,Is userdata an exception to the 'pointer rule'?)>>
||'''filter'''||a function that gets called when an event happens; see [[#Remarks|Remarks]] for details||
||'''userdata'''||^a pointer filled in with user-specified information to be filtered^||
Line 34: Line 30:
''You can add useful comments here''

SDL_!EventF
ilter has the following syntax:
{{{#!highlight cpp
int SDL_EventFilter(void*      userdata,                      SDL_Event* event)
The '''filter''' function has the following form:
{{{
int SDL_EventFilter(void* userdata, SDL_Event* event)
Line 42: Line 35:
<<Color2(green,Should this be formatted like the syntax section?)>>

DRAFT

SDL_FilterEvents

Use this function to run the filter function on the current event queue, removing any events for which the filter returns 0.

green

Use this function to filter the current event queue, removing any events for which the filter returns 0.

Syntax

void SDL_FilterEvents(SDL_EventFilter filter,
                      void*           userdata)

Function Parameters

filter

a function that gets called when an event happens; see Remarks for details

userdata

a pointer filled in with user-specified information to be filtered

Code Examples

You can add your code example here

Remarks

The filter function has the following form:

int SDL_EventFilter(void* userdata, SDL_Event* event)

where userdata is the event queue to filter and event is the desired event to pull from the queue. green

See SDL_SetEventFilter() for more information.


CategoryAPI, CategoryEvents

None: SDL_FilterEvents (last edited 2015-12-19 22:23:21 by PhilippWiesemann)

(Page Info.)
Feedback
Please include your contact information if you'd like to receive a reply.
Submit