Sync SDL3 wiki -> header

main
SDL Wiki Bot 2024-04-11 17:35:27 +00:00
parent 0df988389c
commit 2f4f1f6923
3 changed files with 15 additions and 15 deletions

View File

@ -155,7 +155,7 @@ typedef enum SDL_PenSubtype
* array must be freed with SDL_free(). On a NULL return, * array must be freed with SDL_free(). On a NULL return,
* SDL_GetError() is set. * SDL_GetError() is set.
* *
* \since This function is available since SDL 3.0.0 * \since This function is available since SDL 3.0.0.
*/ */
extern DECLSPEC SDL_PenID *SDLCALL SDL_GetPens(int *count); extern DECLSPEC SDL_PenID *SDLCALL SDL_GetPens(int *count);
@ -176,7 +176,7 @@ extern DECLSPEC SDL_PenID *SDLCALL SDL_GetPens(int *count);
* SDL_PEN_INK_MASK or SDL_PEN_ERASER_MASK , or 0 on error (see * SDL_PEN_INK_MASK or SDL_PEN_ERASER_MASK , or 0 on error (see
* SDL_GetError()). * SDL_GetError()).
* *
* \since This function is available since SDL 3.0.0 * \since This function is available since SDL 3.0.0.
*/ */
extern DECLSPEC Uint32 SDLCALL SDL_GetPenStatus(SDL_PenID instance_id, float *x, float *y, float *axes, size_t num_axes); extern DECLSPEC Uint32 SDLCALL SDL_GetPenStatus(SDL_PenID instance_id, float *x, float *y, float *axes, size_t num_axes);
@ -187,7 +187,7 @@ extern DECLSPEC Uint32 SDLCALL SDL_GetPenStatus(SDL_PenID instance_id, float *x,
* \returns A valid SDL_PenID, or SDL_PEN_INVALID if there is no matching * \returns A valid SDL_PenID, or SDL_PEN_INVALID if there is no matching
* SDL_PenID. * SDL_PenID.
* *
* \since This function is available since SDL 3.0.0 * \since This function is available since SDL 3.0.0.
*/ */
extern DECLSPEC SDL_PenID SDLCALL SDL_GetPenFromGUID(SDL_GUID guid); extern DECLSPEC SDL_PenID SDLCALL SDL_GetPenFromGUID(SDL_GUID guid);
@ -198,7 +198,7 @@ extern DECLSPEC SDL_PenID SDLCALL SDL_GetPenFromGUID(SDL_GUID guid);
* \returns The corresponding pen GUID; persistent across multiple sessions. * \returns The corresponding pen GUID; persistent across multiple sessions.
* If "instance_id" is SDL_PEN_INVALID, returns an all-zeroes GUID. * If "instance_id" is SDL_PEN_INVALID, returns an all-zeroes GUID.
* *
* \since This function is available since SDL 3.0.0 * \since This function is available since SDL 3.0.0.
*/ */
extern DECLSPEC SDL_GUID SDLCALL SDL_GetPenGUID(SDL_PenID instance_id); extern DECLSPEC SDL_GUID SDLCALL SDL_GetPenGUID(SDL_PenID instance_id);
@ -212,7 +212,7 @@ extern DECLSPEC SDL_GUID SDLCALL SDL_GetPenGUID(SDL_PenID instance_id);
* \returns SDL_TRUE if "instance_id" is valid and the corresponding pen is * \returns SDL_TRUE if "instance_id" is valid and the corresponding pen is
* attached, or SDL_FALSE otherwise. * attached, or SDL_FALSE otherwise.
* *
* \since This function is available since SDL 3.0.0 * \since This function is available since SDL 3.0.0.
*/ */
extern DECLSPEC SDL_bool SDLCALL SDL_PenConnected(SDL_PenID instance_id); extern DECLSPEC SDL_bool SDLCALL SDL_PenConnected(SDL_PenID instance_id);
@ -228,7 +228,7 @@ extern DECLSPEC SDL_bool SDLCALL SDL_PenConnected(SDL_PenID instance_id);
* The pointer remains valid until SDL is shut down. Returns NULL on * The pointer remains valid until SDL is shut down. Returns NULL on
* error (cf. SDL_GetError()) * error (cf. SDL_GetError())
* *
* \since This function is available since SDL 3.0.0 * \since This function is available since SDL 3.0.0.
*/ */
extern DECLSPEC const char *SDLCALL SDL_GetPenName(SDL_PenID instance_id); extern DECLSPEC const char *SDLCALL SDL_GetPenName(SDL_PenID instance_id);
@ -252,7 +252,7 @@ typedef struct SDL_PenCapabilityInfo
* number of buttons * number of buttons
* \returns a set of capability flags, cf. SDL_PEN_CAPABILITIES * \returns a set of capability flags, cf. SDL_PEN_CAPABILITIES
* *
* \since This function is available since SDL 3.0.0 * \since This function is available since SDL 3.0.0.
*/ */
extern DECLSPEC Uint32 SDLCALL SDL_GetPenCapabilities(SDL_PenID instance_id, SDL_PenCapabilityInfo *capabilities); extern DECLSPEC Uint32 SDLCALL SDL_GetPenCapabilities(SDL_PenID instance_id, SDL_PenCapabilityInfo *capabilities);
@ -267,7 +267,7 @@ extern DECLSPEC Uint32 SDLCALL SDL_GetPenCapabilities(SDL_PenID instance_id, SDL
* tip on SDL_EVENT_PEN_DOWN, or the flag SDL_PEN_ERASER_MASK in the * tip on SDL_EVENT_PEN_DOWN, or the flag SDL_PEN_ERASER_MASK in the
* pen state. * pen state.
* *
* \since This function is available since SDL 3.0.0 * \since This function is available since SDL 3.0.0.
*/ */
extern DECLSPEC SDL_PenSubtype SDLCALL SDL_GetPenType(SDL_PenID instance_id); extern DECLSPEC SDL_PenSubtype SDLCALL SDL_GetPenType(SDL_PenID instance_id);

View File

@ -676,7 +676,7 @@ extern DECLSPEC int SDLCALL SDL_GDKGetTaskQueue(XTaskQueueHandle * outTaskQueue)
* handle. * handle.
* \returns 0 if success, -1 if any error occurs. * \returns 0 if success, -1 if any error occurs.
* *
* \since This function is available since SDL 2.28.0. * \since This function is available since SDL 3.0.0.
*/ */
extern DECLSPEC int SDLCALL SDL_GDKGetDefaultUser(XUserHandle * outUserHandle); extern DECLSPEC int SDLCALL SDL_GDKGetDefaultUser(XUserHandle * outUserHandle);

View File

@ -102,7 +102,7 @@ typedef enum SDL_TimeFormat
* \returns 0 on success or -1 on error; call SDL_GetError() for more * \returns 0 on success or -1 on error; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.0.0 * \since This function is available since SDL 3.0.0.
*/ */
extern DECLSPEC int SDLCALL SDL_GetCurrentTime(SDL_Time *ticks); extern DECLSPEC int SDLCALL SDL_GetCurrentTime(SDL_Time *ticks);
@ -118,7 +118,7 @@ extern DECLSPEC int SDLCALL SDL_GetCurrentTime(SDL_Time *ticks);
* \returns 0 on success or -1 on error; call SDL_GetError() for more * \returns 0 on success or -1 on error; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.0.0 * \since This function is available since SDL 3.0.0.
*/ */
extern DECLSPEC int SDLCALL SDL_TimeToDateTime(SDL_Time ticks, SDL_DateTime *dt, SDL_bool localTime); extern DECLSPEC int SDLCALL SDL_TimeToDateTime(SDL_Time ticks, SDL_DateTime *dt, SDL_bool localTime);
@ -133,7 +133,7 @@ extern DECLSPEC int SDLCALL SDL_TimeToDateTime(SDL_Time ticks, SDL_DateTime *dt,
* \returns 0 on success or -1 on error; call SDL_GetError() for more * \returns 0 on success or -1 on error; call SDL_GetError() for more
* information. * information.
* *
* \since This function is available since SDL 3.0.0 * \since This function is available since SDL 3.0.0.
*/ */
extern DECLSPEC int SDLCALL SDL_DateTimeToTime(const SDL_DateTime *dt, SDL_Time *ticks); extern DECLSPEC int SDLCALL SDL_DateTimeToTime(const SDL_DateTime *dt, SDL_Time *ticks);
@ -176,7 +176,7 @@ extern DECLSPEC SDL_Time SDLCALL SDL_TimeFromWindows(Uint32 dwLowDateTime, Uint3
* \returns the number of days in the requested month, otherwise -1; call * \returns the number of days in the requested month, otherwise -1; call
* SDL_GetError() for more information. * SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.0.0 * \since This function is available since SDL 3.0.0.
*/ */
extern DECLSPEC int SDLCALL SDL_GetDaysInMonth(int year, int month); extern DECLSPEC int SDLCALL SDL_GetDaysInMonth(int year, int month);
@ -189,7 +189,7 @@ extern DECLSPEC int SDLCALL SDL_GetDaysInMonth(int year, int month);
* \returns the day of year [0-365] if the date is valid, otherwise -1; call * \returns the day of year [0-365] if the date is valid, otherwise -1; call
* SDL_GetError() for more information. * SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.0.0 * \since This function is available since SDL 3.0.0.
*/ */
extern DECLSPEC int SDLCALL SDL_GetDayOfYear(int year, int month, int day); extern DECLSPEC int SDLCALL SDL_GetDayOfYear(int year, int month, int day);
@ -202,7 +202,7 @@ extern DECLSPEC int SDLCALL SDL_GetDayOfYear(int year, int month, int day);
* \returns a value between 0 and 6 (0 being Sunday) if the date is valid, * \returns a value between 0 and 6 (0 being Sunday) if the date is valid,
* otherwise -1; call SDL_GetError() for more information. * otherwise -1; call SDL_GetError() for more information.
* *
* \since This function is available since SDL 3.0.0 * \since This function is available since SDL 3.0.0.
*/ */
extern DECLSPEC int SDLCALL SDL_GetDayOfWeek(int year, int month, int day); extern DECLSPEC int SDLCALL SDL_GetDayOfWeek(int year, int month, int day);