Skip to content

Commit 29213ef

Browse files
committed
Sync SDL3 wiki -> header
[ci skip]
1 parent b7c8b2f commit 29213ef

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

include/SDL3/SDL_hints.h

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -496,17 +496,16 @@ extern "C" {
496496
/**
497497
* A variable controlling whether SDL enforces a minimum audio device spec.
498498
*
499-
* By default, SDL will require devices to be opened at a minimum spec
500-
* (at time of writing: 44100Hz, stereo, Sint16 format), so if something
501-
* lower quality tries to open the device first, it doesn't ruin audio
502-
* for the next thing that opens a device. For example, if a VoIP library
503-
* wants Uint8, 8000Hz, mono output, it doesn't force the entire game to
504-
* this state simply because it got there first.
505-
*
506-
* However, an app that knows it will definitely be the only thing opening
507-
* a device, and wants to open it at a lower spec, might be able to avoid
508-
* some otherwise-unnecessary conversions by bypassing this minimum
509-
* requirement.
499+
* By default, SDL will require devices to be opened at a minimum spec (at
500+
* time of writing: 44100Hz, stereo, Sint16 format), so if something lower
501+
* quality tries to open the device first, it doesn't ruin audio for the next
502+
* thing that opens a device. For example, if a VoIP library wants Uint8,
503+
* 8000Hz, mono output, it doesn't force the entire game to this state simply
504+
* because it got there first.
505+
*
506+
* However, an app that knows it will definitely be the only thing opening a
507+
* device, and wants to open it at a lower spec, might be able to avoid some
508+
* otherwise-unnecessary conversions by bypassing this minimum requirement.
510509
*
511510
* Note that even without the minimum enforcement, the system might choose a
512511
* different format/channels/frequency than requested by the app; this hint

0 commit comments

Comments
 (0)