Function SDL_CreateColorCursor 

pub unsafe extern "C" fn SDL_CreateColorCursor(
    surface: *mut SDL_Surface,
    hot_x: c_int,
    hot_y: c_int,
) -> *mut SDL_Cursor

Create a color cursor.

If this function is passed a surface with alternate representations added with SDL_AddSurfaceAlternateImage(), the surface will be interpreted as the content to be used for 100% display scale, and the alternate representations will be used for high DPI situations if SDL_HINT_MOUSE_DPI_SCALE_CURSORS is enabled. For example, if the original surface is 32x32, then on a 2x macOS display or 200% display scale on Windows, a 64x64 version of the image will be used, if available. If a matching version of the image isn’t available, the closest larger size image will be downscaled to the appropriate size and be used instead, if available. Otherwise, the closest smaller image will be upscaled and be used instead.

Parameters

• surface: an SDL_Surface structure representing the cursor image.
• hot_x: the x position of the cursor hot spot.
• hot_y: the y position of the cursor hot spot.

Return value

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

Thread safety

This function should only be called on the main thread.

Availability

This function is available since SDL 3.2.0.

See also

• SDL_AddSurfaceAlternateImage
• SDL_CreateAnimatedCursor
• SDL_CreateCursor
• SDL_CreateSystemCursor
• SDL_DestroyCursor
• SDL_SetCursor