Create a color cursor.
Defined in <SDL3/SDL_mouse.h>
SDL_Cursor * SDL_CreateColorCursor(SDL_Surface *surface,
int hot_x,
int hot_y);| SDL_Surface * | surface | an SDL_Surface structure representing the cursor image. |
| int | hot_x | the x position of the cursor hot spot. |
| int | hot_y | the y position of the cursor hot spot. |
(SDL_Cursor *) Returns the new cursor on success or NULL on failure; call SDL_GetError() for more information.
If this function is passed a surface with alternate representations, 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. 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.
This function is available since SDL 3.1.3.
#include <SDL3/SDL.h>
int
main(int argc, char *argv[])
{
SDL_Window *window = NULL;
SDL_Renderer *renderer = NULL;
SDL_Surface *surface = NULL;
SDL_Cursor *cursor = NULL;
bool error = true;
if (!SDL_Init(SDL_INIT_VIDEO)) {
goto exit;
}
if (!SDL_CreateWindowAndRenderer("Hello SDL", 640, 480, 0, &window, &renderer)) {
goto exit;
}
surface = SDL_LoadBMP((1 < argc) ? argv[1] : "cursor.bmp");
if (!surface) {
goto exit;
}
cursor = SDL_CreateColorCursor(surface, 0, 0);
if (!cursor) {
goto exit;
}
SDL_SetCursor(cursor);
SDL_SetRenderDrawColor(renderer, 255, 0, 0, 255);
while (true) {
SDL_Event event;
while (SDL_PollEvent(&event)) {
switch (event.type) {
case SDL_EVENT_MOUSE_BUTTON_UP:
case SDL_EVENT_QUIT:
error = false;
goto exit;
}
}
SDL_RenderClear(renderer);
SDL_RenderPresent(renderer);
}
exit:
if (error) {
SDL_LogError(SDL_LOG_CATEGORY_APPLICATION, "%s", SDL_GetError());
}
if (cursor) {
SDL_DestroyCursor(cursor);
}
if (surface) {
SDL_DestroySurface(surface);
}
if (renderer) {
SDL_DestroyRenderer(renderer);
}
if (window) {
SDL_DestroyWindow(window);
}
SDL_Quit();
return error;
}