浏览代码

Clarify that icon and cursor alternate images are added with SDL_AddSurfaceAlternateImage()

Sam Lantinga 3 月之前
父节点
当前提交
27464ffb08
共有 2 个文件被更改,包括 5 次插入2 次删除
  1. 2 1
      include/SDL3/SDL_mouse.h
  2. 3 1
      include/SDL3/SDL_video.h

+ 2 - 1
include/SDL3/SDL_mouse.h

@@ -578,7 +578,7 @@ extern SDL_DECLSPEC SDL_Cursor * SDLCALL SDL_CreateCursor(const Uint8 *data,
 /**
  * Create a color cursor.
  *
- * If this function is passed a surface with alternate representations, the
+ * 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. 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,
  *
  * \since This function is available since SDL 3.2.0.
  *
+ * \sa SDL_AddSurfaceAlternateImage
  * \sa SDL_CreateCursor
  * \sa SDL_CreateSystemCursor
  * \sa SDL_DestroyCursor

+ 3 - 1
include/SDL3/SDL_video.h

@@ -1680,7 +1680,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetWindowTitle(SDL_Window *window);
 /**
  * Set the icon for a window.
  *
- * If this function is passed a surface with alternate representations, the
+ * If this function is passed a surface with alternate representations added using 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. 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);
  * \threadsafety This function should only be called on the main thread.
  *
  * \since This function is available since SDL 3.2.0.
+ *
+ * \sa SDL_AddSurfaceAlternateImage
  */
 extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowIcon(SDL_Window *window, SDL_Surface *icon);