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

Sync SDL3 wiki -> header

This commit is contained in:
SDL Wiki Bot 2024-09-16 20:12:52 +00:00
parent 1bbc897e48
commit 926d143966
3 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
include/SDL3/SDL_audio.h
View File

@ -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). * 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 * 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 * this function will always return SDL_FALSE when used on physical devices.
* might seem attractive to adjust several logical devices at once in this * While it might seem attractive to adjust several logical devices at once in
* way, it would allow an app or library to interfere with another portion of * this way, it would allow an app or library to interfere with another
* the program's otherwise-isolated devices. * portion of the program's otherwise-isolated devices.
* *
* This is applied, along with any per-audiostream gain, during playback to * This is applied, along with any per-audiostream gain, during playback to
* the hardware, and can be continuously changed to create various effects. On * the hardware, and can be continuously changed to create various effects. On

3
include/SDL3/SDL_surface.h
View File

@ -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 * The color key is a pixel of the format used by the surface, as generated by
* SDL_MapRGB(). * 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 surface the SDL_Surface structure to query.
* \param key a pointer filled in with the transparent pixel. * \param key a pointer filled in with the transparent pixel.

6
include/SDL3/SDL_video.h
View File

@ -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 * 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. * 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 * \param window the window to query the size values of the border
* (decorations) from. * (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 * The parameter `opacity` will be clamped internally between 0.0f
* (transparent) and 1.0f (opaque). * (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 window the window which will be made transparent or opaque.
* \param opacity the opacity value (0.0f - transparent, 1.0f - opaque). * \param opacity the opacity value (0.0f - transparent, 1.0f - opaque).