gitea/SDL3_fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Sync SDL3 wiki -> header

Browse Source
This commit is contained in:
SDL Wiki Bot
2024-09-08 04:18:26 +00:00
parent 4f6e81cf62
commit 2b77b2e4ef
3 changed files with 15 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
include/SDL3/SDL_haptic.h
View File

@@ -141,11 +141,11 @@ extern "C" {
/** /**
* The haptic structure used to identify an SDL haptic. * The haptic structure used to identify an SDL haptic.
* *
* \since This struct is available since SDL 3.0.0.
*
* \sa SDL_OpenHaptic * \sa SDL_OpenHaptic
* \sa SDL_OpenHapticFromJoystick * \sa SDL_OpenHapticFromJoystick
* \sa SDL_CloseHaptic * \sa SDL_CloseHaptic
*
* \since This struct is available since SDL 3.0.0.
*/ */
typedef struct SDL_Haptic SDL_Haptic; typedef struct SDL_Haptic SDL_Haptic;

6
include/SDL3/SDL_sensor.h
View File

@@ -24,9 +24,9 @@
* *
* SDL sensor management. * SDL sensor management.
* *
* In order to use these functions, SDL_Init() must have been called * In order to use these functions, SDL_Init() must have been called with the
* with the SDL_INIT_SENSOR flag. This causes SDL to scan the system * SDL_INIT_SENSOR flag. This causes SDL to scan the system for sensors, and
* for sensors, and load appropriate drivers. * load appropriate drivers.
*/ */
#ifndef SDL_sensor_h_ #ifndef SDL_sensor_h_

20
include/SDL3/SDL_video.h
View File

@@ -2220,21 +2220,21 @@ extern SDL_DECLSPEC float SDLCALL SDL_GetWindowOpacity(SDL_Window *window);
/** /**
* Set the window as a child of a parent window. * Set the window as a child of a parent window.
* *
* If the window is already the child of an existing window, it will be reparented * If the window is already the child of an existing window, it will be
* to the new owner. Setting the parent window to null unparents the window and * reparented to the new owner. Setting the parent window to null unparents
* removes child window status. * the window and removes child window status.
* *
* Attempting to set the parent of a window that is currently in the modal state will fail. * Attempting to set the parent of a window that is currently in the modal
* Use SDL_SetWindowModalFor() to cancel the modal status before attempting to change * state will fail. Use SDL_SetWindowModalFor() to cancel the modal status
* the parent. * before attempting to change the parent.
* *
* Setting a parent window that is currently the sibling or descendent of the child * Setting a parent window that is currently the sibling or descendent of the
* window results in undefined behavior. * child window results in undefined behavior.
* *
* \param window the window that should become the child of a parent. * \param window the window that should become the child of a parent.
* \param parent the new parent window for the child window. * \param parent the new parent window for the child window.
* \returns SDL_TRUE on success or SDL_FALSE on failure; call * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError()
* SDL_GetError() for more information. * for more information.
* *
* \since This function is available since SDL 3.0.0. * \since This function is available since SDL 3.0.0.
* *