Browse Source

docs: Note that you don't need to free SDL_GetDefaultCursor's results.

Reference Issue #6777.

(cherry picked from commit 16f8dfcef944019ce4474061aa06c2a1997e601e)
Ryan C. Gordon 2 years ago
parent
commit
4bae75387a
1 changed files with 3 additions and 0 deletions
  1. 3 0
      include/SDL_mouse.h

+ 3 - 0
include/SDL_mouse.h

@@ -389,6 +389,9 @@ extern DECLSPEC SDL_Cursor *SDLCALL SDL_GetCursor(void);
 /**
  * Get the default cursor.
  *
+ * You do not have to call SDL_FreeCursor() on the return value,
+ * but it is safe to do so.
+ *
  * \returns the default cursor on success or NULL on failure.
  *
  * \since This function is available since SDL 2.0.0.