|
Size: 2388
Comment: add content from old wiki
|
Size: 2390
Comment: update content - changeset 4624
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 12: | Line 12: |
| Uint8 SDL_EventState(Uint8 type, int state) |
Uint8 SDL_EventState(Uint32 type, int state) |
| Line 23: | Line 23: |
| Returns an 8-bit bitmask of the current processing '''state''' (see [[#Remarks|Remarks]]), 1 if the event is processed successfully, 0 if it is ignored or disabled, or a negative error code on failure; call [[SDL_GetError]]() for more information. | Returns an 8-bit bitmask of the current processing '''state''' (see [[#Remarks|Remarks]]): 1 if the event is processed successfully, 0 if it is ignored or disabled, or a negative error code on failure; call [[SDL_GetError]]() for more information. |
DRAFT |
SDL_EventState
Use this function to set the state of processing certain events by '''type'''.
Contents
Syntax
Uint8 SDL_EventState(Uint32 type,
int state)
Function Parameters
type |
the type of event to be processed / regulated???; see [[SDL_Event]] for details |
state |
how to process the event '''type'''; see Remarks for details |
Return Value
green
Returns an 8-bit bitmask of the current processing state (see Remarks): 1 if the event is processed successfully, 0 if it is ignored or disabled, or a negative error code on failure; call SDL_GetError() for more information.
Code Examples
You can add your code example here
Remarks
state may be any of the following:
SDL_QUERY |
-1 |
returns the current processing state of the specified event type |
SDL_IGNORE |
0 |
the event type will automatically be dropped from the event queue and will not be filtered |
SDL_DISABLE |
0 |
same as SDL_IGNORE ??? the event '''type''' will not be processed ??? |
SDL_ENABLE |
1 |
the event type will be processed normally |
green
green
If state is set to SDL_IGNORE, that event will be automatically dropped from the event queue and will not event be filtered.
If state is set to SDL_ENABLE, that event will be processed normally.
If state is set to SDL_QUERY, SDL_EventState() will return the current processing state of the specified event.
green
SDL_EventState() must be called following the SDL_VideoInfo call. Otherwise the back-end data structure will be erased.
