mirrors/SDL
1
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-09-05 19:08:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

Sync SDL3 wiki -> header

Browse Source
This commit is contained in:
SDL Wiki Bot
2024-10-04 20:23:29 +00:00
parent c25423b94c
commit a3413e050b
2 changed files with 16 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
include/SDL3/SDL_init.h
View File

@@ -28,18 +28,18 @@
* Almost everything can simply call SDL_Init() near startup, with a handful * Almost everything can simply call SDL_Init() near startup, with a handful
* of flags to specify subsystems to touch. These are here to make sure SDL * of flags to specify subsystems to touch. These are here to make sure SDL
* does not even attempt to touch low-level pieces of the operating system * does not even attempt to touch low-level pieces of the operating system
* that you don't intend to use. For example, you might be using SDL for * that you don't intend to use. For example, you might be using SDL for video
* video and input but chose an external library for audio, and in this case * and input but chose an external library for audio, and in this case you
* you would just need to leave off the `SDL_INIT_AUDIO` flag to make sure * would just need to leave off the `SDL_INIT_AUDIO` flag to make sure that
* that external library has complete control. * external library has complete control.
* *
* Most apps, when terminating, should call SDL_Quit(). This will clean up * Most apps, when terminating, should call SDL_Quit(). This will clean up
* (nearly) everything that SDL might have allocated, and crucially, it'll * (nearly) everything that SDL might have allocated, and crucially, it'll
* make sure that the display's resolution is back to what the user expects * make sure that the display's resolution is back to what the user expects if
* if you had previously changed it for your game. * you had previously changed it for your game.
* *
* SDL3 apps are strongly encouraged to call SDL_SetAppMetadata at startup * SDL3 apps are strongly encouraged to call SDL_SetAppMetadata at startup to
* to fill in details about the program. This is completely optional, but it * fill in details about the program. This is completely optional, but it
* helps in small ways (we can provide an About dialog box for the macOS menu, * helps in small ways (we can provide an About dialog box for the macOS menu,
* we can name the app in the system's audio mixer, etc). Those that want to * we can name the app in the system's audio mixer, etc). Those that want to
* provide a _lot_ of information should look at the more-detailed * provide a _lot_ of information should look at the more-detailed

15
include/SDL3/SDL_video.h
View File

@@ -29,13 +29,14 @@
* interacting with a window. * interacting with a window.
* *
* The video subsystem is also interested in abstracting away some * The video subsystem is also interested in abstracting away some
* platform-specific differences in OpenGL: context creation, swapping buffers, * platform-specific differences in OpenGL: context creation, swapping
* etc. This may be crucial to your app, but also you are not required to use * buffers, etc. This may be crucial to your app, but also you are not
* OpenGL at all. * required to use OpenGL at all. In fact, SDL can provide rendering to those
* In fact, SDL can provide rendering to those windows as well, either with an * windows as well, either with an easy-to-use
* easy-to-use [2D API](https://wiki.libsdl.org/SDL3/CategoryRender) * [2D API](https://wiki.libsdl.org/SDL3/CategoryRender)
* or with a more-powerful [GPU API](https://wiki.libsdl.org/SDL3/CategoryGPU). * or with a more-powerful
* Of course, it can simply get out of your way and give you the window * [GPU API](https://wiki.libsdl.org/SDL3/CategoryGPU)
* . Of course, it can simply get out of your way and give you the window
* handles you need to use Vulkan, Direct3D, Metal, or whatever else you like * handles you need to use Vulkan, Direct3D, Metal, or whatever else you like
* directly, too. * directly, too.
* *