gitea/SDL3_fork
1
0
Fork 0
Code Issues Pull Requests Actions 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

5
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_OpenHaptic
* \sa SDL_OpenHapticFromJoystick * \sa SDL_OpenHapticFromJoystick
* \sa SDL_CloseHaptic * \sa SDL_CloseHaptic
*
* \since This struct is available since SDL 3.0.0.
*/ */
struct SDL_Haptic;
typedef struct SDL_Haptic 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_ */ #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 #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 typedef enum SDL_PixelType
{ {
SDL_PIXELTYPE_UNKNOWN, SDL_PIXELTYPE_UNKNOWN,
@@ -93,7 +97,11 @@ typedef enum SDL_PixelType
SDL_PIXELTYPE_INDEX2 SDL_PIXELTYPE_INDEX2
} SDL_PixelType; } 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 typedef enum SDL_BitmapOrder
{ {
SDL_BITMAPORDER_NONE, SDL_BITMAPORDER_NONE,
@@ -101,7 +109,11 @@ typedef enum SDL_BitmapOrder
SDL_BITMAPORDER_1234 SDL_BITMAPORDER_1234
} SDL_BitmapOrder; } 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 typedef enum SDL_PackedOrder
{ {
SDL_PACKEDORDER_NONE, SDL_PACKEDORDER_NONE,
@@ -115,7 +127,11 @@ typedef enum SDL_PackedOrder
SDL_PACKEDORDER_BGRA SDL_PACKEDORDER_BGRA
} SDL_PackedOrder; } 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 typedef enum SDL_ArrayOrder
{ {
SDL_ARRAYORDER_NONE, SDL_ARRAYORDER_NONE,
@@ -127,7 +143,11 @@ typedef enum SDL_ArrayOrder
SDL_ARRAYORDER_ABGR SDL_ARRAYORDER_ABGR
} SDL_ArrayOrder; } SDL_ArrayOrder;
/** Packed component layout. */ /**
* Packed component layout.
*
* \since This enum is available since SDL 3.0.0.
*/
typedef enum SDL_PackedLayout typedef enum SDL_PackedLayout
{ {
SDL_PACKEDLAYOUT_NONE, SDL_PACKEDLAYOUT_NONE,

13
include/SDL3/SDL_sensor.h
View File

@@ -23,6 +23,10 @@
* # CategorySensor * # CategorySensor
* *
* SDL sensor management. * 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_ #ifndef SDL_sensor_h_
@@ -40,15 +44,6 @@ extern "C" {
/* *INDENT-ON* */ /* *INDENT-ON* */
#endif #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; typedef struct SDL_Sensor SDL_Sensor;
/** /**