Wiki Page Content

Differences between revisions 5 and 6
Revision 5 as of 2013-09-01 19:02:59
Size: 1211
Comment: Updated usage of Color2 macro.
Revision 6 as of 2014-01-11 19:40:33
Size: 1164
Comment: Removed *, BR and old formatting.
Deletions are marked like this. Additions are marked like this.
Line 19: Line 19:
Returns 1 if the cursor is shown, or 0 if the cursor is hidden, <<Color2(col=green,text="or a negative error code on failure; call [[SDL_GetError]]() for more information")>>. 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.
Line 27: Line 27:
*<<BR>>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 29: Line 29:
The current state of the mouse cursor can be queried by passing SDL_QUERY; either SDL_DISABLE or SDL_ENABLE will be returned.<<BR>>* The current state of the mouse cursor can be queried by passing SDL_QUERY; either SDL_DISABLE or SDL_ENABLE will be returned.
Line 34: Line 34:
 .[[SDL_CreateCursor]] *
 .[[SDL_SetCursor]] *
 .[[SDL_CreateCursor]]
 .[[SDL_SetCursor]]

DRAFT

SDL_ShowCursor

Use this function to toggle whether or not the cursor is shown.

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

You can add your code example here

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.

The above has been rearranged from the original. Do these apply in 2.0?


CategoryAPI, CategoryMouse

None: SDL_ShowCursor (last edited 2016-10-20 20:30:49 by PhilippWiesemann)

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