All Types

wchar_t is the "wide character" type of the C language. The size of this type is platform- and compiler-dependent.

While FPC does have it's own "wide character" type, System.WideChar, that one is defined as always being 16-bits, so we can't re-use it here.

When using FPC on Unices, the UnixType unit provides a wchar_t definition.

On other systems/compiler combos, let's just go by what the CPP reference wiki claims, i.e: - wchar_t is 16-bits on Windows - wchar_t is 32-bits on Linux "and many other non-Windows systems"

See: https://en.cppreference.com/w/cpp/language/types#Character_types

Add your own callback when a channel has finished playing. NULL to disable callback. The callback may be called from the mixer's audio callback or it could be called as a result of Mix_HaltChannel(), etc. do not call SDL_LockAudio() from this callback; you will either be inside the audio callback, or SDL_mixer will explicitly lock the audio before calling your callback.

This is a callback that signifies that a channel has finished all its loops and has completed playback. This gets called if the buffer plays out normally, or if you call Mix_HaltChannel(), implicitly stop a channel via Mix_AllocateChannels(), or unregister a callback while it's still playing.

DO NOT EVER call SDL_LockAudio() from your callback function!

The different fading types supported *

// Removed in SDL2_mixer 2.0.2 MIX_INIT_MODPLUG = $00000004; MIX_INIT_FLUIDSYNTH = $00000020;

Array component order, low byte -> high byte. *

This function is called when the audio device needs more data.

\param userdata An application-specific parameter saved in the SDL_AudioSpec structure \param stream A pointer to the audio data buffer. \param len The length of that buffer in bytes.

Once the callback returns, the buffer will no longer be valid. Stereo samples are stored in a LRLRLR ordering.

You can choose to avoid callbacks and use SDL_QueueAudio() instead, if you like. Just open your audio device with a NULL callback.

Audio device event structure (event.adevice.*)

Audio format flags.

These are what the 16 bits in SDL_AudioFormat currently mean... (Unspecified bits are always zero).

++———————–sample is signed if set || || ++———–sample is bigendian if set || || || || ++—sample is float if set || || || || || || +—sample bit size—+ || || || | | 15 14 13 12 11 10 09 08 07 06 05 04 03 02 01 00

There are macros in SDL 2.0 and later to query these bits.

Audio state

Get the current audio state.

\brief The normalized factor used to multiply pixel components

\brief The blend operation used when combining source and destination pixel components

A collection of pixels used in software blitting.

This structure should be treated as read-only, except for \c pixels, which, if not NULL, contains the raw pixel data for the surface.

The SDL condition variable structure, defined in SDL_cond.c

Game controller button event structure (event.cbutton.*)

Game controller sensor event structure (event.csensor.*)

2.24.1 from "sdl_mouse.h"

\brief Event subtype for display events

< Display has been removed from the system *

An event used to request a file open by the system (event.drop.*) This event is disabled by default, you can enable it with SDL_EventState() If you enable this event, you must free the filename in the event.

#define SDL_OutOfMemory() SDL_Error(SDL_ENOMEM) #define SDL_Unsupported() SDL_Error(SDL_UNSUPPORTED) #define SDL_InvalidParamError(param) SDL_SetError("Parameter '%s' is invalid", (param))

2.26.5 from "sdl_events.h"

\brief The structure that defines a point (floating point)

\sa SDL_EnclosePoints \sa SDL_PointInRect

The list of axes available from a controller

The list of buttons available from a controller

OpenGL configuration attributes

An SDL_GUID is a 128-bit identifier for an input device that identifies that device across runs of SDL programs on the same platform. If the device is detached and then re-attached to a different port, or if the base system is rebooted, the device should still report the same GUID.

GUIDs are as precise as possible but are not guaranteed to distinguish physically distinct but equivalent devices. For example, two game controllers from the same vendor with the same product ID and revision may have the same GUID.

GUIDs may be platform-dependent (i.e., the same device may report different GUIDs on different operating systems).

A structure containing a template for a Condition effect.

The struct handles the following effects: - SDL_HAPTIC_SPRING: Effect based on axes position. - SDL_HAPTIC_DAMPER: Effect based on axes velocity. - SDL_HAPTIC_INERTIA: Effect based on axes acceleration. - SDL_HAPTIC_FRICTION: Effect based on axes movement.

Direction is handled by condition internals instead of a direction member. The condition effect specific members have three parameters. The first refers to the X axis, the second refers to the Y axis and the third refers to the Z axis. The right terms refer to the positive side of the axis and the left terms refer to the negative side of the axis. Please refer to the ::SDL_HapticDirection diagram for which side is positive and which is negative.

SDL_HapticDirection SDL_HAPTIC_SPRING SDL_HAPTIC_DAMPER SDL_HAPTIC_INERTIA SDL_HAPTIC_FRICTION SDL_HapticEffect

A structure containing a template for the ::SDL_HAPTIC_CUSTOM effect.

A custom force feedback effect is much like a periodic effect, where the application can define its exact shape. You will have to allocate the data yourself. Data should consist of channels * samples Uint16 samples.

If channels is one, the effect is rotated using the defined direction. Otherwise it uses the samples in data for the different axes.

SDL_HAPTIC_CUSTOM SDL_HapticEffect

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.

You can also pass SDL_HAPTIC_INFINITY to length instead of a 0-32767 value. Neither delay, interval, attack_length nor fade_length support SDL_HAPTIC_INFINITY. Fade will also not be used since effect never ends.

Additionally, the SDL_HAPTIC_RAMP effect does not support a duration of SDL_HAPTIC_INFINITY.

Button triggers may not be supported on all devices, it is advised to not use them if possible. Buttons start at index 1 instead of index 0 like the joystick.

If both attack_length and fade_level are 0, the envelope is not used, otherwise both values are used.

Common parts:

// Replay - All effects have this Uint32 length; // Duration of effect (ms). Uint16 delay; // Delay before starting effect.

// Trigger - All effects have this Uint16 button; // Button that triggers effect. Uint16 interval; // How soon before effect can be triggered again.

// Envelope - All effects except condition effects have this Uint16 attack_length; // Duration of the attack (ms). Uint16 attack_level; // Level at the start of the attack. Uint16 fade_length; // Duration of the fade out (ms). Uint16 fade_level; // Level at the end of the fade.

Here we have an example of a constant effect evolution in time:

Strength ˆ | | effect level –> _________________ | / \ | / \ | / \ | / \ | attack_level –> | \ | | | <— fade_level | +————————————————–> Time [–] [—] attack_length fade_length

[——————][———————–] delay length

Note either the attack_level or the fade_level may be above the actual effect level.

SDL_HapticConstant SDL_HapticPeriodic SDL_HapticCondition SDL_HapticRamp SDL_HapticCustom

A structure containing a template for a Ramp effect.

This struct is exclusively for the ::SDL_HAPTIC_RAMP effect.

The ramp effect starts at start strength and ends at end strength. It augments in linear fashion. If you use attack and fade with a ramp the effects get added to the ramp effect making the effect become quadratic instead of linear.

SDL_HAPTIC_RAMP SDL_HapticEffect

/** \brief An enumeration of hint priorities /

\brief Possible return values from the SDL_HitTest callback.

\sa SDL_HitTest

Joystick axis motion event structure (event.jaxis.*)

Joysick battery level change event structure (event.jbattery.*)

Joystick device event structure (event.jdevice.*)

The joystick structure used to identify an SDL joystick *

This is a unique ID for a joystick for the time it is connected to the system, and is never reused for the lifetime of the application. If the joystick is disconnected and reconnected, it will get a new ID.

The ID value starts at 0 and increments from there. The value -1 is an invalid ID.

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 the unmodified character that would be generated by pressing the key, or an SDLK_* constant for those keys that do not generate characters.

A special exception is the number keys at the top of the keyboard which always map to SDLK_0...SDLK_9, regardless of layout.

\brief The SDL keysym structure, used in key events.

\note If you are looking for translated character input, see the:: SDL_TEXTINPUT event.

\brief 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 at the VERBOSE level and all other categories are enabled at the CRITICAL level.

\brief The predefined log priorities

Individual button data.

RGB value used in a message box color scheme

SDL_MessageBox flags. If supported will display warning icon, etc.

Mouse motion event structure (event.motion.*)

Mouse wheel event structure (event.wheel.*)

The SDL mutex structure, defined in SDL_sysmutex.c

Packed component order, high bit -> low bit. *

Everything in the pixel format structure is read-only.

\brief The structure that defines a point (integer)

\sa SDL_EnclosePoints \sa SDL_PointInRect

The "quit requested" event

\brief A rectangle, with the origin at the upper left (integer).

\sa SDL_RectEmpty \sa SDL_RectEquals \sa SDL_HasIntersection \sa SDL_IntersectRect \sa SDL_UnionRect \sa SDL_EnclosePoints

< The renderer supports rendering to texture *

Read-Only memory stream *

The SDL keyboard scancode representation.

Values of this type are used to represent keyboard keys, among other places in the SDL_Keysym.scancode key.keysym.scancode \endlink field of the SDL_Event structure.

The values in this enumeration are based on the USB usage page standard: https://www.usb.org/sites/default/files/documents/hut1_12v2.pdf

\brief 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.

This is a unique ID for a sensor for the time it is connected to the system, and is never reused for the lifetime of the application.

The ID value starts at 0 and increments from there. The value -1 is an invalid ID.

Atomic locks are efficient spinlocks using CPU instructions, but are vulnerable to starvation and can spin forever if a thread holding a lock has been terminated. For this reason you should minimize the code executed inside an atomic lock and never do expensive things like API or system calls while holding them.

The atomic locks are not safe to lock recursively.

Cursor types for SDL_CreateSystemCursor.

The custom window manager information structure.

When this structure is returned, it holds information about which low level system it is using, and will be one of SDL_SYSWM_TYPE.

Keyboard text editing event structure (event.edit.*)

Keyboard text input event structure (event.text.*)

The access pattern allowed for a texture.

The SDL thread ID *

Function prototype for the timer callback function.

The callback function is passed the current timer interval and returns the next timer interval. If the returned value is the same as the one passed in, the periodic alarm continues, otherwise a new alarm is scheduled. If the callback returns 0, the periodic alarm is cancelled.

Thread local storage ID, 0 is the invalid ID *

Touch finger event structure (event.tfinger.*)

A user-defined event type (event.user.*)

2.0.14 from "sdl_video.h"

Event subtype for window events

A struct that tags the SDL_WindowShapeParams union with an enum describing the type of its contents. *

Direction flags

\sa TTF_SetFontDirection

Data types for all compilers

Data types for all compilers

Data types for all compilers

\brief An enum denoting the specific type of contents present in an SDL_WindowShapeParams union. *

\brief A handle representing an open HID device.

These are the various supported windowing subsystems

Seek to offset relative to whence, one of stdio's whence values: RW_SEEK_SET, RW_SEEK_CUR, RW_SEEK_END

the final offset in the data stream, or -1 on error.

Return the size of the file in this rwops, or -1 if unknown