SDL_CreateCursor

Create a cursor using the specified bitmap data and mask (in MSB format).

mask has to be in MSB (Most Significant Bit) format.

The cursor width (w) must be a multiple of 8 bits.

The cursor is created in black and white according to the following:

- data=0, mask=1: white - data=1, mask=1: black - data=0, mask=0: transparent - data=1, mask=0: inverted color if possible, black if not.

Cursors created with this function must be freed with SDL_DestroyCursor().

If you want to have a color cursor, or create your cursor from an SDL_Surface, you should use SDL_CreateColorCursor(). Alternately, you can hide the cursor and draw your own as part of your game's rendering, but it will be bound to the framerate.

Also, SDL_CreateSystemCursor() is available, which provides several readily-available system cursors to pick from.

extern (C) nothrow @nogc extern
SDL_CreateCursor
(
const Uint8* data
,
const Uint8* mask
,
int w
,
int h
,
int hot_x
,
int hot_y
)

Parameters

data Uint8*

the color value for each pixel of the cursor.

mask Uint8*

the mask value for each pixel of the cursor.

w int

the width of the cursor.

h int

the height of the cursor.

hot_x int

the x-axis offset from the left of the cursor image to the mouse x position, in the range of 0 to w - 1.

hot_y int

the y-axis offset from the top of the cursor image to the mouse y position, in the range of 0 to h - 1.

Return Value

Type: SDL_Cursor*

A new cursor with the specified parameters on success or NULL on failure; call SDL_GetError() for more information.

Threadsafety: This function should only be called on the main thread.

See Also

Meta