Browse Source

Sync SDL3 wiki -> header

SDL Wiki Bot 7 months ago
parent
commit
926d143966
3 changed files with 10 additions and 7 deletions
  1. 4 4
      include/SDL3/SDL_audio.h
  2. 2 1
      include/SDL3/SDL_surface.h
  3. 4 2
      include/SDL3/SDL_video.h

+ 4 - 4
include/SDL3/SDL_audio.h

@@ -753,10 +753,10 @@ extern SDL_DECLSPEC float SDLCALL SDL_GetAudioDeviceGain(SDL_AudioDeviceID devid
  * Audio devices default to a gain of 1.0f (no change in output).
  *
  * Physical devices may not have their gain changed, only logical devices, and
- * this function will always return SDL_FALSE when used on physical devices. While it
- * might seem attractive to adjust several logical devices at once in this
- * way, it would allow an app or library to interfere with another portion of
- * the program's otherwise-isolated devices.
+ * this function will always return SDL_FALSE when used on physical devices.
+ * While it might seem attractive to adjust several logical devices at once in
+ * this way, it would allow an app or library to interfere with another
+ * portion of the program's otherwise-isolated devices.
  *
  * This is applied, along with any per-audiostream gain, during playback to
  * the hardware, and can be continuously changed to create various effects. On

+ 2 - 1
include/SDL3/SDL_surface.h

@@ -584,7 +584,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SurfaceHasColorKey(SDL_Surface *surface
  * The color key is a pixel of the format used by the surface, as generated by
  * SDL_MapRGB().
  *
- * If the surface doesn't have color key enabled this function returns SDL_FALSE.
+ * If the surface doesn't have color key enabled this function returns
+ * SDL_FALSE.
  *
  * \param surface the SDL_Surface structure to query.
  * \param key a pointer filled in with the transparent pixel.

+ 4 - 2
include/SDL3/SDL_video.h

@@ -1574,7 +1574,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GetWindowAspectRatio(SDL_Window *window
  * window has been presented and composited, so that the window system has a
  * chance to decorate the window and provide the border dimensions to SDL.
  *
- * This function also returns SDL_FALSE if getting the information is not supported.
+ * This function also returns SDL_FALSE if getting the information is not
+ * supported.
  *
  * \param window the window to query the size values of the border
  *               (decorations) from.
@@ -2188,7 +2189,8 @@ extern SDL_DECLSPEC const SDL_Rect * SDLCALL SDL_GetWindowMouseRect(SDL_Window *
  * The parameter `opacity` will be clamped internally between 0.0f
  * (transparent) and 1.0f (opaque).
  *
- * This function also returns SDL_FALSE if setting the opacity isn't supported.
+ * This function also returns SDL_FALSE if setting the opacity isn't
+ * supported.
  *
  * \param window the window which will be made transparent or opaque.
  * \param opacity the opacity value (0.0f - transparent, 1.0f - opaque).