Skip to content

Commit 237bbfc

Browse files
committed
Sync SDL3 wiki -> header
1 parent 16e69cb commit 237bbfc

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

include/SDL3/SDL_stdinc.h

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1262,8 +1262,8 @@ extern SDL_DECLSPEC int SDLCALL SDL_vasprintf(char **strp, SDL_PRINTF_FORMAT_STR
12621262
/**
12631263
* Seed the pseudo-random number generator.
12641264
*
1265-
* Reusing the seed number will cause SDL_rand() to repeat the same stream
1266-
* of 'random' numbers.
1265+
* Reusing the seed number will cause SDL_rand() to repeat the same stream of
1266+
* 'random' numbers.
12671267
*
12681268
* \param seed the value to use as a random number seed, or 0 to use
12691269
* SDL_GetPerformanceCounter().
@@ -1282,13 +1282,14 @@ extern SDL_DECLSPEC void SDLCALL SDL_srand(Uint64 seed);
12821282
*
12831283
* You likely want to use SDL_rand_n() to get a psuedo-randum number instead.
12841284
*
1285-
* If you want reproducible output, be sure to initialize with SDL_srand() first.
1285+
* If you want reproducible output, be sure to initialize with SDL_srand()
1286+
* first.
12861287
*
12871288
* There are no guarantees as to the quality of the random sequence produced,
12881289
* and this should not be used for security (cryptography, passwords) or where
12891290
* money is on the line (loot-boxes, casinos). There are many random number
1290-
* libraries available with different characteristics and you should pick one of
1291-
* those to meet any serious needs.
1291+
* libraries available with different characteristics and you should pick one
1292+
* of those to meet any serious needs.
12921293
*
12931294
* \returns a random value in the range of [0-SDL_MAX_UINT32].
12941295
*
@@ -1306,21 +1307,20 @@ extern SDL_DECLSPEC Uint32 SDLCALL SDL_rand(void);
13061307
* Generates a pseudo-random number less than n
13071308
*
13081309
* The method used is faster and of better quality than `SDL_rand() % n`.
1309-
* However just like with `SDL_rand() % n`, bias increases with larger n.
1310-
* Odds are better than 99.9% even for n under 1 million.
1310+
* However just like with `SDL_rand() % n`, bias increases with larger n. Odds
1311+
* are better than 99.9% even for n under 1 million.
13111312
*
1312-
* Example: to simulate a d6 use `SDL_rand_n(6) + 1`
1313-
* The +1 converts 0..5 to 1..6
1313+
* Example: to simulate a d6 use `SDL_rand_n(6) + 1` The +1 converts 0..5 to
1314+
* 1..6
13141315
*
13151316
* There are no guarantees as to the quality of the random sequence produced,
13161317
* and this should not be used for security (cryptography, passwords) or where
13171318
* money is on the line (loot-boxes, casinos). There are many random number
1318-
* libraries available with different characteristics and you should pick one of
1319-
* those to meet any serious needs.
1319+
* libraries available with different characteristics and you should pick one
1320+
* of those to meet any serious needs.
13201321
*
1321-
* \param n the number of possible values
1322-
*
1323-
* \returns a random value in the range of [0 .. n-1]
1322+
* \param n the number of possible values.
1323+
* \returns a random value in the range of [0 .. n-1].
13241324
*
13251325
* \threadsafety All calls should be made from a single thread
13261326
*
@@ -1336,10 +1336,10 @@ extern SDL_DECLSPEC Uint32 SDLCALL SDL_rand_n(Uint32 n);
13361336
* There are no guarantees as to the quality of the random sequence produced,
13371337
* and this should not be used for security (cryptography, passwords) or where
13381338
* money is on the line (loot-boxes, casinos). There are many random number
1339-
* libraries available with different characteristics and you should pick one of
1340-
* those to meet any serious needs.
1339+
* libraries available with different characteristics and you should pick one
1340+
* of those to meet any serious needs.
13411341
*
1342-
* \returns a random value in the range of [0.0, 1.0)
1342+
* \returns a random value in the range of [0.0, 1.0).
13431343
*
13441344
* \threadsafety All calls should be made from a single thread
13451345
*

0 commit comments

Comments
 (0)