mirrors
/
SDL
mirror of https://github.com/libsdl-org/SDL
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Sync SDL3 wiki -> header

This commit is contained in:
SDL Wiki Bot 2024-09-13 19:32:14 +00:00
parent 84361bcf0a
commit d483886ec5
1 changed files with 42 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

70
include/SDL3/SDL_stdinc.h
View File

@ -1500,17 +1500,20 @@ extern SDL_DECLSPEC int SDLCALL SDL_wcsncasecmp(const wchar_t *str1, const wchar
/** /**
* Parse a `long` from a wide string. * Parse a `long` from a wide string.
* *
* If `str` starts with whitespace, then those whitespace characters are skipped before attempting to parse the number. * If `str` starts with whitespace, then those whitespace characters are
* skipped before attempting to parse the number.
* *
* If the parsed number does not fit inside a `long`, the result is clamped to the minimum and maximum representable `long` values. * If the parsed number does not fit inside a `long`, the result is clamped to
* the minimum and maximum representable `long` values.
* *
* \param str The null-terminated wide string to read. Must not be NULL. * \param str The null-terminated wide string to read. Must not be NULL.
* \param endp If not NULL, the address of the first invalid wide character * \param endp If not NULL, the address of the first invalid wide character
* (i.e. the next character after the parsed number) will be * (i.e. the next character after the parsed number) will be
* written to this pointer. * written to this pointer.
* \param base The base of the integer to read. Supported values are 0 and 2 to 36 inclusive. * \param base The base of the integer to read. Supported values are 0 and 2
* If 0, the base will be inferred from the number's * to 36 inclusive. If 0, the base will be inferred from the
* prefix (0x for hexadecimal, 0 for octal, decimal otherwise). * number's prefix (0x for hexadecimal, 0 for octal, decimal
* otherwise).
* \returns The parsed `long`, or 0 if no number could be parsed. * \returns The parsed `long`, or 0 if no number could be parsed.
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
@ -1719,17 +1722,20 @@ extern SDL_DECLSPEC double SDLCALL SDL_atof(const char *str);
/** /**
* Parse a `long` from a string. * Parse a `long` from a string.
* *
* If `str` starts with whitespace, then those whitespace characters are skipped before attempting to parse the number. * If `str` starts with whitespace, then those whitespace characters are
* skipped before attempting to parse the number.
* *
* If the parsed number does not fit inside a `long`, the result is clamped to the minimum and maximum representable `long` values. * If the parsed number does not fit inside a `long`, the result is clamped to
* the minimum and maximum representable `long` values.
* *
* \param str The null-terminated string to read. Must not be NULL. * \param str The null-terminated string to read. Must not be NULL.
* \param endp If not NULL, the address of the first invalid character (i.e. * \param endp If not NULL, the address of the first invalid character (i.e.
* the next character after the parsed number) will be written to * the next character after the parsed number) will be written to
* this pointer. * this pointer.
* \param base The base of the integer to read. Supported values are 0 and 2 to 36 inclusive. * \param base The base of the integer to read. Supported values are 0 and 2
* If 0, the base will be inferred from the number's * to 36 inclusive. If 0, the base will be inferred from the
* prefix (0x for hexadecimal, 0 for octal, decimal otherwise). * number's prefix (0x for hexadecimal, 0 for octal, decimal
* otherwise).
* \returns The parsed `long`, or 0 if no number could be parsed. * \returns The parsed `long`, or 0 if no number could be parsed.
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
@ -1750,18 +1756,20 @@ extern SDL_DECLSPEC long SDLCALL SDL_strtol(const char *str, char **endp, int ba
/** /**
* Parse an `unsigned long` from a string. * Parse an `unsigned long` from a string.
* *
* If `str` starts with whitespace, then those whitespace characters are skipped before attempting to parse the number. * If `str` starts with whitespace, then those whitespace characters are
* skipped before attempting to parse the number.
* *
* If the parsed number does not fit inside an `unsigned long`, * If the parsed number does not fit inside an `unsigned long`, the result is
* the result is clamped to the maximum representable `unsigned long` value. * clamped to the maximum representable `unsigned long` value.
* *
* \param str The null-terminated string to read. Must not be NULL. * \param str The null-terminated string to read. Must not be NULL.
* \param endp If not NULL, the address of the first invalid character (i.e. * \param endp If not NULL, the address of the first invalid character (i.e.
* the next character after the parsed number) will be written to * the next character after the parsed number) will be written to
* this pointer. * this pointer.
* \param base The base of the integer to read. Supported values are 0 and 2 to 36 inclusive. * \param base The base of the integer to read. Supported values are 0 and 2
* If 0, the base will be inferred from the number's * to 36 inclusive. If 0, the base will be inferred from the
* prefix (0x for hexadecimal, 0 for octal, decimal otherwise). * number's prefix (0x for hexadecimal, 0 for octal, decimal
* otherwise).
* \returns The parsed `unsigned long`, or 0 if no number could be parsed. * \returns The parsed `unsigned long`, or 0 if no number could be parsed.
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
@ -1781,17 +1789,20 @@ extern SDL_DECLSPEC unsigned long SDLCALL SDL_strtoul(const char *str, char **en
/** /**
* Parse a `long long` from a string. * Parse a `long long` from a string.
* *
* If `str` starts with whitespace, then those whitespace characters are skipped before attempting to parse the number. * If `str` starts with whitespace, then those whitespace characters are
* skipped before attempting to parse the number.
* *
* If the parsed number does not fit inside a `long long`, the result is clamped to the minimum and maximum representable `long long` values. * If the parsed number does not fit inside a `long long`, the result is
* clamped to the minimum and maximum representable `long long` values.
* *
* \param str The null-terminated string to read. Must not be NULL. * \param str The null-terminated string to read. Must not be NULL.
* \param endp If not NULL, the address of the first invalid character (i.e. * \param endp If not NULL, the address of the first invalid character (i.e.
* the next character after the parsed number) will be written to * the next character after the parsed number) will be written to
* this pointer. * this pointer.
* \param base The base of the integer to read. Supported values are 0 and 2 to 36 inclusive. * \param base The base of the integer to read. Supported values are 0 and 2
* If 0, the base will be inferred from the number's * to 36 inclusive. If 0, the base will be inferred from the
* prefix (0x for hexadecimal, 0 for octal, decimal otherwise). * number's prefix (0x for hexadecimal, 0 for octal, decimal
* otherwise).
* \returns The parsed `long long`, or 0 if no number could be parsed. * \returns The parsed `long long`, or 0 if no number could be parsed.
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
@ -1811,19 +1822,22 @@ extern SDL_DECLSPEC long long SDLCALL SDL_strtoll(const char *str, char **endp,
/** /**
* Parse an `unsigned long long` from a string. * Parse an `unsigned long long` from a string.
* *
* If `str` starts with whitespace, then those whitespace characters are skipped before attempting to parse the number. * If `str` starts with whitespace, then those whitespace characters are
* skipped before attempting to parse the number.
* *
* If the parsed number does not fit inside an `unsigned long long`, * If the parsed number does not fit inside an `unsigned long long`, the
* the result is clamped to the maximum representable `unsigned long long` value. * result is clamped to the maximum representable `unsigned long long` value.
* *
* \param str The null-terminated string to read. Must not be NULL. * \param str The null-terminated string to read. Must not be NULL.
* \param endp If not NULL, the address of the first invalid character (i.e. * \param endp If not NULL, the address of the first invalid character (i.e.
* the next character after the parsed number) will be written to * the next character after the parsed number) will be written to
* this pointer. * this pointer.
* \param base The base of the integer to read. Supported values are 0 and 2 to 36 inclusive. * \param base The base of the integer to read. Supported values are 0 and 2
* If 0, the base will be inferred from the number's * to 36 inclusive. If 0, the base will be inferred from the
* prefix (0x for hexadecimal, 0 for octal, decimal otherwise). * number's prefix (0x for hexadecimal, 0 for octal, decimal
* \returns The parsed `unsigned long long`, or 0 if no number could be parsed. * otherwise).
* \returns The parsed `unsigned long long`, or 0 if no number could be
* parsed.
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *