Browse Source

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

Reference Issue #6777.
Ryan C. Gordon 2 years ago
parent
commit
16f8dfcef9
1 changed files with 3 additions and 0 deletions
  1. 3 0
      include/SDL3/SDL_mouse.h

+ 3 - 0
include/SDL3/SDL_mouse.h

@@ -391,6 +391,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 3.0.0.