All Types

"The following type designates an unsigned integer type [or signed respectivly] with the property that any valid pointer to void can be converted to this type, then converted back to a pointer to void, and the result will compare equal to the original pointer: uintptr_t" Source: https://pubs.opengroup.org/onlinepubs/000095399/basedefs/stdint.h.html

"The following type designates an unsigned integer type [or signed respectivly] with the property that any valid pointer to void can be converted to this type, then converted back to a pointer to void, and the result will compare equal to the original pointer: uintptr_t" Source: https://pubs.opengroup.org/onlinepubs/000095399/basedefs/stdint.h.html

"The following type designates an unsigned integer type [or signed respectivly] with the property that any valid pointer to void can be converted to this type, then converted back to a pointer to void, and the result will compare equal to the original pointer: uintptr_t" Source: https://pubs.opengroup.org/onlinepubs/000095399/basedefs/stdint.h.html

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.

General event structure

trackpad with relative device coordinates *

\brief Window flash operation

A rectangle, with the origin at the upper left. (floating point)

The gamecontroller structure used to identify an SDL game controller *

2.24.0 from "sdl_gesture.h"

An opaque handle to an OpenGL context.

SDL_Haptic

The haptic structure used to identify an SDL haptic.

SDL_HapticOpen SDL_HapticOpenFromJoystick SDL_HapticClose

A structure containing a template for a Constant effect.

The struct is exclusive to the ::SDL_HAPTIC_CONSTANT effect.

A constant effect applies a constant force in the specified direction to the joystick.

SDL_HAPTIC_CONSTANT SDL_HapticEffect

Structure that represents a haptic direction.

Directions can be specified by: - SDL_HAPTIC_POLAR : Specified by polar coordinates. - SDL_HAPTIC_CARTESIAN : Specified by cartesian coordinates. - SDL_HAPTIC_SPHERICAL : Specified by spherical coordinates.

Cardinal directions of the haptic device are relative to the positioning of the device. North is considered to be away from the user.

The following diagram represents the cardinal directions:

.–. |__| .——-. |=.| |.—–.| |–| || || | | |'—–'| |__|˜')_____(' [ COMPUTER ]

North (0,-1) ˆ | | (1,0) West <—-[ HAPTIC ]—-> East (-1,0) | | v South (0,1)

[ USER ] \|||/ (o o) —ooO-(_)-Ooo—

If type is SDL_HAPTIC_POLAR, direction is encoded by hundredths of a degree starting north and turning clockwise. ::SDL_HAPTIC_POLAR only uses the first dir parameter. The cardinal directions would be: - North: 0 (0 degrees) - East: 9000 (90 degrees) - South: 18000 (180 degrees) - West: 27000 (270 degrees)

If type is SDL_HAPTIC_CARTESIAN, direction is encoded by three positions (X axis, Y axis and Z axis (with 3 axes)). ::SDL_HAPTIC_CARTESIAN uses the first three dir parameters. The cardinal directions would be: - North: 0,-1, 0 - East: -1, 0, 0 - South: 0, 1, 0 - West: 1, 0, 0

The Z axis represents the height of the effect if supported, otherwise it's unused. In cartesian encoding (1, 2) would be the same as (2, 4), you can use any multiple you want, only the direction matters.

If type is SDL_HAPTIC_SPHERICAL, direction is encoded by two rotations. The first two dir parameters are used. The dir parameters are as follows (all values are in hundredths of degrees): - Degrees from (1, 0) rotated towards (0, 1). - Degrees towards (0, 0, 1) (device needs at least 3 axes).

Example of force coming from the south with all encodings (force coming from the south means the user will have to pull the stick to counteract):

SDL_HapticDirection direction;

// Cartesian directions direction.type = SDL_HAPTIC_CARTESIAN; // Using cartesian direction encoding. direction.dir[0] = 0; // X position direction.dir[1] = 1; // Y position // Assuming the device has 2 axes, we don't need to specify third parameter.

// Polar directions direction.type = SDL_HAPTIC_POLAR; // We'll be using polar direction encoding. direction.dir[0] = 18000; // Polar only uses first parameter

// Spherical coordinates direction.type = SDL_HAPTIC_SPHERICAL; // Spherical encoding direction.dir[0] = 9000; // Since we only have two axes we don't need more parameters.

SDL_HAPTIC_POLAR SDL_HAPTIC_CARTESIAN SDL_HAPTIC_SPHERICAL SDL_HapticEffect SDL_HapticNumAxes

A structure containing a template for a Periodic effect.

The struct handles the following effects: - SDL_HAPTIC_SINE - SDL_HAPTIC_SQUARE - SDL_HAPTIC_TRIANGLE - SDL_HAPTIC_SAWTOOTHUP - SDL_HAPTIC_SAWTOOTHDOWN

A periodic effect consists in a wave-shaped effect that repeats itself over time. The type determines the shape of the wave and the parameters determine the dimensions of the wave.

Phase is given by hundredth of a cycle meaning that giving the phase a value of 9000 will displace it 25% of its period. Here are sample values: - 0: No phase displacement. - 9000: Displaced 25% of its period. - 18000: Displaced 50% of its period. - 27000: Displaced 75% of its period. - 36000: Displaced 100% of its period, same as 0, but 0 is preferred.

Examples:

SDL_HAPTIC_SINE __ __ __ __ / \ / \ / \ / / \__/ \__/ \__/

SDL_HAPTIC_SQUARE __ __ __ __ __ | | | | | | | | | | | |__| |__| |__| |__| |

SDL_HAPTIC_TRIANGLE /\ /\ /\ /\ /\ / \ / \ / \ / \ / / \/ \/ \/ \/

SDL_HAPTIC_SAWTOOTHUP /| /| /| /| /| /| /| / | / | / | / | / | / | / | / |/ |/ |/ |/ |/ |/ |

SDL_HAPTIC_SAWTOOTHDOWN \ |\ |\ |\ |\ |\ |\ | \ | \ | \ | \ | \ | \ | \ | \| \| \| \| \| \| \|

SDL_HAPTIC_SINE SDL_HAPTIC_SQUARE SDL_HAPTIC_TRIANGLE SDL_HAPTIC_SAWTOOTHUP SDL_HAPTIC_SAWTOOTHDOWN SDL_HapticEffect

/** \brief Add a function to watch a particular hint

\param name The hint to watch \param callback The function to call when the hint value changes \param userdata A pointer to pass to the callback function /

\brief Callback used for hit-testing.

\sa SDL_SetWindowHitTest

2.24.0 based on "sdl.h"

Joystick trackball motion event structure (event.jball.*)

Joystick button event structure (event.jbutton.*)

Joystick hat position change event structure (event.jhat.*)

A structure that encodes the stable unique id for a joystick device *

Keyboard button event structure (event.key.*)

Enumeration of valid key mods (possibly OR'd together).

2.24.0 based on SDL_locale.h

\brief The prototype for the log output function

Flags for SDL_MessageBoxButtonData.

A set of colors to use for message box dialogs

MessageBox structure containing title, text, window, etc.

Mouse button event structure (event.button.*)

Multiple Finger Gesture Event (event.mgesture.*)

Packed component layout. *

Pixel type. *

The basic state for the system's power supply.

A structure representing rendering state

Information on the capabilities of a render driver or context.

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 function passed to SDL_CreateThread().

\param data what was passed as `data` to SDL_CreateThread() \returns a value that can be reported through SDL_WaitThread().

The SDL thread priority.

SDL will make system changes as necessary in order to apply the thread priority. Code which attempts to control thread state related to priority should be aware that calling SDL_SetThreadPriority may alter such state. SDL_HINT_THREAD_PRIORITY_POLICY can be used to control aspects of this behavior.

\note On many systems you require special privileges to set high or time critical priority.

Definition of the timer ID type.

2.0.18 from "sdl_touch.h"

Information the version of SDL in use.

Represents the library's version as three levels: major revision (increments with massive changes, additions, and enhancements), minor revision (increments with backwards-compatible changes to the major revision), and patchlevel (increments with fixes to the minor revision).

SDL_VERSION SDL_GetVersion

Window state change event data (event.window.*)

The flags on a window

SDL_GetWindowFlags()

A union containing parameters for shaped windows. *

The internal structure containing font information *

Data types for all compilers

Data types for all compilers

Data types for all compilers

this is opaque to the outside world.

The condition variable type.

Typical use of condition variables:

Thread A: SDL_LockMutex(lock); while ( not condition ) begin SDL_CondWait(cond, lock); end; SDL_UnlockMutex(lock);

Thread B: SDL_LockMutex(lock); ... condition := true; ... SDL_CondSignal(cond); SDL_UnlockMutex(lock);

There is some discussion whether to signal the condition variable with the mutex locked or not. There is some potential performance benefit to unlocking first on some platforms, but there are some potential race conditions depending on how your code is structured.

In general it's safer to signal the condition variable while the mutex is locked.

\brief A handle representing an open HID device.

Close and free an allocated SDL_RWops structure.

0 if successful or -1 on write error when flushing data.

Read up to maxnum objects each of size size from the data stream to the area pointed at by ptr.

the number of objects read, or 0 at error or end of file.

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

SDL2-For-Pascal: This function pointer is introduced to specifiy the destructor pointer in the SDL_TLSSet function according to C headers.

The TTLSDestructor type itself is not defined by the original SDL2 headers.

The structure that defines an extended virtual joystick description

The caller must zero the structure and then initialize the version with `SDL_VIRTUAL_JOYSTICK_DESC_VERSION` before passing it to SDL_JoystickAttachVirtualEx() All other elements of this structure are optional and can be left 0.

\sa SDL_JoystickAttachVirtualEx

Write exactly num objects each of size size from the area pointed at by ptr to data stream.

the number of objects written, or 0 at error or end of file.