|
Size: 1256
Comment: Moved simple SDL_ShowCursor() code example to the correct page.
|
Size: 1261
Comment: Hid green comment in comment.
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 33: | Line 33: |
| The cursor starts off displayed but can be turned off. Passing SDL_ENABLE displays the cursor and passing SDL_DISABLE hides it. | The cursor starts off displayed but can be turned off. Passing SDL_ENABLE displays the cursor and passing SDL_DISABLE hides it. |
| Line 37: | Line 37: |
| <<Color2(col=green,text="The above has been rearranged from the original. Do these apply in 2.0?")>> | /* <<Color2(col=green,text="The above has been rearranged from the original. Do these apply in 2.0?")>> */ |
DRAFT |
SDL_ShowCursor
Use this function to toggle whether or not the cursor is shown.
Contents
Syntax
int SDL_ShowCursor(int toggle)
Function Parameters
toggle |
1 to show the cursor, 0 to hide it, -1 to query the current state |
Return Value
Returns 1 if the cursor is shown, or 0 if the cursor is hidden, or a negative error code on failure; call SDL_GetError() for more information.
Code Examples
int main(int argc, char** argv) {
SDL_ShowCursor(SDL_DISABLE);
...
return 0;
}
/* creates a blank cursor */
Remarks
The cursor starts off displayed but can be turned off. Passing SDL_ENABLE displays the cursor and passing SDL_DISABLE hides it.
The current state of the mouse cursor can be queried by passing SDL_QUERY; either SDL_DISABLE or SDL_ENABLE will be returned.
