|
⇤ ← Revision 1 as of 2010-05-14 23:30:02
Size: 1736
Comment: create page, add content (Wed Mar 10 ver; changeset 4428)
|
Size: 2388
Comment: add content from old wiki
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 6: | Line 6: |
| Use this function to set the state of processing certain events. | Use this function to set the state of processing ,,certain,, events ^by '''type'''^. |
| Line 17: | Line 17: |
| ||'''type'''||^the type of event to be processed^|| ||'''state'''||^the state by which to process the event^; see [[#Remarks|Remarks]] for details|| |
||'''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|| |
| Line 21: | Line 21: |
| <<Color2(green,Not sure if this is correct. Suspect it is not. Not sure what Uint8 RVs look like.)>> | <<Color2(green,These RVs are a total guess...)>> |
| Line 23: | Line 23: |
| Returns 0 on success, 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. |
| Line 32: | Line 32: |
| ||SDL_QUERY||-1||,,[[SDL_EventState]]() will,, return^s^ the current processing state of the specified event|| ||SDL_IGNORE||0||the event will automatically be dropped from the event queue and will not be filtered|| ||SDL_DISABLE||0||^same as SDL_IGNORE^ ???|| ||SDL_ENABLE||1||the event will be processed normally|| |
||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?)>> |
| Line 37: | Line 38: |
| <<Color2(green,Below is the verbatim language from the header. Thought it might be better in table form above???)>> | <<Color2(green,Below is the verbatim language from the header. Thought it might be better in table form above...)>> |
| Line 40: | Line 41: |
| 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. |
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>> [[SDL_EventState]]() must be called following the [[SDL_VideoInfo]] call. Otherwise the back-end data structure will be erased. |
DRAFT |
SDL_EventState
Use this function to set the state of processing certain events by '''type'''.
Contents
Syntax
Uint8 SDL_EventState(Uint8 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.
