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

include: Fixed up some minor documentation gaps.

Browse Source
This commit is contained in:
Ryan C. Gordon
2024-09-08 00:17:34 -04:00
parent 7ec998819d
commit 4f6e81cf62
5 changed files with 36 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
include/SDL3/SDL_haptic.h
View File

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

1
include/SDL3/SDL_pen.h
View File

@@ -112,4 +112,3 @@ typedef enum SDL_PenAxis
#endif /* SDL_pen_h_ */
/* vi: set ts=4 sw=4 expandtab: */

30
include/SDL3/SDL_pixels.h
View File

@@ -74,7 +74,11 @@ extern "C" {
*/
#define SDL_ALPHA_TRANSPARENT_FLOAT 0.0f
/** Pixel type. */
/**
* Pixel type.
*
* \since This enum is available since SDL 3.0.0.
*/
typedef enum SDL_PixelType
{
SDL_PIXELTYPE_UNKNOWN,
@@ -93,7 +97,11 @@ typedef enum SDL_PixelType
SDL_PIXELTYPE_INDEX2
} SDL_PixelType;
/** Bitmap pixel order, high bit -> low bit. */
/**
* Bitmap pixel order, high bit -> low bit.
*
* \since This enum is available since SDL 3.0.0.
*/
typedef enum SDL_BitmapOrder
{
SDL_BITMAPORDER_NONE,
@@ -101,7 +109,11 @@ typedef enum SDL_BitmapOrder
SDL_BITMAPORDER_1234
} SDL_BitmapOrder;
/** Packed component order, high bit -> low bit. */
/**
* Packed component order, high bit -> low bit.
*
* \since This enum is available since SDL 3.0.0.
*/
typedef enum SDL_PackedOrder
{
SDL_PACKEDORDER_NONE,
@@ -115,7 +127,11 @@ typedef enum SDL_PackedOrder
SDL_PACKEDORDER_BGRA
} SDL_PackedOrder;
/** Array component order, low byte -> high byte. */
/**
* Array component order, low byte -> high byte.
*
* \since This enum is available since SDL 3.0.0.
*/
typedef enum SDL_ArrayOrder
{
SDL_ARRAYORDER_NONE,
@@ -127,7 +143,11 @@ typedef enum SDL_ArrayOrder
SDL_ARRAYORDER_ABGR
} SDL_ArrayOrder;
/** Packed component layout. */
/**
* Packed component layout.
*
* \since This enum is available since SDL 3.0.0.
*/
typedef enum SDL_PackedLayout
{
SDL_PACKEDLAYOUT_NONE,

13
include/SDL3/SDL_sensor.h
View File

@@ -23,6 +23,10 @@
* # CategorySensor
*
* SDL sensor management.
*
* In order to use these functions, SDL_Init() must have been called
* with the SDL_INIT_SENSOR flag. This causes SDL to scan the system
* for sensors, and load appropriate drivers.
*/
#ifndef SDL_sensor_h_
@@ -40,15 +44,6 @@ extern "C" {
/* *INDENT-ON* */
#endif
/**
* SDL_sensor.h
*
* In order to use these functions, SDL_Init() must have been called
* with the SDL_INIT_SENSOR flag. This causes SDL to scan the system
* for sensors, and load appropriate drivers.
*/
struct SDL_Sensor;
typedef struct SDL_Sensor SDL_Sensor;
/**

4
include/SDL3/SDL_video.h
View File

@@ -2217,7 +2217,7 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetWindowOpacity(SDL_Window *window, fl
*/
extern SDL_DECLSPEC float SDLCALL SDL_GetWindowOpacity(SDL_Window *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
@@ -2240,7 +2240,7 @@ extern SDL_DECLSPEC float SDLCALL SDL_GetWindowOpacity(SDL_Window *window);
*
* \sa SDL_SetWindowModal
*/
extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetWindowParent(SDL_Window *window, SDL_Window *parent);
extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetWindowParent(SDL_Window *window, SDL_Window *parent);
/**
* Toggle the state of the window as modal.