DRAFT |
SDL_CreateSystemCursor
Use this function to create a system cursor.
Contents
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
id may be one of the following:
SDL_SYSTEM_CURSOR_ARROW |
arrow |
SDL_SYSTEM_CURSOR_IBEAM |
i-beam |
SDL_SYSTEM_CURSOR_WAIT |
wait |
SDL_SYSTEM_CURSOR_CROSSHAIR |
crosshair |
SDL_SYSTEM_CURSOR_WAITARROW |
small wait cursor (or wait if not available) |
SDL_SYSTEM_CURSOR_SIZENWSE |
double arrow pointing northwest and southeast |
SDL_SYSTEM_CURSOR_SIZENESW |
double arrow pointing northeast and southwest |
SDL_SYSTEM_CURSOR_SIZEWE |
double arrow pointing west and east |
SDL_SYSTEM_CURSOR_SIZENS |
double arrow pointing north and south |
SDL_SYSTEM_CURSOR_SIZEALL |
four pointed arrow pointing north, south, east, and west |
SDL_SYSTEM_CURSOR_NO |
slashed circle or crossbones |
SDL_SYSTEM_CURSOR_HAND |
hand |
Version
This function is available since SDL 2.0.0.