docs: Remove Doxygen \brief tags.

Doxygen and the wiki bridge don't need them; they'll both just use the first
line/sentence instead.

Fixes #8446.
This commit is contained in:
Ryan C. Gordon
2023-11-06 10:26:06 -05:00
parent c132295ad7
commit c53843a961
104 changed files with 669 additions and 667 deletions

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_assert.h
*
* \brief Header file for assertion SDL API functions
* Header file for assertion SDL API functions
*/
#ifndef SDL_assert_h_

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_atomic.h
*
* \brief Atomic operations.
* Atomic operations.
*
* IMPORTANT:
* If you are not an expert in concurrent lockless programming, you should
@@ -263,8 +263,9 @@ typedef void (*SDL_KernelMemoryBarrierFunc)();
/**
* \brief A type representing an atomic integer value. It is a struct
* so people don't accidentally use numeric operations on it.
* A type representing an atomic integer value.
*
* It is a struct so people don't accidentally use numeric operations on it.
*/
typedef struct { int value; } SDL_AtomicInt;
@@ -340,14 +341,14 @@ extern DECLSPEC int SDLCALL SDL_AtomicGet(SDL_AtomicInt *a);
extern DECLSPEC int SDLCALL SDL_AtomicAdd(SDL_AtomicInt *a, int v);
/**
* \brief Increment an atomic variable used as a reference count.
* Increment an atomic variable used as a reference count.
*/
#ifndef SDL_AtomicIncRef
#define SDL_AtomicIncRef(a) SDL_AtomicAdd(a, 1)
#endif
/**
* \brief Decrement an atomic variable used as a reference count.
* Decrement an atomic variable used as a reference count.
*
* \return SDL_TRUE if the variable reached zero after decrementing,
* SDL_FALSE otherwise

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_audio.h
*
* \brief Audio functionality for the SDL library.
* Audio functionality for the SDL library.
*/
#ifndef SDL_audio_h_
@@ -54,7 +54,7 @@ extern "C" {
*/
/**
* \brief Audio format flags.
* Audio format flags.
*
* These are what the 16 bits in SDL_AudioFormat currently mean...
* (Unspecified bits are always zero).

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_bits.h
*
* \brief Functions for fiddling with bits and bitmasks.
* Functions for fiddling with bits and bitmasks.
*/
#ifndef SDL_bits_h_

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_blendmode.h
*
* \brief Header file declaring the SDL_BlendMode enumeration
* Header file declaring the SDL_BlendMode enumeration
*/
#ifndef SDL_blendmode_h_
@@ -35,7 +35,7 @@ extern "C" {
#endif
/**
* \brief The blend mode used in SDL_RenderTexture() and drawing operations.
* The blend mode used in SDL_RenderTexture() and drawing operations.
*/
typedef enum
{
@@ -60,7 +60,7 @@ typedef enum
} SDL_BlendMode;
/**
* \brief The blend operation used when combining source and destination pixel components
* The blend operation used when combining source and destination pixel components
*/
typedef enum
{
@@ -72,7 +72,7 @@ typedef enum
} SDL_BlendOperation;
/**
* \brief The normalized factor used to multiply pixel components
* The normalized factor used to multiply pixel components
*/
typedef enum
{

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_clipboard.h
*
* \brief Include file for SDL clipboard handling
* Include file for SDL clipboard handling
*/
#ifndef SDL_clipboard_h_

View File

@@ -22,5 +22,5 @@
/**
* \file SDL_copying.h
*
* \brief Header file containing SDL's license.
* Header file containing SDL's license.
*/

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_cpuinfo.h
*
* \brief CPU feature detection for SDL.
* CPU feature detection for SDL.
*/
#ifndef SDL_cpuinfo_h_

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_egl.h
*
* \brief This is a simple file to encapsulate the EGL API headers.
* This is a simple file to encapsulate the EGL API headers.
*/
#if !defined(_MSC_VER) && !defined(__ANDROID__) && !defined(SDL_USE_BUILTIN_OPENGL_DEFINITIONS)

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_endian.h
*
* \brief Functions for reading and writing endian-specific values
* Functions for reading and writing endian-specific values
*/
#ifndef SDL_endian_h_

View File

@@ -210,7 +210,7 @@ typedef enum
} SDL_EventType;
/**
* \brief Fields shared by every event
* Fields shared by every event
*/
typedef struct SDL_CommonEvent
{
@@ -219,7 +219,7 @@ typedef struct SDL_CommonEvent
} SDL_CommonEvent;
/**
* \brief Display state change event data (event.display.*)
* Display state change event data (event.display.*)
*/
typedef struct SDL_DisplayEvent
{
@@ -230,7 +230,7 @@ typedef struct SDL_DisplayEvent
} SDL_DisplayEvent;
/**
* \brief Window state change event data (event.window.*)
* Window state change event data (event.window.*)
*/
typedef struct SDL_WindowEvent
{
@@ -242,7 +242,7 @@ typedef struct SDL_WindowEvent
} SDL_WindowEvent;
/**
* \brief Keyboard button event structure (event.key.*)
* Keyboard button event structure (event.key.*)
*/
typedef struct SDL_KeyboardEvent
{
@@ -258,7 +258,7 @@ typedef struct SDL_KeyboardEvent
#define SDL_TEXTEDITINGEVENT_TEXT_SIZE 64
/**
* \brief Keyboard text editing event structure (event.edit.*)
* Keyboard text editing event structure (event.edit.*)
*
* The `text` is owned by SDL and should be copied if the application
* wants to hold onto it beyond the scope of handling this event.
@@ -275,7 +275,7 @@ typedef struct SDL_TextEditingEvent
#define SDL_TEXTINPUTEVENT_TEXT_SIZE 64
/**
* \brief Keyboard text input event structure (event.text.*)
* Keyboard text input event structure (event.text.*)
*
* The `text` is owned by SDL and should be copied if the application
* wants to hold onto it beyond the scope of handling this event.
@@ -289,7 +289,7 @@ typedef struct SDL_TextInputEvent
} SDL_TextInputEvent;
/**
* \brief Mouse motion event structure (event.motion.*)
* Mouse motion event structure (event.motion.*)
*/
typedef struct SDL_MouseMotionEvent
{
@@ -305,7 +305,7 @@ typedef struct SDL_MouseMotionEvent
} SDL_MouseMotionEvent;
/**
* \brief Mouse button event structure (event.button.*)
* Mouse button event structure (event.button.*)
*/
typedef struct SDL_MouseButtonEvent
{
@@ -322,7 +322,7 @@ typedef struct SDL_MouseButtonEvent
} SDL_MouseButtonEvent;
/**
* \brief Mouse wheel event structure (event.wheel.*)
* Mouse wheel event structure (event.wheel.*)
*/
typedef struct SDL_MouseWheelEvent
{
@@ -338,7 +338,7 @@ typedef struct SDL_MouseWheelEvent
} SDL_MouseWheelEvent;
/**
* \brief Joystick axis motion event structure (event.jaxis.*)
* Joystick axis motion event structure (event.jaxis.*)
*/
typedef struct SDL_JoyAxisEvent
{
@@ -354,7 +354,7 @@ typedef struct SDL_JoyAxisEvent
} SDL_JoyAxisEvent;
/**
* \brief Joystick hat position change event structure (event.jhat.*)
* Joystick hat position change event structure (event.jhat.*)
*/
typedef struct SDL_JoyHatEvent
{
@@ -374,7 +374,7 @@ typedef struct SDL_JoyHatEvent
} SDL_JoyHatEvent;
/**
* \brief Joystick button event structure (event.jbutton.*)
* Joystick button event structure (event.jbutton.*)
*/
typedef struct SDL_JoyButtonEvent
{
@@ -388,7 +388,7 @@ typedef struct SDL_JoyButtonEvent
} SDL_JoyButtonEvent;
/**
* \brief Joystick device event structure (event.jdevice.*)
* Joystick device event structure (event.jdevice.*)
*/
typedef struct SDL_JoyDeviceEvent
{
@@ -398,7 +398,7 @@ typedef struct SDL_JoyDeviceEvent
} SDL_JoyDeviceEvent;
/**
* \brief Joysick battery level change event structure (event.jbattery.*)
* Joysick battery level change event structure (event.jbattery.*)
*/
typedef struct SDL_JoyBatteryEvent
{
@@ -409,7 +409,7 @@ typedef struct SDL_JoyBatteryEvent
} SDL_JoyBatteryEvent;
/**
* \brief Gamepad axis motion event structure (event.gaxis.*)
* Gamepad axis motion event structure (event.gaxis.*)
*/
typedef struct SDL_GamepadAxisEvent
{
@@ -426,7 +426,7 @@ typedef struct SDL_GamepadAxisEvent
/**
* \brief Gamepad button event structure (event.gbutton.*)
* Gamepad button event structure (event.gbutton.*)
*/
typedef struct SDL_GamepadButtonEvent
{
@@ -441,7 +441,7 @@ typedef struct SDL_GamepadButtonEvent
/**
* \brief Gamepad device event structure (event.gdevice.*)
* Gamepad device event structure (event.gdevice.*)
*/
typedef struct SDL_GamepadDeviceEvent
{
@@ -451,7 +451,7 @@ typedef struct SDL_GamepadDeviceEvent
} SDL_GamepadDeviceEvent;
/**
* \brief Gamepad touchpad event structure (event.gtouchpad.*)
* Gamepad touchpad event structure (event.gtouchpad.*)
*/
typedef struct SDL_GamepadTouchpadEvent
{
@@ -466,7 +466,7 @@ typedef struct SDL_GamepadTouchpadEvent
} SDL_GamepadTouchpadEvent;
/**
* \brief Gamepad sensor event structure (event.gsensor.*)
* Gamepad sensor event structure (event.gsensor.*)
*/
typedef struct SDL_GamepadSensorEvent
{
@@ -479,7 +479,7 @@ typedef struct SDL_GamepadSensorEvent
} SDL_GamepadSensorEvent;
/**
* \brief Audio device event structure (event.adevice.*)
* Audio device event structure (event.adevice.*)
*/
typedef struct SDL_AudioDeviceEvent
{
@@ -494,7 +494,7 @@ typedef struct SDL_AudioDeviceEvent
/**
* \brief Touch finger event structure (event.tfinger.*)
* Touch finger event structure (event.tfinger.*)
*/
typedef struct SDL_TouchFingerEvent
{
@@ -513,7 +513,7 @@ typedef struct SDL_TouchFingerEvent
#define SDL_DROPEVENT_DATA_SIZE 64
/**
* \brief An event used to drop text or request a file open by the system (event.drop.*)
* An event used to drop text or request a file open by the system (event.drop.*)
*
* The `data` is owned by SDL and should be copied if the application
* wants to hold onto it beyond the scope of handling this event.
@@ -530,7 +530,7 @@ typedef struct SDL_DropEvent
} SDL_DropEvent;
/**
* \brief An event triggered when the clipboard contents have changed (event.clipboard.*)
* An event triggered when the clipboard contents have changed (event.clipboard.*)
*/
typedef struct SDL_ClipboardEvent
{
@@ -539,7 +539,7 @@ typedef struct SDL_ClipboardEvent
} SDL_ClipboardEvent;
/**
* \brief Sensor event structure (event.sensor.*)
* Sensor event structure (event.sensor.*)
*/
typedef struct SDL_SensorEvent
{
@@ -551,7 +551,7 @@ typedef struct SDL_SensorEvent
} SDL_SensorEvent;
/**
* \brief The "quit requested" event
* The "quit requested" event
*/
typedef struct SDL_QuitEvent
{
@@ -560,7 +560,7 @@ typedef struct SDL_QuitEvent
} SDL_QuitEvent;
/**
* \brief OS Specific event
* OS Specific event
*/
typedef struct SDL_OSEvent
{
@@ -569,7 +569,7 @@ typedef struct SDL_OSEvent
} SDL_OSEvent;
/**
* \brief A user-defined event type (event.user.*)
* A user-defined event type (event.user.*)
*/
typedef struct SDL_UserEvent
{
@@ -586,13 +586,15 @@ struct SDL_SysWMmsg;
typedef struct SDL_SysWMmsg SDL_SysWMmsg;
/**
* \brief A video driver dependent system event (event.syswm.*)
* This event is disabled by default, you can enable it with SDL_SetEventEnabled()
* A video driver dependent system event (event.syswm.*)
*
* The `msg` is owned by SDL and should be copied if the application
* wants to hold onto it beyond the scope of handling this event.
* This event is disabled by default, you can enable it with
* SDL_SetEventEnabled()
*
* \note If you want to use this event, you should include SDL_syswm.h.
* The `msg` is owned by SDL and should be copied if the application
* wants to hold onto it beyond the scope of handling this event.
*
* \note If you want to use this event, you should include SDL_syswm.h.
*/
typedef struct SDL_SysWMEvent
{
@@ -602,7 +604,7 @@ typedef struct SDL_SysWMEvent
} SDL_SysWMEvent;
/**
* \brief General event structure
* General event structure
*/
typedef union SDL_Event
{

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_filesystem.h
*
* \brief Include file for filesystem SDL API functions
* Include file for filesystem SDL API functions
*/
#ifndef SDL_filesystem_h_

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_gamepad.h
*
* \brief Include file for SDL gamepad event handling
* Include file for SDL gamepad event handling
*/
#ifndef SDL_gamepad_h_

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_guid.h
*
* \brief Include file for handling ::SDL_GUID values.
* Include file for handling ::SDL_GUID values.
*/
#ifndef SDL_guid_h_

View File

@@ -22,8 +22,7 @@
/**
* \file SDL_haptic.h
*
* \brief The SDL haptic subsystem allows you to control haptic (force feedback)
* devices.
* The SDL haptic subsystem manages haptic (force feedback) devices.
*
* The basic usage is as follows:
* - Initialize the subsystem (::SDL_INIT_HAPTIC).
@@ -131,7 +130,7 @@ extern "C" {
/**
* \typedef SDL_Haptic
*
* \brief The haptic structure used to identify an SDL haptic.
* The haptic structure used to identify an SDL haptic.
*
* \sa SDL_HapticOpen
* \sa SDL_HapticOpenFromJoystick
@@ -154,7 +153,7 @@ typedef struct SDL_Haptic SDL_Haptic;
/* @{ */
/**
* \brief Constant effect supported.
* Constant effect supported.
*
* Constant haptic effect.
*
@@ -163,7 +162,7 @@ typedef struct SDL_Haptic SDL_Haptic;
#define SDL_HAPTIC_CONSTANT (1u<<0)
/**
* \brief Sine wave effect supported.
* Sine wave effect supported.
*
* Periodic haptic effect that simulates sine waves.
*
@@ -172,7 +171,7 @@ typedef struct SDL_Haptic SDL_Haptic;
#define SDL_HAPTIC_SINE (1u<<1)
/**
* \brief Left/Right effect supported.
* Left/Right effect supported.
*
* Haptic effect for direct control over high/low frequency motors.
*
@@ -186,7 +185,7 @@ typedef struct SDL_Haptic SDL_Haptic;
/* #define SDL_HAPTIC_SQUARE (1<<2) */
/**
* \brief Triangle wave effect supported.
* Triangle wave effect supported.
*
* Periodic haptic effect that simulates triangular waves.
*
@@ -195,7 +194,7 @@ typedef struct SDL_Haptic SDL_Haptic;
#define SDL_HAPTIC_TRIANGLE (1u<<3)
/**
* \brief Sawtoothup wave effect supported.
* Sawtoothup wave effect supported.
*
* Periodic haptic effect that simulates saw tooth up waves.
*
@@ -204,7 +203,7 @@ typedef struct SDL_Haptic SDL_Haptic;
#define SDL_HAPTIC_SAWTOOTHUP (1u<<4)
/**
* \brief Sawtoothdown wave effect supported.
* Sawtoothdown wave effect supported.
*
* Periodic haptic effect that simulates saw tooth down waves.
*
@@ -213,7 +212,7 @@ typedef struct SDL_Haptic SDL_Haptic;
#define SDL_HAPTIC_SAWTOOTHDOWN (1u<<5)
/**
* \brief Ramp effect supported.
* Ramp effect supported.
*
* Ramp haptic effect.
*
@@ -222,7 +221,7 @@ typedef struct SDL_Haptic SDL_Haptic;
#define SDL_HAPTIC_RAMP (1u<<6)
/**
* \brief Spring effect supported - uses axes position.
* Spring effect supported - uses axes position.
*
* Condition haptic effect that simulates a spring. Effect is based on the
* axes position.
@@ -232,7 +231,7 @@ typedef struct SDL_Haptic SDL_Haptic;
#define SDL_HAPTIC_SPRING (1u<<7)
/**
* \brief Damper effect supported - uses axes velocity.
* Damper effect supported - uses axes velocity.
*
* Condition haptic effect that simulates dampening. Effect is based on the
* axes velocity.
@@ -242,7 +241,7 @@ typedef struct SDL_Haptic SDL_Haptic;
#define SDL_HAPTIC_DAMPER (1u<<8)
/**
* \brief Inertia effect supported - uses axes acceleration.
* Inertia effect supported - uses axes acceleration.
*
* Condition haptic effect that simulates inertia. Effect is based on the axes
* acceleration.
@@ -252,7 +251,7 @@ typedef struct SDL_Haptic SDL_Haptic;
#define SDL_HAPTIC_INERTIA (1u<<9)
/**
* \brief Friction effect supported - uses axes movement.
* Friction effect supported - uses axes movement.
*
* Condition haptic effect that simulates friction. Effect is based on the
* axes movement.
@@ -262,7 +261,7 @@ typedef struct SDL_Haptic SDL_Haptic;
#define SDL_HAPTIC_FRICTION (1u<<10)
/**
* \brief Custom effect is supported.
* Custom effect is supported.
*
* User defined custom haptic effect.
*/
@@ -273,7 +272,7 @@ typedef struct SDL_Haptic SDL_Haptic;
/* These last few are features the device has, not effects */
/**
* \brief Device can set global gain.
* Device can set global gain.
*
* Device supports setting the global gain.
*
@@ -282,7 +281,7 @@ typedef struct SDL_Haptic SDL_Haptic;
#define SDL_HAPTIC_GAIN (1u<<12)
/**
* \brief Device can set autocenter.
* Device can set autocenter.
*
* Device supports setting autocenter.
*
@@ -291,7 +290,7 @@ typedef struct SDL_Haptic SDL_Haptic;
#define SDL_HAPTIC_AUTOCENTER (1u<<13)
/**
* \brief Device can be queried for effect status.
* Device can be queried for effect status.
*
* Device supports querying effect status.
*
@@ -300,7 +299,7 @@ typedef struct SDL_Haptic SDL_Haptic;
#define SDL_HAPTIC_STATUS (1u<<14)
/**
* \brief Device can be paused.
* Device can be paused.
*
* Devices supports being paused.
*
@@ -316,31 +315,33 @@ typedef struct SDL_Haptic SDL_Haptic;
/* @{ */
/**
* \brief Uses polar coordinates for the direction.
* Uses polar coordinates for the direction.
*
* \sa SDL_HapticDirection
*/
#define SDL_HAPTIC_POLAR 0
/**
* \brief Uses cartesian coordinates for the direction.
* Uses cartesian coordinates for the direction.
*
* \sa SDL_HapticDirection
*/
#define SDL_HAPTIC_CARTESIAN 1
/**
* \brief Uses spherical coordinates for the direction.
* Uses spherical coordinates for the direction.
*
* \sa SDL_HapticDirection
*/
#define SDL_HAPTIC_SPHERICAL 2
/**
* \brief Use this value to play an effect on the steering wheel axis. This
* provides better compatibility across platforms and devices as SDL will guess
* the correct axis.
* \sa SDL_HapticDirection
* Use this value to play an effect on the steering wheel axis.
*
* This provides better compatibility across platforms and devices as SDL
* will guess the correct axis.
*
* \sa SDL_HapticDirection
*/
#define SDL_HAPTIC_STEERING_AXIS 3
@@ -353,7 +354,7 @@ typedef struct SDL_Haptic SDL_Haptic;
*/
/**
* \brief Used to play a device an infinite number of times.
* Used to play a device an infinite number of times.
*
* \sa SDL_HapticRunEffect
*/
@@ -361,7 +362,7 @@ typedef struct SDL_Haptic SDL_Haptic;
/**
* \brief Structure that represents a haptic direction.
* Structure that represents a haptic direction.
*
* This is the direction where the force comes from,
* instead of the direction in which the force is exerted.
@@ -464,7 +465,7 @@ typedef struct SDL_HapticDirection
/**
* \brief A structure containing a template for a Constant effect.
* A structure containing a template for a Constant effect.
*
* This struct is exclusively for the ::SDL_HAPTIC_CONSTANT effect.
*
@@ -499,7 +500,7 @@ typedef struct SDL_HapticConstant
} SDL_HapticConstant;
/**
* \brief A structure containing a template for a Periodic effect.
* A structure containing a template for a Periodic effect.
*
* The struct handles the following effects:
* - ::SDL_HAPTIC_SINE
@@ -585,7 +586,7 @@ typedef struct SDL_HapticPeriodic
} SDL_HapticPeriodic;
/**
* \brief A structure containing a template for a Condition effect.
* A structure containing a template for a Condition effect.
*
* The struct handles the following effects:
* - ::SDL_HAPTIC_SPRING: Effect based on axes position.
@@ -633,7 +634,7 @@ typedef struct SDL_HapticCondition
} SDL_HapticCondition;
/**
* \brief A structure containing a template for a Ramp effect.
* A structure containing a template for a Ramp effect.
*
* This struct is exclusively for the ::SDL_HAPTIC_RAMP effect.
*
@@ -671,7 +672,7 @@ typedef struct SDL_HapticRamp
} SDL_HapticRamp;
/**
* \brief A structure containing a template for a Left/Right effect.
* A structure containing a template for a Left/Right effect.
*
* This struct is exclusively for the ::SDL_HAPTIC_LEFTRIGHT effect.
*
@@ -696,7 +697,7 @@ typedef struct SDL_HapticLeftRight
} SDL_HapticLeftRight;
/**
* \brief A structure containing a template for the ::SDL_HAPTIC_CUSTOM effect.
* A structure containing a template for the ::SDL_HAPTIC_CUSTOM effect.
*
* This struct is exclusively for the ::SDL_HAPTIC_CUSTOM effect.
*
@@ -738,7 +739,7 @@ typedef struct SDL_HapticCustom
} SDL_HapticCustom;
/**
* \brief The generic template for any haptic effect.
* The generic template for any haptic effect.
*
* All values max at 32767 (0x7FFF). Signed values also can be negative.
* Time values unless specified otherwise are in milliseconds.

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_hidapi.h
*
* \brief Header file for SDL HIDAPI functions.
* Header file for SDL HIDAPI functions.
*
* This is an adaptation of the original HIDAPI interface by Alan Ott,
* and includes source code licensed under the following BSD license:
@@ -71,13 +71,13 @@ extern "C" {
#endif
/**
* \brief A handle representing an open HID device
* A handle representing an open HID device
*/
struct SDL_hid_device_;
typedef struct SDL_hid_device_ SDL_hid_device; /**< opaque hidapi structure */
/**
* \brief HID underlying bus types.
* HID underlying bus types.
*/
typedef enum {
/** Unknown bus type */
@@ -109,7 +109,7 @@ typedef enum {
/** hidapi info structure */
/**
* \brief Information about a connected HID device
* Information about a connected HID device
*/
typedef struct SDL_hid_device_info
{

File diff suppressed because it is too large Load Diff

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_init.h
*
* \brief Init and quit header for the SDL library
* Init and quit header for the SDL library
*/
#ifndef SDL_init_h_
@@ -39,7 +39,7 @@ extern "C" {
/* As of version 0.5, SDL is loaded dynamically into the application */
/**
* \brief Initialization flags for SDL_Init and/or SDL_InitSubSystem
* Initialization flags for SDL_Init and/or SDL_InitSubSystem
*
* These are the flags which may be passed to SDL_Init(). You should
* specify the subsystems which you will be using in your application.

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_intrin.h
*
* \brief Header file for CPU intrinsics for SDL
* Header file for CPU intrinsics for SDL
*/
#ifndef SDL_intrin_h_

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_joystick.h
*
* \brief Include file for SDL joystick event handling
* Include file for SDL joystick event handling
*
* The term "instance_id" is the current instantiation of a joystick device in the system, if the joystick is removed and then re-inserted
* then it will get a new instance_id, instance_id's are monotonically increasing identifiers of a joystick plugged in.
@@ -359,7 +359,7 @@ typedef struct SDL_VirtualJoystickDesc
} SDL_VirtualJoystickDesc;
/**
* \brief The current version of the SDL_VirtualJoystickDesc structure
* The current version of the SDL_VirtualJoystickDesc structure
*/
#define SDL_VIRTUAL_JOYSTICK_DESC_VERSION 1

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_keyboard.h
*
* \brief Include file for SDL keyboard event handling
* Include file for SDL keyboard event handling
*/
#ifndef SDL_keyboard_h_
@@ -40,7 +40,7 @@ extern "C" {
#endif
/**
* \brief The SDL keysym structure, used in key events.
* The SDL keysym structure, used in key events.
*
* \note If you are looking for translated character input, see the ::SDL_EVENT_TEXT_INPUT event.
*/

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_keycode.h
*
* \brief Defines constants which identify keyboard keys and modifiers.
* Defines constants which identify keyboard keys and modifiers.
*/
#ifndef SDL_keycode_h_
@@ -32,7 +32,7 @@
#include <SDL3/SDL_scancode.h>
/**
* \brief The SDL virtual key representation.
* The SDL virtual key representation.
*
* Values of this type are used to represent keyboard keys using the current
* layout of the keyboard. These values include Unicode values representing
@@ -327,7 +327,7 @@ typedef enum
} SDL_KeyCode;
/**
* \brief Enumeration of valid key mods (possibly OR'd together).
* Enumeration of valid key mods (possibly OR'd together).
*/
typedef enum
{

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_loadso.h
*
* \brief System dependent library loading routines
* System dependent library loading routines
*
* Some things to keep in mind:
* \li These functions only work on C function names. Other languages may

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_locale.h
*
* \brief Include file for SDL locale services
* Include file for SDL locale services
*/
#ifndef SDL_locale_h

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_log.h
*
* \brief Simple log messages with categories and priorities.
* Simple log messages with categories and priorities.
*
* By default logs are quiet, but if you're debugging SDL you might want:
*
@@ -47,14 +47,14 @@ extern "C" {
/**
* \brief The maximum size of a log message prior to SDL 2.0.24
* The maximum size of a log message prior to SDL 2.0.24
*
* As of 2.0.24 there is no limit to the length of SDL log messages.
*/
#define SDL_MAX_LOG_MESSAGE 4096
/**
* \brief The predefined log categories
* The predefined log categories
*
* By default the application category is enabled at the INFO level,
* the assert category is enabled at the WARN level, test is enabled
@@ -97,7 +97,7 @@ typedef enum
} SDL_LogCategory;
/**
* \brief The predefined log priorities
* The predefined log priorities
*/
typedef enum
{

View File

@@ -35,7 +35,7 @@
/**
* \file SDL_main.h
*
* \brief Redefine main() on some platforms so that it is called by SDL.
* Redefine main() on some platforms so that it is called by SDL.
*/
#ifndef SDL_MAIN_HANDLED

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_metal.h
*
* \brief Header file for functions to creating Metal layers and views on SDL windows.
* Header file for functions to creating Metal layers and views on SDL windows.
*/
#ifndef SDL_metal_h_
@@ -37,7 +37,7 @@ extern "C" {
#endif
/**
* \brief A handle to a CAMetalLayer-backed NSView (macOS) or UIView (iOS/tvOS).
* A handle to a CAMetalLayer-backed NSView (macOS) or UIView (iOS/tvOS).
*
* \note This can be cast directly to an NSView or UIView.
*/

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_misc.h
*
* \brief Include file for SDL API functions that don't fit elsewhere.
* Include file for SDL API functions that don't fit elsewhere.
*/
#ifndef SDL_misc_h_

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_mouse.h
*
* \brief Include file for SDL mouse event handling.
* Include file for SDL mouse event handling.
*/
#ifndef SDL_mouse_h_
@@ -43,7 +43,7 @@ typedef Uint32 SDL_MouseID;
typedef struct SDL_Cursor SDL_Cursor; /**< Implementation dependent */
/**
* \brief Cursor types for SDL_CreateSystemCursor().
* Cursor types for SDL_CreateSystemCursor().
*/
typedef enum
{
@@ -63,7 +63,7 @@ typedef enum
} SDL_SystemCursor;
/**
* \brief Scroll direction types for the Scroll event
* Scroll direction types for the Scroll event
*/
typedef enum
{

View File

@@ -25,7 +25,7 @@
/**
* \file SDL_mutex.h
*
* \brief Functions to provide thread synchronization primitives.
* Functions to provide thread synchronization primitives.
*/
#include <SDL3/SDL_stdinc.h>

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_oldnames.h
*
* \brief Definitions to ease transition from SDL2 code
* Definitions to ease transition from SDL2 code
*/
#ifndef SDL_oldnames_h_

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_opengl.h
*
* \brief This is a simple file to encapsulate the OpenGL API headers.
* This is a simple file to encapsulate the OpenGL API headers.
*/
/**

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_opengles.h
*
* \brief This is a simple file to encapsulate the OpenGL ES 1.X API headers.
* This is a simple file to encapsulate the OpenGL ES 1.X API headers.
*/
#include <SDL3/SDL_platform_defines.h>

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_opengles2.h
*
* \brief This is a simple file to encapsulate the OpenGL ES 2.0 API headers.
* This is a simple file to encapsulate the OpenGL ES 2.0 API headers.
*/
#include <SDL3/SDL_platform_defines.h>

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_pixels.h
*
* \brief Header for the enumerated pixel format definitions.
* Header for the enumerated pixel format definitions.
*
* SDL's pixel formats have the following naming convention:
*

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_platform.h
*
* \brief Header file for platform functions.
* Header file for platform functions.
*/
#ifndef SDL_platform_h_

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_platform_defines.h
*
* \brief Try to get a standard set of platform defines.
* Try to get a standard set of platform defines.
*/
#ifndef SDL_platform_defines_h_

View File

@@ -25,7 +25,7 @@
/**
* \file SDL_power.h
*
* \brief Header for the SDL power management routines.
* Header for the SDL power management routines.
*/
#include <SDL3/SDL_stdinc.h>

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_properties.h
*
* \brief Header file for SDL properties.
* Header file for SDL properties.
*/
#ifndef SDL_properties_h_

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_quit.h
*
* \brief Include file for SDL quit event handling.
* Include file for SDL quit event handling.
*/
#ifndef SDL_quit_h_

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_rect.h
*
* \brief Header file for SDL_rect definition and management functions.
* Header file for SDL_rect definition and management functions.
*/
#ifndef SDL_rect_h_

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_render.h
*
* \brief Header file for SDL 2D rendering functions.
* Header file for SDL 2D rendering functions.
*
* This API supports the following features:
* * single pixel points

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_revision.h
*
* \brief Header file containing the SDL revision
* Header file containing the SDL revision
*/
#ifndef SDL_revision_h_

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_scancode.h
*
* \brief Defines keyboard scancodes.
* Defines keyboard scancodes.
*/
#ifndef SDL_scancode_h_
@@ -31,7 +31,7 @@
#include <SDL3/SDL_stdinc.h>
/**
* \brief The SDL keyboard scancode representation.
* The SDL keyboard scancode representation.
*
* Values of this type are used to represent keyboard keys, among other places
* in the \link SDL_Keysym::scancode key.keysym.scancode \endlink field of the

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_sensor.h
*
* \brief Include file for SDL sensor event handling
* Include file for SDL sensor event handling
*/
#ifndef SDL_sensor_h_
@@ -41,7 +41,7 @@ extern "C" {
#endif
/**
* \brief SDL_sensor.h
* 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

View File

@@ -36,7 +36,7 @@ extern "C" {
/** \file SDL_shape.h
*
* \brief Header file for the shaped window API.
* Header file for the shaped window API.
*/
#define SDL_NONSHAPEABLE_WINDOW -1
@@ -76,32 +76,32 @@ extern DECLSPEC SDL_Window *SDLCALL SDL_CreateShapedWindow(const char *title, in
*/
extern DECLSPEC SDL_bool SDLCALL SDL_IsShapedWindow(const SDL_Window *window);
/** \brief An enum denoting the specific type of contents present in an SDL_WindowShapeParams union. */
/** An enum denoting the specific type of contents present in an SDL_WindowShapeParams union. */
typedef enum {
/** \brief The default mode, a binarized alpha cutoff of 1. */
/** The default mode, a binarized alpha cutoff of 1. */
ShapeModeDefault,
/** \brief A binarized alpha cutoff with a given integer value. */
/** A binarized alpha cutoff with a given integer value. */
ShapeModeBinarizeAlpha,
/** \brief A binarized alpha cutoff with a given integer value, but with the opposite comparison. */
/** A binarized alpha cutoff with a given integer value, but with the opposite comparison. */
ShapeModeReverseBinarizeAlpha,
/** \brief A color key is applied. */
/** A color key is applied. */
ShapeModeColorKey
} WindowShapeMode;
#define SDL_SHAPEMODEALPHA(mode) (mode == ShapeModeDefault || mode == ShapeModeBinarizeAlpha || mode == ShapeModeReverseBinarizeAlpha)
/** \brief A union containing parameters for shaped windows. */
/** A union containing parameters for shaped windows. */
typedef union {
/** \brief A cutoff alpha value for binarization of the window shape's alpha channel. */
/** A cutoff alpha value for binarization of the window shape's alpha channel. */
Uint8 binarizationCutoff;
SDL_Color colorKey;
} SDL_WindowShapeParams;
/** \brief A struct that tags the SDL_WindowShapeParams union with an enum describing the type of its contents. */
/** A struct that tags the SDL_WindowShapeParams union with an enum describing the type of its contents. */
typedef struct SDL_WindowShapeMode {
/** \brief The mode of these window-shape parameters. */
/** The mode of these window-shape parameters. */
WindowShapeMode mode;
/** \brief Window-shape parameters. */
/** Window-shape parameters. */
SDL_WindowShapeParams parameters;
} SDL_WindowShapeMode;

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_stdinc.h
*
* \brief This is a general header that includes C language support.
* This is a general header that includes C language support.
*/
#ifndef SDL_stdinc_h_
@@ -123,57 +123,57 @@ char *alloca();
/* @{ */
/**
* \brief A boolean type.
* A boolean type.
*/
#define SDL_FALSE 0
#define SDL_TRUE 1
typedef unsigned int SDL_bool;
/**
* \brief A signed 8-bit integer type.
* A signed 8-bit integer type.
*/
#define SDL_MAX_SINT8 ((Sint8)0x7F) /* 127 */
#define SDL_MIN_SINT8 ((Sint8)(~0x7F)) /* -128 */
typedef int8_t Sint8;
/**
* \brief An unsigned 8-bit integer type.
* An unsigned 8-bit integer type.
*/
#define SDL_MAX_UINT8 ((Uint8)0xFF) /* 255 */
#define SDL_MIN_UINT8 ((Uint8)0x00) /* 0 */
typedef uint8_t Uint8;
/**
* \brief A signed 16-bit integer type.
* A signed 16-bit integer type.
*/
#define SDL_MAX_SINT16 ((Sint16)0x7FFF) /* 32767 */
#define SDL_MIN_SINT16 ((Sint16)(~0x7FFF)) /* -32768 */
typedef int16_t Sint16;
/**
* \brief An unsigned 16-bit integer type.
* An unsigned 16-bit integer type.
*/
#define SDL_MAX_UINT16 ((Uint16)0xFFFF) /* 65535 */
#define SDL_MIN_UINT16 ((Uint16)0x0000) /* 0 */
typedef uint16_t Uint16;
/**
* \brief A signed 32-bit integer type.
* A signed 32-bit integer type.
*/
#define SDL_MAX_SINT32 ((Sint32)0x7FFFFFFF) /* 2147483647 */
#define SDL_MIN_SINT32 ((Sint32)(~0x7FFFFFFF)) /* -2147483648 */
typedef int32_t Sint32;
/**
* \brief An unsigned 32-bit integer type.
* An unsigned 32-bit integer type.
*/
#define SDL_MAX_UINT32 ((Uint32)0xFFFFFFFFu) /* 4294967295 */
#define SDL_MIN_UINT32 ((Uint32)0x00000000) /* 0 */
typedef uint32_t Uint32;
/**
* \brief A signed 64-bit integer type.
* A signed 64-bit integer type.
*/
#define SDL_MAX_SINT64 ((Sint64)0x7FFFFFFFFFFFFFFFll) /* 9223372036854775807 */
#define SDL_MIN_SINT64 ((Sint64)(~0x7FFFFFFFFFFFFFFFll)) /* -9223372036854775808 */
typedef int64_t Sint64;
/**
* \brief An unsigned 64-bit integer type.
* An unsigned 64-bit integer type.
*/
#define SDL_MAX_UINT64 ((Uint64)0xFFFFFFFFFFFFFFFFull) /* 18446744073709551615 */
#define SDL_MIN_UINT64 ((Uint64)(0x0000000000000000ull)) /* 0 */

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_surface.h
*
* \brief Header file for ::SDL_Surface definition and management functions.
* Header file for ::SDL_Surface definition and management functions.
*/
#ifndef SDL_surface_h_
@@ -65,7 +65,7 @@ extern "C" {
typedef struct SDL_BlitMap SDL_BlitMap; /* this is an opaque type. */
/**
* \brief A collection of pixels used in software blitting.
* A collection of pixels used in software blitting.
*
* Pixels are arranged in memory in rows, with the top row first.
* Each row occupies an amount of memory given by the pitch (sometimes
@@ -112,13 +112,13 @@ typedef struct SDL_Surface
} SDL_Surface;
/**
* \brief The type of function used for surface blitting functions.
* The type of function used for surface blitting functions.
*/
typedef int (SDLCALL *SDL_blit) (struct SDL_Surface *src, const SDL_Rect *srcrect,
struct SDL_Surface *dst, const SDL_Rect *dstrect);
/**
* \brief The formula used for converting between YUV and RGB
* The formula used for converting between YUV and RGB
*/
typedef enum
{

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_system.h
*
* \brief Include file for platform specific SDL API functions
* Include file for platform specific SDL API functions
*/
#ifndef SDL_system_h_
@@ -475,44 +475,44 @@ extern DECLSPEC int SDLCALL SDL_AndroidSendMessage(Uint32 command, int param);
#ifdef __WINRT__
/**
* \brief WinRT / Windows Phone path types
* WinRT / Windows Phone path types
*/
typedef enum
{
/** \brief The installed app's root directory.
/** The installed app's root directory.
Files here are likely to be read-only. */
SDL_WINRT_PATH_INSTALLED_LOCATION,
/** \brief The app's local data store. Files may be written here */
/** The app's local data store. Files may be written here */
SDL_WINRT_PATH_LOCAL_FOLDER,
/** \brief The app's roaming data store. Unsupported on Windows Phone.
/** The app's roaming data store. Unsupported on Windows Phone.
Files written here may be copied to other machines via a network
connection.
*/
SDL_WINRT_PATH_ROAMING_FOLDER,
/** \brief The app's temporary data store. Unsupported on Windows Phone.
/** The app's temporary data store. Unsupported on Windows Phone.
Files written here may be deleted at any time. */
SDL_WINRT_PATH_TEMP_FOLDER
} SDL_WinRT_Path;
/**
* \brief WinRT Device Family
* WinRT Device Family
*/
typedef enum
{
/** \brief Unknown family */
/** Unknown family */
SDL_WINRT_DEVICEFAMILY_UNKNOWN,
/** \brief Desktop family*/
/** Desktop family*/
SDL_WINRT_DEVICEFAMILY_DESKTOP,
/** \brief Mobile family (for example smartphone) */
/** Mobile family (for example smartphone) */
SDL_WINRT_DEVICEFAMILY_MOBILE,
/** \brief XBox family */
/** XBox family */
SDL_WINRT_DEVICEFAMILY_XBOX,
} SDL_WinRT_DeviceFamily;

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_syswm.h
*
* \brief Include file for SDL custom system window manager hooks.
* Include file for SDL custom system window manager hooks.
*/
#ifndef SDL_syswm_h_
@@ -34,7 +34,7 @@
#include <SDL3/SDL_video.h>
/**
* \brief SDL_syswm.h
* SDL_syswm.h
*
* Your application has access to a special type of event ::SDL_EVENT_SYSWM,
* which contains window-manager specific information and arrives whenever

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_test.h
*
* \brief Include file for SDL test framework.
* Include file for SDL test framework.
*
* This code is a part of the SDL test library, not the main SDL library.
*/

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_test_assert.h
*
* \brief Assertion functions of SDL test framework.
* Assertion functions of SDL test framework.
*
* This code is a part of the SDL test library, not the main SDL library.
*/
@@ -43,17 +43,17 @@ extern "C" {
#endif
/**
* \brief Fails the assert.
* Fails the assert.
*/
#define ASSERT_FAIL 0
/**
* \brief Passes the assert.
* Passes the assert.
*/
#define ASSERT_PASS 1
/**
* \brief Assert that logs and break execution flow on failures.
* Assert that logs and break execution flow on failures.
*
* \param assertCondition Evaluated condition or variable to assert; fail (==0) or pass (!=0).
* \param assertDescription Message to log with the assert describing it.
@@ -61,7 +61,7 @@ extern "C" {
void SDLTest_Assert(int assertCondition, SDL_PRINTF_FORMAT_STRING const char *assertDescription, ...) SDL_PRINTF_VARARG_FUNC(2);
/**
* \brief Assert for test cases that logs but does not break execution flow on failures. Updates assertion counters.
* Assert for test cases that logs but does not break execution flow on failures. Updates assertion counters.
*
* \param assertCondition Evaluated condition or variable to assert; fail (==0) or pass (!=0).
* \param assertDescription Message to log with the assert describing it.
@@ -71,25 +71,25 @@ void SDLTest_Assert(int assertCondition, SDL_PRINTF_FORMAT_STRING const char *as
int SDLTest_AssertCheck(int assertCondition, SDL_PRINTF_FORMAT_STRING const char *assertDescription, ...) SDL_PRINTF_VARARG_FUNC(2);
/**
* \brief Explicitly pass without checking an assertion condition. Updates assertion counter.
* Explicitly pass without checking an assertion condition. Updates assertion counter.
*
* \param assertDescription Message to log with the assert describing it.
*/
void SDLTest_AssertPass(SDL_PRINTF_FORMAT_STRING const char *assertDescription, ...) SDL_PRINTF_VARARG_FUNC(1);
/**
* \brief Resets the assert summary counters to zero.
* Resets the assert summary counters to zero.
*/
void SDLTest_ResetAssertSummary(void);
/**
* \brief Logs summary of all assertions (total, pass, fail) since last reset as INFO or ERROR.
* Logs summary of all assertions (total, pass, fail) since last reset as INFO or ERROR.
*/
void SDLTest_LogAssertSummary(void);
/**
* \brief Converts the current assert summary state to a test result.
* Converts the current assert summary state to a test result.
*
* \returns TEST_RESULT_PASSED, TEST_RESULT_FAILED, or TEST_RESULT_NO_ASSERT
*/

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_test_common.h
*
* \brief Common functions of SDL test framework.
* Common functions of SDL test framework.
*
* This code is a part of the SDL test library, not the main SDL library.
*/
@@ -139,7 +139,7 @@ extern "C" {
/* Function prototypes */
/**
* \brief Parse command line parameters and create common state.
* Parse command line parameters and create common state.
*
* \param argv Array of command line parameters
* \param flags Flags indicating which subsystem to initialize (i.e. SDL_INIT_VIDEO | SDL_INIT_AUDIO)
@@ -149,14 +149,14 @@ extern "C" {
SDLTest_CommonState *SDLTest_CommonCreateState(char **argv, Uint32 flags);
/**
* \brief Free the common state object.
* Free the common state object.
*
* \param state The common state object to destroy
*/
void SDLTest_CommonDestroyState(SDLTest_CommonState *state);
/**
* \brief Process one common argument.
* Process one common argument.
*
* \param state The common state describing the test window to create.
* \param index The index of the argument to process in argv[].
@@ -167,7 +167,7 @@ int SDLTest_CommonArg(SDLTest_CommonState *state, int index);
/**
* \brief Logs command line usage info.
* Logs command line usage info.
*
* This logs the appropriate command line options for the subsystems in use
* plus other common options, and then any application-specific options.
@@ -181,7 +181,7 @@ int SDLTest_CommonArg(SDLTest_CommonState *state, int index);
void SDLTest_CommonLogUsage(SDLTest_CommonState *state, const char *argv0, const char **options);
/**
* \brief Open test window.
* Open test window.
*
* \param state The common state describing the test window to create.
*
@@ -190,7 +190,7 @@ void SDLTest_CommonLogUsage(SDLTest_CommonState *state, const char *argv0, const
SDL_bool SDLTest_CommonInit(SDLTest_CommonState *state);
/**
* \brief Easy argument handling when test app doesn't need any custom args.
* Easy argument handling when test app doesn't need any custom args.
*
* \param state The common state describing the test window to create.
* \param argc argc, as supplied to SDL_main
@@ -223,7 +223,7 @@ void SDLTest_CommonEvent(SDLTest_CommonState *state, SDL_Event *event, int *done
int SDLTest_CommonEventMainCallbacks(SDLTest_CommonState *state, const SDL_Event *event);
/**
* \brief Close test window.
* Close test window.
*
* \param state The common state used to create test window.
*
@@ -231,7 +231,7 @@ int SDLTest_CommonEventMainCallbacks(SDLTest_CommonState *state, const SDL_Event
void SDLTest_CommonQuit(SDLTest_CommonState *state);
/**
* \brief Draws various window information (position, size, etc.) to the renderer.
* Draws various window information (position, size, etc.) to the renderer.
*
* \param renderer The renderer to draw to.
* \param window The window whose information should be displayed.

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_test_compare.h
*
* \brief Comparison function of SDL test framework.
* Comparison function of SDL test framework.
*
* This code is a part of the SDL test library, not the main SDL library.
*/
@@ -45,7 +45,7 @@ extern "C" {
#endif
/**
* \brief Retrieves a single pixel from a surface.
* Retrieves a single pixel from a surface.
*
* This function prioritizes correctness over speed: it is suitable for
* unit tests, but is not intended for use in a game engine.
@@ -66,7 +66,7 @@ extern "C" {
int SDLTest_ReadSurfacePixel(SDL_Surface *surface, int x, int y, Uint8 *r, Uint8 *g, Uint8 *b, Uint8 *a);
/**
* \brief Compares a surface and with reference image data for equality
* Compares a surface and with reference image data for equality
*
* \param surface Surface used in comparison
* \param referenceSurface Test Surface used in comparison

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_test_crc32.h
*
* \brief CRC32 functions of SDL test framework.
* CRC32 functions of SDL test framework.
*
* This code is a part of the SDL test library, not the main SDL library.
*/
@@ -70,7 +70,7 @@ extern "C" {
/* ---------- Function Prototypes ------------- */
/**
* \brief Initialize the CRC context
* Initialize the CRC context
*
* Note: The function initializes the crc table required for all crc calculations.
*
@@ -83,7 +83,7 @@ extern "C" {
/**
* \brief calculate a crc32 from a data block
* calculate a crc32 from a data block
*
* \param crcContext pointer to context variable
* \param inBuf input buffer to checksum
@@ -102,7 +102,7 @@ int SDLTest_Crc32CalcBuffer(SDLTest_Crc32Context *crcContext, CrcUint8 *inBuf, C
/**
* \brief clean up CRC context
* clean up CRC context
*
* \param crcContext pointer to context variable
*

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_test_font.h
*
* \brief Font related functions of SDL test framework.
* Font related functions of SDL test framework.
*
* This code is a part of the SDL test library, not the main SDL library.
*/
@@ -43,7 +43,7 @@ extern int FONT_CHARACTER_SIZE;
#define FONT_LINE_HEIGHT (FONT_CHARACTER_SIZE + 2)
/**
* \brief Draw a string in the currently set font.
* Draw a string in the currently set font.
*
* \param renderer The renderer to draw on.
* \param x The X coordinate of the upper left corner of the character.
@@ -55,7 +55,7 @@ extern int FONT_CHARACTER_SIZE;
int SDLTest_DrawCharacter(SDL_Renderer *renderer, float x, float y, Uint32 c);
/**
* \brief Draw a UTF-8 string in the currently set font.
* Draw a UTF-8 string in the currently set font.
*
* The font currently only supports characters in the Basic Latin and Latin-1 Supplement sets.
*
@@ -69,7 +69,7 @@ int SDLTest_DrawCharacter(SDL_Renderer *renderer, float x, float y, Uint32 c);
int SDLTest_DrawString(SDL_Renderer *renderer, float x, float y, const char *s);
/**
* \brief Data used for multi-line text output
* Data used for multi-line text output
*/
typedef struct SDLTest_TextWindow
{
@@ -80,7 +80,7 @@ typedef struct SDLTest_TextWindow
} SDLTest_TextWindow;
/**
* \brief Create a multi-line text output window
* Create a multi-line text output window
*
* \param x The X coordinate of the upper left corner of the window.
* \param y The Y coordinate of the upper left corner of the window.
@@ -94,7 +94,7 @@ typedef struct SDLTest_TextWindow
SDLTest_TextWindow *SDLTest_TextWindowCreate(float x, float y, float w, float h);
/**
* \brief Display a multi-line text output window
* Display a multi-line text output window
*
* This function should be called every frame to display the text
*
@@ -106,7 +106,7 @@ SDLTest_TextWindow *SDLTest_TextWindowCreate(float x, float y, float w, float h)
void SDLTest_TextWindowDisplay(SDLTest_TextWindow *textwin, SDL_Renderer *renderer);
/**
* \brief Add text to a multi-line text output window
* Add text to a multi-line text output window
*
* Adds UTF-8 text to the end of the current text. The newline character starts a
* new line of text. The backspace character deletes the last character or, if the
@@ -121,7 +121,7 @@ void SDLTest_TextWindowDisplay(SDLTest_TextWindow *textwin, SDL_Renderer *render
void SDLTest_TextWindowAddText(SDLTest_TextWindow *textwin, SDL_PRINTF_FORMAT_STRING const char *fmt, ...) SDL_PRINTF_VARARG_FUNC(2);
/**
* \brief Add text to a multi-line text output window
* Add text to a multi-line text output window
*
* Adds UTF-8 text to the end of the current text. The newline character starts a
* new line of text. The backspace character deletes the last character or, if the
@@ -136,7 +136,7 @@ void SDLTest_TextWindowAddText(SDLTest_TextWindow *textwin, SDL_PRINTF_FORMAT_ST
void SDLTest_TextWindowAddTextWithLength(SDLTest_TextWindow *textwin, const char *text, size_t len);
/**
* \brief Clear the text in a multi-line text output window
* Clear the text in a multi-line text output window
*
* \param textwin The text output window
*
@@ -145,7 +145,7 @@ void SDLTest_TextWindowAddTextWithLength(SDLTest_TextWindow *textwin, const char
void SDLTest_TextWindowClear(SDLTest_TextWindow *textwin);
/**
* \brief Free the storage associated with a multi-line text output window
* Free the storage associated with a multi-line text output window
*
* \param textwin The text output window
*
@@ -154,7 +154,7 @@ void SDLTest_TextWindowClear(SDLTest_TextWindow *textwin);
void SDLTest_TextWindowDestroy(SDLTest_TextWindow *textwin);
/**
* \brief Cleanup textures used by font drawing functions.
* Cleanup textures used by font drawing functions.
*/
void SDLTest_CleanupTextDrawing(void);

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_test_fuzzer.h
*
* \brief Fuzzer functions of SDL test framework.
* Fuzzer functions of SDL test framework.
*
* This code is a part of the SDL test library, not the main SDL library.
*/

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_test_harness.h
*
* \brief Test suite related functions of SDL test framework.
* Test suite related functions of SDL test framework.
*
* This code is a part of the SDL test library, not the main SDL library.
*/
@@ -99,7 +99,7 @@ typedef struct SDLTest_TestSuiteReference {
/**
* \brief Generates a random run seed string for the harness. The generated seed will contain alphanumeric characters (0-9A-Z).
* Generates a random run seed string for the harness. The generated seed will contain alphanumeric characters (0-9A-Z).
*
* Note: The returned string needs to be deallocated by the caller.
*
@@ -110,7 +110,7 @@ typedef struct SDLTest_TestSuiteReference {
char *SDLTest_GenerateRunSeed(const int length);
/**
* \brief Execute a test suite using the given run seed and execution key.
* Execute a test suite using the given run seed and execution key.
*
* \param testSuites Suites containing the test case.
* \param userRunSeed Custom run seed provided by user, or NULL to autogenerate one.

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_test_log.h
*
* \brief Logging related functions of SDL test framework.
* Logging related functions of SDL test framework.
*
* This code is a part of the SDL test library, not the main SDL library.
*/
@@ -43,14 +43,14 @@ extern "C" {
#endif
/**
* \brief Prints given message with a timestamp in the TEST category and INFO priority.
* Prints given message with a timestamp in the TEST category and INFO priority.
*
* \param fmt Message to be logged
*/
void SDLTest_Log(SDL_PRINTF_FORMAT_STRING const char *fmt, ...) SDL_PRINTF_VARARG_FUNC(1);
/**
* \brief Prints given message with a timestamp in the TEST category and the ERROR priority.
* Prints given message with a timestamp in the TEST category and the ERROR priority.
*
* \param fmt Message to be logged
*/

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_test_md5.h
*
* \brief MD5 related functions of SDL test framework.
* MD5 related functions of SDL test framework.
*
* This code is a part of the SDL test library, not the main SDL library.
*/
@@ -78,7 +78,7 @@ extern "C" {
/* ---------- Function Prototypes ------------- */
/**
* \brief initialize the context
* initialize the context
*
* \param mdContext pointer to context variable
*
@@ -90,7 +90,7 @@ extern "C" {
/**
* \brief update digest from variable length data
* update digest from variable length data
*
* \param mdContext pointer to context variable
* \param inBuf pointer to data array/string
@@ -106,7 +106,7 @@ extern "C" {
/**
* \brief complete digest computation
* complete digest computation
*
* \param mdContext pointer to context variable
*

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_test_memory.h
*
* \brief Memory tracking related functions of SDL test framework.
* Memory tracking related functions of SDL test framework.
*
* This code is a part of the SDL test library, not the main SDL library.
*/
@@ -38,21 +38,21 @@ extern "C" {
/**
* \brief Start tracking SDL memory allocations
* Start tracking SDL memory allocations
*
* \note This should be called before any other SDL functions for complete tracking coverage
*/
void SDLTest_TrackAllocations(void);
/**
* \brief Fill allocations with random data
* Fill allocations with random data
*
* \note This implicitly calls SDLTest_TrackAllocations()
*/
void SDLTest_RandFillAllocations();
/**
* \brief Print a log of any outstanding allocations
* Print a log of any outstanding allocations
*
* \note This can be called after SDL_Quit()
*/

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_test_random.h
*
* \brief Random number generator related function of SDL test framework.
* Random number generator related function of SDL test framework.
*
* This code is a part of the SDL test library, not the main SDL library.
*/
@@ -68,7 +68,7 @@ extern "C" {
/* --- Function prototypes */
/**
* \brief Initialize random number generator with two integers.
* Initialize random number generator with two integers.
*
* Note: The random sequence of numbers returned by ...Random() is the
* same for the same two integers and has a period of 2^31.
@@ -81,7 +81,7 @@ extern "C" {
void SDLTest_RandomInit(SDLTest_RandomContext *rndContext, unsigned int xi, unsigned int ci);
/**
* \brief Initialize random number generator based on current system time.
* Initialize random number generator based on current system time.
*
* \param rndContext pointer to context structure
*
@@ -90,7 +90,7 @@ extern "C" {
/**
* \brief Initialize random number generator based on current system time.
* Initialize random number generator based on current system time.
*
* Note: ...RandomInit() or ...RandomInitTime() must have been called
* before using this function.

View File

@@ -25,7 +25,7 @@
/**
* \file SDL_thread.h
*
* \brief Header for the SDL thread management routines.
* Header for the SDL thread management routines.
*/
#include <SDL3/SDL_stdinc.h>

View File

@@ -25,7 +25,7 @@
/**
* \file SDL_timer.h
*
* \brief Header for the SDL time management routines.
* Header for the SDL time management routines.
*/
#include <SDL3/SDL_stdinc.h>

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_touch.h
*
* \brief Include file for SDL touch event handling.
* Include file for SDL touch event handling.
*/
#ifndef SDL_touch_h_

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_version.h
*
* \brief This header defines the current SDL version.
* This header defines the current SDL version.
*/
#ifndef SDL_version_h_

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_video.h
*
* \brief Header file for SDL video functions.
* Header file for SDL video functions.
*/
#ifndef SDL_video_h_
@@ -45,7 +45,7 @@ typedef Uint32 SDL_DisplayID;
typedef Uint32 SDL_WindowID;
/**
* \brief System theme
* System theme
*/
typedef enum
{
@@ -55,7 +55,7 @@ typedef enum
} SDL_SystemTheme;
/**
* \brief The structure that defines a display mode
* The structure that defines a display mode
*
* \sa SDL_GetFullscreenDisplayModes()
* \sa SDL_GetDesktopDisplayMode()
@@ -75,7 +75,7 @@ typedef struct
} SDL_DisplayMode;
/**
* \brief Display orientation
* Display orientation
*/
typedef enum
{
@@ -87,7 +87,7 @@ typedef enum
} SDL_DisplayOrientation;
/**
* \brief The type used to identify a window
* The type used to identify a window
*
* \sa SDL_CreateWindow()
* \sa SDL_CreateWindowFrom()
@@ -122,7 +122,7 @@ typedef enum
typedef struct SDL_Window SDL_Window;
/**
* \brief The flags on a window
* The flags on a window
*
* \sa SDL_GetWindowFlags()
*/
@@ -155,7 +155,7 @@ typedef enum
} SDL_WindowFlags;
/**
* \brief Used to indicate that you don't care what the window position is.
* Used to indicate that you don't care what the window position is.
*/
#define SDL_WINDOWPOS_UNDEFINED_MASK 0x1FFF0000u
#define SDL_WINDOWPOS_UNDEFINED_DISPLAY(X) (SDL_WINDOWPOS_UNDEFINED_MASK|(X))
@@ -164,7 +164,7 @@ typedef enum
(((X)&0xFFFF0000) == SDL_WINDOWPOS_UNDEFINED_MASK)
/**
* \brief Used to indicate that the window position should be centered.
* Used to indicate that the window position should be centered.
*/
#define SDL_WINDOWPOS_CENTERED_MASK 0x2FFF0000u
#define SDL_WINDOWPOS_CENTERED_DISPLAY(X) (SDL_WINDOWPOS_CENTERED_MASK|(X))
@@ -173,7 +173,7 @@ typedef enum
(((X)&0xFFFF0000) == SDL_WINDOWPOS_CENTERED_MASK)
/**
* \brief Window flash operation
* Window flash operation
*/
typedef enum
{
@@ -183,12 +183,12 @@ typedef enum
} SDL_FlashOperation;
/**
* \brief An opaque handle to an OpenGL context.
* An opaque handle to an OpenGL context.
*/
typedef void *SDL_GLContext;
/**
* \brief Opaque EGL types.
* Opaque EGL types.
*/
typedef void *SDL_EGLDisplay;
typedef void *SDL_EGLConfig;
@@ -197,13 +197,13 @@ typedef intptr_t SDL_EGLAttrib;
typedef int SDL_EGLint;
/**
* \brief EGL attribute initialization callback types.
* EGL attribute initialization callback types.
*/
typedef SDL_EGLAttrib *(SDLCALL *SDL_EGLAttribArrayCallback)(void);
typedef SDL_EGLint *(SDLCALL *SDL_EGLIntArrayCallback)(void);
/**
* \brief OpenGL configuration attributes
* OpenGL configuration attributes
*/
typedef enum
{

View File

@@ -22,7 +22,7 @@
/**
* \file SDL_vulkan.h
*
* \brief Header file for functions to creating Vulkan surfaces on SDL windows.
* Header file for functions to creating Vulkan surfaces on SDL windows.
*/
#ifndef SDL_vulkan_h_