Wiki Page Content

Differences between revisions 2 and 3
Revision 2 as of 2014-01-22 01:59:21
Size: 1652
Editor: norbert
Comment: Mentioned all valid ids and added a simple code example.
Revision 3 as of 2016-04-15 21:48:44
Size: 1407
Comment: Moved remark in Remarks section.
Deletions are marked like this. Additions are marked like this.
Line 23: Line 23:
||'''id'''||a system cursor enum value|| ||'''id'''||a system cursor enum value; see [[#Remarks|Remarks]] for details||
Line 25: Line 25:

== Return Value ==
Returns a cursor on success or NULL on failure; call [[SDL_GetError]]() for more information.


== Code Examples ==
{{{#!highlight cpp
SDL_Cursor* cursor;
cursor = SDL_CreateSystemCursor(SDL_SYSTEM_CURSOR_HAND);
SDL_SetCursor(cursor);
}}}


== Remarks ==
Line 39: Line 53:
== Return Value ==
Returns a cursor on success or NULL on failure; call [[SDL_GetError]]() for more information.


== Code Examples ==
{{{#!highlight cpp
SDL_Cursor* cursor;
cursor = SDL_CreateSystemCursor(SDL_SYSTEM_CURSOR_HAND);
SDL_SetCursor(cursor);
}}}


== Remarks ==
''You can add useful comments here''

##Leave this section as-is unless you have a remark to put in. In that case, replace ''You can add useful comments here'' with your remark(s) following the Style Guide instructions. Leave the rest of the markup alone and delete this comment.

DRAFT

SDL_CreateSystemCursor

Use this function to create a system cursor.

Syntax

SDL_Cursor* SDL_CreateSystemCursor(SDL_SystemCursor id)

Function Parameters

id

a system cursor enum value; see Remarks for details

Return Value

Returns a cursor on success or NULL on failure; call SDL_GetError() for more information.

Code Examples

SDL_Cursor* cursor;
cursor = SDL_CreateSystemCursor(SDL_SYSTEM_CURSOR_HAND);
SDL_SetCursor(cursor);

Remarks

Valid ids are:

  • SDL_SYSTEM_CURSOR_ARROW
  • SDL_SYSTEM_CURSOR_IBEAM
  • SDL_SYSTEM_CURSOR_WAIT
  • SDL_SYSTEM_CURSOR_CROSSHAIR
  • SDL_SYSTEM_CURSOR_WAITARROW
  • SDL_SYSTEM_CURSOR_SIZENWSE
  • SDL_SYSTEM_CURSOR_SIZENESW
  • SDL_SYSTEM_CURSOR_SIZEWE
  • SDL_SYSTEM_CURSOR_SIZENS
  • SDL_SYSTEM_CURSOR_SIZEALL
  • SDL_SYSTEM_CURSOR_NO
  • SDL_SYSTEM_CURSOR_HAND

Version

This function is available since SDL 2.0.0.


CategoryAPI, CategoryMouse

None: SDL_CreateSystemCursor (last edited 2016-04-15 21:50:30 by PhilippWiesemann)

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