Skip to content

Commit 27464ff

Browse files
committed
Clarify that icon and cursor alternate images are added with SDL_AddSurfaceAlternateImage()
1 parent 2ef7944 commit 27464ff

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

include/SDL3/SDL_mouse.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -578,7 +578,7 @@ extern SDL_DECLSPEC SDL_Cursor * SDLCALL SDL_CreateCursor(const Uint8 *data,
578578
/**
579579
* Create a color cursor.
580580
*
581-
* If this function is passed a surface with alternate representations, the
581+
* If this function is passed a surface with alternate representations added with SDL_AddSurfaceAlternateImage(), the
582582
* surface will be interpreted as the content to be used for 100% display
583583
* scale, and the alternate representations will be used for high DPI
584584
* situations. For example, if the original surface is 32x32, then on a 2x
@@ -598,6 +598,7 @@ extern SDL_DECLSPEC SDL_Cursor * SDLCALL SDL_CreateCursor(const Uint8 *data,
598598
*
599599
* \since This function is available since SDL 3.2.0.
600600
*
601+
* \sa SDL_AddSurfaceAlternateImage
601602
* \sa SDL_CreateCursor
602603
* \sa SDL_CreateSystemCursor
603604
* \sa SDL_DestroyCursor

include/SDL3/SDL_video.h

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1680,7 +1680,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetWindowTitle(SDL_Window *window);
16801680
/**
16811681
* Set the icon for a window.
16821682
*
1683-
* If this function is passed a surface with alternate representations, the
1683+
* If this function is passed a surface with alternate representations added using SDL_AddSurfaceAlternateImage(), the
16841684
* surface will be interpreted as the content to be used for 100% display
16851685
* scale, and the alternate representations will be used for high DPI
16861686
* situations. For example, if the original surface is 32x32, then on a 2x
@@ -1698,6 +1698,8 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetWindowTitle(SDL_Window *window);
16981698
* \threadsafety This function should only be called on the main thread.
16991699
*
17001700
* \since This function is available since SDL 3.2.0.
1701+
*
1702+
* \sa SDL_AddSurfaceAlternateImage
17011703
*/
17021704
extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowIcon(SDL_Window *window, SDL_Surface *icon);
17031705

0 commit comments

Comments
 (0)