|
Size: 2392
Comment: minor change
|
Size: 1427
Comment: some sans-Sam editing; camelcase
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 2: | Line 2: |
| #pragma disable-camelcase | #pragma camelcase off |
| Line 6: | Line 6: |
| Use this function to set the state of processing ,,certain,, events ^by '''type'''^. | Use this function to set the state of processing events by type. |
| Line 17: | Line 17: |
| ||'''type'''||^the type of event to be processed / regulated???; see [[SDL_Event]] for details^|| ||'''state'''||^how to process the event '''type'''^; see [[#Remarks|Remarks]] for details|| |
||'''type'''||the type of event; see [[SDL_EventType]] for details|| ||'''state'''||how to process the event; see [[#Remarks|Remarks]] for details|| |
| Line 21: | Line 21: |
| <<Color2(green,These RVs are a total guess...)>> 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]] for details; call [[SDL_GetError]]() for more information. |
| Line 32: | Line 30: |
| ||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|| <<Color2(green,Are the #s above the RVs or should they be removed? The current header does not specify the word "type" but it seems relevant. Should it remain or be removed above?)>> |
||-1||SDL_QUERY||returns the current processing state of the specified event|| ||0||SDL_IGNORE||the event will automatically be dropped from the event queue and will not be filtered|| ||0||SDL_DISABLE||the event type will be disabled (blocked) and pending events discarded|| ||1||SDL_ENABLE||the event will be processed normally|| |
| Line 38: | Line 35: |
| <<Color2(green,Below is the verbatim language from the header. Thought it might be better in table form above...)>> If state is set to SDL_IGNORE, that event will be automatically dropped from the event queue and will not event be filtered.<<BR>> If state is set to SDL_ENABLE, that event will be processed normally.<<BR>> If state is set to SDL_QUERY, [[SDL_EventState]]() will return the current processing state of the specified event. *<<Color2(green,Does the following still apply in 1.3? SDL_!VideoInfo seems to be a read-only struct. Should it have a page?)>><<BR>> |
*<<Color2(green,Does the following still apply in 1.3?)>><<BR>> |
DRAFT |
SDL_EventState
Use this function to set the state of processing events by type.
Contents
Syntax
Uint8 SDL_EventState(Uint32 type,
int state)
Function Parameters
type |
the type of event; see SDL_EventType for details |
state |
how to process the event; see Remarks for details |
Return Value
Returns an 8-bit bitmask of the current processing state. See Remarks for details; call SDL_GetError() for more information.
Code Examples
You can add your code example here
Remarks
state may be any of the following:
-1 |
SDL_QUERY |
returns the current processing state of the specified event |
0 |
SDL_IGNORE |
the event will automatically be dropped from the event queue and will not be filtered |
0 |
SDL_DISABLE |
the event type will be disabled (blocked) and pending events discarded |
1 |
SDL_ENABLE |
the event will be processed normally |
*green
SDL_EventState() must be called following the SDL_VideoInfo call. Otherwise the back-end data structure will be erased.*
