From 973fe73bbc80ea77b30d3b3b149857acc68c3367 Mon Sep 17 00:00:00 2001 From: "Ryan C. Gordon" Date: Tue, 23 Apr 2024 12:21:35 -0400 Subject: [PATCH] SDL2: Convert `'''MediaWiki Bold'''` to `**Markdown Bold**`. --- SDL2/SDL_AudioDeviceEvent.md | 12 ++--- SDL2/SDL_AudioSpec.md | 20 +++---- SDL2/SDL_Color.md | 12 ++--- SDL2/SDL_ControllerAxisEvent.md | 14 ++--- SDL2/SDL_ControllerButtonEvent.md | 14 ++--- SDL2/SDL_ControllerDeviceEvent.md | 10 ++-- SDL2/SDL_DisplayMode.md | 14 ++--- SDL2/SDL_DollarGestureEvent.md | 20 +++---- SDL2/SDL_DropEvent.md | 12 ++--- SDL2/SDL_Event.md | 56 ++++++++++---------- SDL2/SDL_EventFilter.md | 8 +-- SDL2/SDL_FPoint.md | 8 +-- SDL2/SDL_FRect.md | 12 ++--- SDL2/SDL_GameControllerButtonBind.md | 14 ++--- SDL2/SDL_HapticCondition.md | 36 ++++++------- SDL2/SDL_HapticConstant.md | 36 ++++++------- SDL2/SDL_HapticCustom.md | 42 +++++++-------- SDL2/SDL_HapticDirection.md | 10 ++-- SDL2/SDL_HapticEffect.md | 18 +++---- SDL2/SDL_HapticLeftRight.md | 18 +++---- SDL2/SDL_HapticPeriodic.md | 42 +++++++-------- SDL2/SDL_HapticRamp.md | 38 +++++++------- SDL2/SDL_JoyAxisEvent.md | 14 ++--- SDL2/SDL_JoyBallEvent.md | 16 +++--- SDL2/SDL_JoyButtonEvent.md | 14 ++--- SDL2/SDL_JoyDeviceEvent.md | 10 ++-- SDL2/SDL_JoyHatEvent.md | 14 ++--- SDL2/SDL_KeyboardEvent.md | 16 +++--- SDL2/SDL_Keysym.md | 12 ++--- SDL2/SDL_MessageBoxButtonData.md | 10 ++-- SDL2/SDL_MessageBoxColor.md | 10 ++-- SDL2/SDL_MessageBoxColorScheme.md | 6 +-- SDL2/SDL_MessageBoxData.md | 18 +++---- SDL2/SDL_MouseButtonEvent.md | 22 ++++---- SDL2/SDL_MouseMotionEvent.md | 22 ++++---- SDL2/SDL_MouseWheelEvent.md | 22 ++++---- SDL2/SDL_MultiGestureEvent.md | 20 +++---- SDL2/SDL_Point.md | 8 +-- SDL2/SDL_QuitEvent.md | 8 +-- SDL2/SDL_RWops.md | 18 +++---- SDL2/SDL_Rect.md | 12 ++--- SDL2/SDL_RendererInfo.md | 16 +++--- SDL2/SDL_SensorEvent.md | 12 ++--- SDL2/SDL_Surface.md | 26 +++++----- SDL2/SDL_SysWMEvent.md | 10 ++-- SDL2/SDL_SysWMinfo.md | 78 ++++++++++++++-------------- SDL2/SDL_SysWMmsg.md | 42 +++++++-------- SDL2/SDL_TextEditingEvent.md | 16 +++--- SDL2/SDL_TextInputEvent.md | 12 ++--- SDL2/SDL_TouchFingerEvent.md | 24 ++++----- SDL2/SDL_UserEvent.md | 16 +++--- SDL2/SDL_Vertex.md | 10 ++-- SDL2/SDL_WindowEvent.md | 16 +++--- SDL2/SDL_atomic_t.md | 6 +-- 54 files changed, 511 insertions(+), 511 deletions(-) diff --git a/SDL2/SDL_AudioDeviceEvent.md b/SDL2/SDL_AudioDeviceEvent.md index 0e2c158b8..e59dc3026 100644 --- a/SDL2/SDL_AudioDeviceEvent.md +++ b/SDL2/SDL_AudioDeviceEvent.md @@ -31,12 +31,12 @@ typedef struct SDL_AudioDeviceEvent ## Data Fields -| | | | -| ------ | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Uint32 | '''type''' | SDL_AUDIODEVICEADDED, or SDL_AUDIODEVICEREMOVED | -| Uint32 | '''timestamp''' | the timestamp of the event | -| Uint32 | '''which''' | the audio device index for the SDL_AUDIODEVICEADDED event (valid until next [SDL_GetNumAudioDevices](SDL_GetNumAudioDevices)() call), SDL_AudioDeviceID for the SDL_AUDIODEVICEREMOVED event | -| Uint8 | '''iscapture''' | zero if an audio output device, non-zero if an audio capture device | +| | | | +| ------ | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Uint32 | **type** | SDL_AUDIODEVICEADDED, or SDL_AUDIODEVICEREMOVED | +| Uint32 | **timestamp** | the timestamp of the event | +| Uint32 | **which** | the audio device index for the SDL_AUDIODEVICEADDED event (valid until next [SDL_GetNumAudioDevices](SDL_GetNumAudioDevices)() call), SDL_AudioDeviceID for the SDL_AUDIODEVICEREMOVED event | +| Uint8 | **iscapture** | zero if an audio output device, non-zero if an audio capture device | ## Related Enumerations diff --git a/SDL2/SDL_AudioSpec.md b/SDL2/SDL_AudioSpec.md index 69074af2e..c7d20c9bc 100644 --- a/SDL2/SDL_AudioSpec.md +++ b/SDL2/SDL_AudioSpec.md @@ -50,16 +50,16 @@ dev = SDL_OpenAudioDevice(NULL, 0, &want, &have, SDL_AUDIO_ALLOW_FORMAT_CHANGE); ## Data Fields -| | | | -| ---------------------------------- | -------------- | ----------------------------------------------------------------------------------- | -| int | '''freq''' | DSP frequency (samples per second); see Remarks for details | -| [SDL_AudioFormat](SDL_AudioFormat) | '''format''' | audio data format; see Remarks for details | -| Uint8 | '''channels''' | number of separate sound channels: see Remarks for details | -| Uint8 | '''silence''' | audio buffer silence value (calculated) | -| Uint16 | '''samples''' | audio buffer size in samples (power of 2); see Remarks for details | -| Uint32 | '''size''' | audio buffer size in bytes (calculated) | -| SDL_AudioCallback | '''callback''' | the function to call when the audio device needs more data; see Remarks for details | -| void* | '''userdata''' | a pointer that is passed to '''callback''' (otherwise ignored by SDL) | +| | | | +| ---------------------------------- | ------------ | ----------------------------------------------------------------------------------- | +| int | **freq** | DSP frequency (samples per second); see Remarks for details | +| [SDL_AudioFormat](SDL_AudioFormat) | **format** | audio data format; see Remarks for details | +| Uint8 | **channels** | number of separate sound channels: see Remarks for details | +| Uint8 | **silence** | audio buffer silence value (calculated) | +| Uint16 | **samples** | audio buffer size in samples (power of 2); see Remarks for details | +| Uint32 | **size** | audio buffer size in bytes (calculated) | +| SDL_AudioCallback | **callback** | the function to call when the audio device needs more data; see Remarks for details | +| void* | **userdata** | a pointer that is passed to **callback** (otherwise ignored by SDL) | ---- [CategoryAPI](CategoryAPI), [CategoryAPIStruct](CategoryAPIStruct), [CategoryStruct](CategoryStruct), [CategoryAudio](CategoryAudio) diff --git a/SDL2/SDL_Color.md b/SDL2/SDL_Color.md index df3388ff7..c20572752 100644 --- a/SDL2/SDL_Color.md +++ b/SDL2/SDL_Color.md @@ -21,12 +21,12 @@ typedef struct SDL_Color ## Data Fields -| | | | -| ----- | ------- | -------------------------------------- | -| Uint8 | '''r''' | the red component in the range 0-255 | -| Uint8 | '''g''' | the green component in the range 0-255 | -| Uint8 | '''b''' | the blue component in the range 0-255 | -| Uint8 | '''a''' | the alpha component in the range 0-255 | +| | | | +| ----- | ----- | -------------------------------------- | +| Uint8 | **r** | the red component in the range 0-255 | +| Uint8 | **g** | the green component in the range 0-255 | +| Uint8 | **b** | the blue component in the range 0-255 | +| Uint8 | **a** | the alpha component in the range 0-255 | ## Related Structures diff --git a/SDL2/SDL_ControllerAxisEvent.md b/SDL2/SDL_ControllerAxisEvent.md index fa141c4a3..858411e0b 100644 --- a/SDL2/SDL_ControllerAxisEvent.md +++ b/SDL2/SDL_ControllerAxisEvent.md @@ -33,13 +33,13 @@ typedef struct SDL_ControllerAxisEvent ## Data Fields -| | | | -| -------------- | --------------- | ---------------------------------------------------------------------- | -| Uint32 | '''type''' | SDL_CONTROLLERAXISMOTION | -| Uint32 | '''timestamp''' | the timestamp of the event | -| SDL_JoystickID | '''which''' | the joystick instance id | -| Uint8 | '''axis''' | the controller axis ([SDL_GameControllerAxis](SDL_GameControllerAxis)) | -| Sint16 | '''value''' | the axis value (range: -32768 to 32767) | +| | | | +| -------------- | ------------- | ---------------------------------------------------------------------- | +| Uint32 | **type** | SDL_CONTROLLERAXISMOTION | +| Uint32 | **timestamp** | the timestamp of the event | +| SDL_JoystickID | **which** | the joystick instance id | +| Uint8 | **axis** | the controller axis ([SDL_GameControllerAxis](SDL_GameControllerAxis)) | +| Sint16 | **value** | the axis value (range: -32768 to 32767) | ## Related Enumerations diff --git a/SDL2/SDL_ControllerButtonEvent.md b/SDL2/SDL_ControllerButtonEvent.md index ea10d1b8d..102b56b57 100644 --- a/SDL2/SDL_ControllerButtonEvent.md +++ b/SDL2/SDL_ControllerButtonEvent.md @@ -31,13 +31,13 @@ typedef struct SDL_ControllerButtonEvent ## Data Fields -| | | | -| -------------- | --------------- | ---------------------------------------------------------------------------- | -| Uint32 | '''type''' | SDL_CONTROLLERBUTTONDOWN or SDL_CONTROLLERBUTTONUP | -| Uint32 | '''timestamp''' | the timestamp of the event | -| SDL_JoystickID | '''which''' | the joystick instance id | -| Uint8 | '''button''' | the controller button ([SDL_GameControllerButton](SDL_GameControllerButton)) | -| Uint8 | '''state''' | SDL_PRESSED or SDL_RELEASED | +| | | | +| -------------- | ------------- | ---------------------------------------------------------------------------- | +| Uint32 | **type** | SDL_CONTROLLERBUTTONDOWN or SDL_CONTROLLERBUTTONUP | +| Uint32 | **timestamp** | the timestamp of the event | +| SDL_JoystickID | **which** | the joystick instance id | +| Uint8 | **button** | the controller button ([SDL_GameControllerButton](SDL_GameControllerButton)) | +| Uint8 | **state** | SDL_PRESSED or SDL_RELEASED | ## Related Enumerations diff --git a/SDL2/SDL_ControllerDeviceEvent.md b/SDL2/SDL_ControllerDeviceEvent.md index 64af9bd72..769bd8fd4 100644 --- a/SDL2/SDL_ControllerDeviceEvent.md +++ b/SDL2/SDL_ControllerDeviceEvent.md @@ -27,11 +27,11 @@ typedef struct SDL_ControllerDeviceEvent ## Data Fields -| | | | -| ------ | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Uint32 | '''type''' | SDL_CONTROLLERDEVICEADDED, SDL_CONTROLLERDEVICEREMOVED or SDL_CONTROLLERDEVICEREMAPPED | -| Uint32 | '''timestamp''' | the timestamp of the event | -| Sint32 | '''which''' | the joystick device index for the SDL_CONTROLLERDEVICEADDED event or instance id for the SDL_CONTROLLERDEVICEREMOVED or SDL_CONTROLLERDEVICEREMAPPED event | +| | | | +| ------ | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Uint32 | **type** | SDL_CONTROLLERDEVICEADDED, SDL_CONTROLLERDEVICEREMOVED or SDL_CONTROLLERDEVICEREMAPPED | +| Uint32 | **timestamp** | the timestamp of the event | +| Sint32 | **which** | the joystick device index for the SDL_CONTROLLERDEVICEADDED event or instance id for the SDL_CONTROLLERDEVICEREMOVED or SDL_CONTROLLERDEVICEREMAPPED event | ## Related Enumerations diff --git a/SDL2/SDL_DisplayMode.md b/SDL2/SDL_DisplayMode.md index 6f539d0c2..e134981cf 100644 --- a/SDL2/SDL_DisplayMode.md +++ b/SDL2/SDL_DisplayMode.md @@ -65,13 +65,13 @@ for (i = 0; i < display_mode_count; ++i) { ## Data Fields -| | | | -| ------ | ------------------ | ------------------------------------------------------------ | -| Uint32 | '''format''' | one of the [SDL_PixelFormatEnum](SDL_PixelFormatEnum) values | -| int | '''w''' | width, in screen coordinates | -| int | '''h''' | height, in screen coordinates | -| int | '''refresh_rate''' | refresh rate (in Hz), or 0 for unspecified | -| void* | '''driverdata''' | driver-specific data, initialize to 0 | +| | | | +| ------ | ---------------- | ------------------------------------------------------------ | +| Uint32 | **format** | one of the [SDL_PixelFormatEnum](SDL_PixelFormatEnum) values | +| int | **w** | width, in screen coordinates | +| int | **h** | height, in screen coordinates | +| int | **refresh_rate** | refresh rate (in Hz), or 0 for unspecified | +| void* | **driverdata** | driver-specific data, initialize to 0 | ---- [CategoryAPI](CategoryAPI), [CategoryAPIStruct](CategoryAPIStruct), [CategoryStruct](CategoryStruct), [CategoryVideo](CategoryVideo) diff --git a/SDL2/SDL_DollarGestureEvent.md b/SDL2/SDL_DollarGestureEvent.md index 1b16fc35e..3020e2447 100644 --- a/SDL2/SDL_DollarGestureEvent.md +++ b/SDL2/SDL_DollarGestureEvent.md @@ -29,16 +29,16 @@ typedef struct SDL_DollarGestureEvent ## Data Fields -| | | | -| ------------- | ---------------- | ------------------------------------------------------------------------------------------------------------ | -| Uint32 | '''type''' | SDL_DOLLARGESTURE or SDL_DOLLARRECORD | -| Uint32 | '''timestamp''' | timestamp of the event | -| SDL_TouchID | '''touchId''' | the touch device id | -| SDL_GestureID | '''gestureId''' | the unique id of the closest gesture to the performed stroke | -| Uint32 | '''numFingers''' | the number of fingers used to draw the stroke | -| float | '''error''' | the difference between the gesture template and the actual performed gesture (lower error is a better match) | -| float | '''x''' | the normalized center of gesture | -| float | '''y''' | the normalized center of gesture | +| | | | +| ------------- | -------------- | ------------------------------------------------------------------------------------------------------------ | +| Uint32 | **type** | SDL_DOLLARGESTURE or SDL_DOLLARRECORD | +| Uint32 | **timestamp** | timestamp of the event | +| SDL_TouchID | **touchId** | the touch device id | +| SDL_GestureID | **gestureId** | the unique id of the closest gesture to the performed stroke | +| Uint32 | **numFingers** | the number of fingers used to draw the stroke | +| float | **error** | the difference between the gesture template and the actual performed gesture (lower error is a better match) | +| float | **x** | the normalized center of gesture | +| float | **y** | the normalized center of gesture | diff --git a/SDL2/SDL_DropEvent.md b/SDL2/SDL_DropEvent.md index d2a1663e8..13958c0c0 100644 --- a/SDL2/SDL_DropEvent.md +++ b/SDL2/SDL_DropEvent.md @@ -89,12 +89,12 @@ int main(int argc, char *argv[]) { ## Data Fields -| | | | -| ------ | --------------- | ------------------------------------------------------------------------------- | -| Uint32 | '''type''' | the event type; SDL_DROPFILE, SDL_DROPTEXT, SDL_DROPBEGIN, or SDL_DROPCOMPLETE | -| Uint32 | '''timestamp''' | timestamp of the event | -| char* | '''file''' | the file name, which should be freed with SDL_free(), is NULL on BEGIN/COMPLETE | -| Uint32 | '''windowID''' | the window that was dropped on, if any | +| | | | +| ------ | ------------- | ------------------------------------------------------------------------------- | +| Uint32 | **type** | the event type; SDL_DROPFILE, SDL_DROPTEXT, SDL_DROPBEGIN, or SDL_DROPCOMPLETE | +| Uint32 | **timestamp** | timestamp of the event | +| char* | **file** | the file name, which should be freed with SDL_free(), is NULL on BEGIN/COMPLETE | +| Uint32 | **windowID** | the window that was dropped on, if any | ## Related Enumerations diff --git a/SDL2/SDL_Event.md b/SDL2/SDL_Event.md index c3a6b73d3..746445ec9 100644 --- a/SDL2/SDL_Event.md +++ b/SDL2/SDL_Event.md @@ -63,34 +63,34 @@ typedef union SDL_Event ## Data Fields -| | | | -| ------------------------------------------------------ | -------------- | -------------------------------------- | -| Uint32 | '''type''' | event type, shared with all events | -| [SDL_CommonEvent](SDL_CommonEvent) | '''common''' | common event data | -| [SDL_DisplayEvent](SDL_DisplayEvent) | '''display''' | display event data | -| [SDL_WindowEvent](SDL_WindowEvent) | '''window''' | window event data | -| [SDL_KeyboardEvent](SDL_KeyboardEvent) | '''key''' | keyboard event data | -| [SDL_TextEditingEvent](SDL_TextEditingEvent) | '''edit''' | text editing event data | -| [SDL_TextInputEvent](SDL_TextInputEvent) | '''text''' | text input event data | -| [SDL_MouseMotionEvent](SDL_MouseMotionEvent) | '''motion''' | mouse motion event data | -| [SDL_MouseButtonEvent](SDL_MouseButtonEvent) | '''button''' | mouse button event data | -| [SDL_MouseWheelEvent](SDL_MouseWheelEvent) | '''wheel''' | mouse wheel event data | -| [SDL_JoyAxisEvent](SDL_JoyAxisEvent) | '''jaxis''' | joystick axis event data | -| [SDL_JoyBallEvent](SDL_JoyBallEvent) | '''jball''' | joystick ball event data | -| [SDL_JoyHatEvent](SDL_JoyHatEvent) | '''jhat''' | joystick hat event data | -| [SDL_JoyButtonEvent](SDL_JoyButtonEvent) | '''jbutton''' | joystick button event data | -| [SDL_JoyDeviceEvent](SDL_JoyDeviceEvent) | '''jdevice''' | joystick device event data | -| [SDL_ControllerAxisEvent](SDL_ControllerAxisEvent) | '''caxis''' | game controller axis event data | -| [SDL_ControllerButtonEvent](SDL_ControllerButtonEvent) | '''cbutton''' | game controller button event data | -| [SDL_ControllerDeviceEvent](SDL_ControllerDeviceEvent) | '''cdevice''' | game controller device event data | -| [SDL_AudioDeviceEvent](SDL_AudioDeviceEvent) | '''adevice''' | audio device event data (>= SDL 2.0.4) | -| [SDL_QuitEvent](SDL_QuitEvent) | '''quit''' | quit request event data | -| [SDL_UserEvent](SDL_UserEvent) | '''user''' | custom event data | -| [SDL_SysWMEvent](SDL_SysWMEvent) | '''syswm''' | system dependent window event data | -| [SDL_TouchFingerEvent](SDL_TouchFingerEvent) | '''tfinger''' | touch finger event data | -| [SDL_MultiGestureEvent](SDL_MultiGestureEvent) | '''mgesture''' | multi finger gesture data | -| [SDL_DollarGestureEvent](SDL_DollarGestureEvent) | '''dgesture''' | multi finger gesture data | -| [SDL_DropEvent](SDL_DropEvent) | '''drop''' | drag and drop event data | +| | | | +| ------------------------------------------------------ | ------------ | -------------------------------------- | +| Uint32 | **type** | event type, shared with all events | +| [SDL_CommonEvent](SDL_CommonEvent) | **common** | common event data | +| [SDL_DisplayEvent](SDL_DisplayEvent) | **display** | display event data | +| [SDL_WindowEvent](SDL_WindowEvent) | **window** | window event data | +| [SDL_KeyboardEvent](SDL_KeyboardEvent) | **key** | keyboard event data | +| [SDL_TextEditingEvent](SDL_TextEditingEvent) | **edit** | text editing event data | +| [SDL_TextInputEvent](SDL_TextInputEvent) | **text** | text input event data | +| [SDL_MouseMotionEvent](SDL_MouseMotionEvent) | **motion** | mouse motion event data | +| [SDL_MouseButtonEvent](SDL_MouseButtonEvent) | **button** | mouse button event data | +| [SDL_MouseWheelEvent](SDL_MouseWheelEvent) | **wheel** | mouse wheel event data | +| [SDL_JoyAxisEvent](SDL_JoyAxisEvent) | **jaxis** | joystick axis event data | +| [SDL_JoyBallEvent](SDL_JoyBallEvent) | **jball** | joystick ball event data | +| [SDL_JoyHatEvent](SDL_JoyHatEvent) | **jhat** | joystick hat event data | +| [SDL_JoyButtonEvent](SDL_JoyButtonEvent) | **jbutton** | joystick button event data | +| [SDL_JoyDeviceEvent](SDL_JoyDeviceEvent) | **jdevice** | joystick device event data | +| [SDL_ControllerAxisEvent](SDL_ControllerAxisEvent) | **caxis** | game controller axis event data | +| [SDL_ControllerButtonEvent](SDL_ControllerButtonEvent) | **cbutton** | game controller button event data | +| [SDL_ControllerDeviceEvent](SDL_ControllerDeviceEvent) | **cdevice** | game controller device event data | +| [SDL_AudioDeviceEvent](SDL_AudioDeviceEvent) | **adevice** | audio device event data (>= SDL 2.0.4) | +| [SDL_QuitEvent](SDL_QuitEvent) | **quit** | quit request event data | +| [SDL_UserEvent](SDL_UserEvent) | **user** | custom event data | +| [SDL_SysWMEvent](SDL_SysWMEvent) | **syswm** | system dependent window event data | +| [SDL_TouchFingerEvent](SDL_TouchFingerEvent) | **tfinger** | touch finger event data | +| [SDL_MultiGestureEvent](SDL_MultiGestureEvent) | **mgesture** | multi finger gesture data | +| [SDL_DollarGestureEvent](SDL_DollarGestureEvent) | **dgesture** | multi finger gesture data | +| [SDL_DropEvent](SDL_DropEvent) | **drop** | drag and drop event data | ## Related Enumerations diff --git a/SDL2/SDL_EventFilter.md b/SDL2/SDL_EventFilter.md index b9fdd5143..976a2439d 100644 --- a/SDL2/SDL_EventFilter.md +++ b/SDL2/SDL_EventFilter.md @@ -47,10 +47,10 @@ SDL_AddEventWatch(MyEventFunction, NULL); ## Definition Parameters -| | | -| -------------- | ------------------------------------------------------------------------------ | -| '''userdata''' | The data passed by the original call to [SDL_AddEventWatch](SDL_AddEventWatch) | -| '''event''' | The [SDL_Event](SDL_Event) representing the event | +| | | +| ------------ | ------------------------------------------------------------------------------ | +| **userdata** | The data passed by the original call to [SDL_AddEventWatch](SDL_AddEventWatch) | +| **event** | The [SDL_Event](SDL_Event) representing the event | ---- [CategoryAPI](CategoryAPI), [CategoryAPIDatatype](CategoryAPIDatatype), [CategoryEvents](CategoryEvents) diff --git a/SDL2/SDL_FPoint.md b/SDL2/SDL_FPoint.md index 63670fd35..c692a5ce1 100644 --- a/SDL2/SDL_FPoint.md +++ b/SDL2/SDL_FPoint.md @@ -25,10 +25,10 @@ typedef struct SDL_FPoint ## Data Fields -| | | | -| ----- | ------- | ----------------------------- | -| float | '''x''' | the x coordinate of the point | -| float | '''y''' | the y coordinate of the point | +| | | | +| ----- | ----- | ----------------------------- | +| float | **x** | the x coordinate of the point | +| float | **y** | the y coordinate of the point | ## Related Structures diff --git a/SDL2/SDL_FRect.md b/SDL2/SDL_FRect.md index 6f9b8e3f3..bfad6090a 100644 --- a/SDL2/SDL_FRect.md +++ b/SDL2/SDL_FRect.md @@ -45,12 +45,12 @@ rect.h = 32.0; ## Data Fields -| | | | -| ----- | ------- | --------------------------------------------------- | -| float | '''x''' | the x location of the rectangle's upper left corner | -| float | '''y''' | the y location of the rectangle's upper left corner | -| float | '''w''' | the width of the rectangle | -| float | '''h''' | the height of the rectangle | +| | | | +| ----- | ----- | --------------------------------------------------- | +| float | **x** | the x location of the rectangle's upper left corner | +| float | **y** | the y location of the rectangle's upper left corner | +| float | **w** | the width of the rectangle | +| float | **h** | the height of the rectangle | ---- [CategoryAPI](CategoryAPI), [CategoryAPIStruct](CategoryAPIStruct), [CategoryStruct](CategoryStruct), [CategoryRect](CategoryRect) diff --git a/SDL2/SDL_GameControllerButtonBind.md b/SDL2/SDL_GameControllerButtonBind.md index 69b097204..6ea5dfac6 100644 --- a/SDL2/SDL_GameControllerButtonBind.md +++ b/SDL2/SDL_GameControllerButtonBind.md @@ -35,13 +35,13 @@ typedef struct SDL_GameControllerButtonBind ## Data Fields -| | | | -| -------------------------------------------------------- | ------------------ | -------------------------------------------------------------------------------------------------------------------- | -| [SDL_GameControllerBindType](SDL_GameControllerBindType) | '''bindType''' | What kind of control this maps to (button/axis/hat/not mapped) | -| int | '''button''' | The [SDL_Joystick button](SDL_JoystickGetButton) this maps to | -| int | '''axis''' | The [SDL_Joystick axis](SDL_JoystickGetAxis) this maps to | -| int | '''hat.hat''' | The [SDL_Joystick hat](SDL_JoystickGetHat) this maps to | -| int | '''hat.hat_mask''' | the mask you need to binary-& with the hat's value with (this probaly corresponds to '''one''' direction of the hat) | +| | | | +| -------------------------------------------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------ | +| [SDL_GameControllerBindType](SDL_GameControllerBindType) | **bindType** | What kind of control this maps to (button/axis/hat/not mapped) | +| int | **button** | The [SDL_Joystick button](SDL_JoystickGetButton) this maps to | +| int | **axis** | The [SDL_Joystick axis](SDL_JoystickGetAxis) this maps to | +| int | **hat.hat** | The [SDL_Joystick hat](SDL_JoystickGetHat) this maps to | +| int | **hat.hat_mask** | the mask you need to binary-& with the hat's value with (this probaly corresponds to **one** direction of the hat) | ## Related Enumerations diff --git a/SDL2/SDL_HapticCondition.md b/SDL2/SDL_HapticCondition.md index 6e78c3437..285c1b42e 100644 --- a/SDL2/SDL_HapticCondition.md +++ b/SDL2/SDL_HapticCondition.md @@ -68,24 +68,24 @@ positive and which is negative. ## Data Fields -| | | | -| ------------------------------------------------------------------- | ---------------------------------------- | -------------------------------------------------------------------------------------------------- | -| | | ''Header'' | -| Uint16 | '''type''' | one of the effects handled by this structure; see Remarks for details | -| [SDL_HapticDirection](SDL_HapticDirection) | '''direction''' | direction of the effect - not used at the moment; see Remarks for details | -| | | ''Replay'' | -| Uint32 | '''length''' | duration of the effect | -| Uint16 | '''delay''' | delay before starting the effect | -| | | ''Trigger'' | -| Uint16 | '''button''' | button that triggers the effect | -| Uint16 | '''interval''' | how soon it can be triggered again after button | -| | | ''Condition'' | -| Uint16 | '''right_sat''' | level when joystick is to the positive side; max 0xFFFF | -| Uint16 | '''left_sat''' | level when joystick is to the negative side; max 0xFFFF | -| Sint16 | '''right_coeff''' | how fast to increase the force towards the positive side | -| Sint16 | '''left_coeff''' | how fast to increase the force towards the negative side | -| Uint16 | '''deadband''' | size of the dead zone; max 0xFFFF: whole axis-range when 0-centered | -| Sint16 | '''center''' | position of the dead zone | +| | | | +| ------------------------------------------------------------------- | -------------------------------------- | -------------------------------------------------------------------------------------------------- | +| | | ''Header'' | +| Uint16 | **type** | one of the effects handled by this structure; see Remarks for details | +| [SDL_HapticDirection](SDL_HapticDirection) | **direction** | direction of the effect - not used at the moment; see Remarks for details | +| | | ''Replay'' | +| Uint32 | **length** | duration of the effect | +| Uint16 | **delay** | delay before starting the effect | +| | | ''Trigger'' | +| Uint16 | **button** | button that triggers the effect | +| Uint16 | **interval** | how soon it can be triggered again after button | +| | | ''Condition'' | +| Uint16 | **right_sat** | level when joystick is to the positive side; max 0xFFFF | +| Uint16 | **left_sat** | level when joystick is to the negative side; max 0xFFFF | +| Sint16 | **right_coeff** | how fast to increase the force towards the positive side | +| Sint16 | **left_coeff** | how fast to increase the force towards the negative side | +| Uint16 | **deadband** | size of the dead zone; max 0xFFFF: whole axis-range when 0-centered | +| Sint16 | **center** | position of the dead zone | ## Related Structures diff --git a/SDL2/SDL_HapticConstant.md b/SDL2/SDL_HapticConstant.md index 11f2dd05a..053b74c99 100644 --- a/SDL2/SDL_HapticConstant.md +++ b/SDL2/SDL_HapticConstant.md @@ -55,24 +55,24 @@ the joystick. ## Data Fields -| | | | -| ------------------------------------------ | ------------------- | ----------------------------------------------- | -| | | ''Header'' | -| Uint16 | '''type''' | SDL_HAPTIC_CONSTANT | -| [SDL_HapticDirection](SDL_HapticDirection) | '''direction''' | direction of the effect | -| | | ''Replay'' | -| Uint32 | '''length''' | duration of the effect | -| Uint16 | '''delay''' | delay before starting the effect | -| | | ''Trigger'' | -| Uint16 | '''button''' | button that triggers the effect | -| Uint16 | '''interval''' | how soon it can be triggered again after button | -| | | ''Constant'' | -| Sint16 | '''level''' | strength of the constant effect | -| | | ''Envelope'' | -| Uint16 | '''attack_length''' | duration of the attack | -| Uint16 | '''attack_level''' | level at the start of the attack | -| Uint16 | '''fade_length''' | duration of the fade | -| Uint16 | '''fade_level''' | level at the end of the fade | +| | | | +| ------------------------------------------ | ----------------- | ----------------------------------------------- | +| | | ''Header'' | +| Uint16 | **type** | SDL_HAPTIC_CONSTANT | +| [SDL_HapticDirection](SDL_HapticDirection) | **direction** | direction of the effect | +| | | ''Replay'' | +| Uint32 | **length** | duration of the effect | +| Uint16 | **delay** | delay before starting the effect | +| | | ''Trigger'' | +| Uint16 | **button** | button that triggers the effect | +| Uint16 | **interval** | how soon it can be triggered again after button | +| | | ''Constant'' | +| Sint16 | **level** | strength of the constant effect | +| | | ''Envelope'' | +| Uint16 | **attack_length** | duration of the attack | +| Uint16 | **attack_level** | level at the start of the attack | +| Uint16 | **fade_length** | duration of the fade | +| Uint16 | **fade_level** | level at the end of the fade | ---- [CategoryAPI](CategoryAPI), [CategoryAPIStruct](CategoryAPIStruct), [CategoryStruct](CategoryStruct), [CategoryForceFeedback](CategoryForceFeedback), [CategoryDraft](CategoryDraft) diff --git a/SDL2/SDL_HapticCustom.md b/SDL2/SDL_HapticCustom.md index 2d6def3c9..5d1e3d835 100644 --- a/SDL2/SDL_HapticCustom.md +++ b/SDL2/SDL_HapticCustom.md @@ -62,27 +62,27 @@ Otherwise it uses the samples in data for the different axes. ## Data Fields -| | | | -| ------------------------------------------ | ------------------- | -------------------------------------------------------------------------- | -| | | ''Header'' | -| Uint16 | '''type''' | SDL_HAPTIC_CUSTOM | -| [SDL_HapticDirection](SDL_HapticDirection) | '''direction''' | direction of the effect (relative to the user) | -| | | ''Replay'' | -| Uint32 | '''length''' | duration of the effect | -| Uint16 | '''delay''' | delay before starting the effect | -| | | ''Trigger'' | -| Uint16 | '''button''' | button that triggers the effect | -| Uint16 | '''interval''' | how soon it can be triggered again after '''button''' | -| | | ''Custom'' | -| Uint8 | '''channels''' | axes to use, minimum of 1; see Remarks for details | -| Uint16 | '''period''' | sample periods | -| Uint16 | '''samples''' | amount (number) of samples | -| Uint16* | '''data''' | should contain '''channels'''*'''samples''' items; see Remarks for details | -| | | ''Envelope'' | -| Uint16 | '''attack_length''' | duration of the attack | -| Uint16 | '''attack_level''' | level at the start of the attack | -| Uint16 | '''fade_length''' | duration of the fade | -| Uint16 | '''fade_level''' | level at the end of the fade | +| | | | +| ------------------------------------------ | ----------------- | ---------------------------------------------------------------------- | +| | | ''Header'' | +| Uint16 | **type** | SDL_HAPTIC_CUSTOM | +| [SDL_HapticDirection](SDL_HapticDirection) | **direction** | direction of the effect (relative to the user) | +| | | ''Replay'' | +| Uint32 | **length** | duration of the effect | +| Uint16 | **delay** | delay before starting the effect | +| | | ''Trigger'' | +| Uint16 | **button** | button that triggers the effect | +| Uint16 | **interval** | how soon it can be triggered again after **button** | +| | | ''Custom'' | +| Uint8 | **channels** | axes to use, minimum of 1; see Remarks for details | +| Uint16 | **period** | sample periods | +| Uint16 | **samples** | amount (number) of samples | +| Uint16* | **data** | should contain **channels*****samples** items; see Remarks for details | +| | | ''Envelope'' | +| Uint16 | **attack_length** | duration of the attack | +| Uint16 | **attack_level** | level at the start of the attack | +| Uint16 | **fade_length** | duration of the fade | +| Uint16 | **fade_level** | level at the end of the fade | ## Related Structures diff --git a/SDL2/SDL_HapticDirection.md b/SDL2/SDL_HapticDirection.md index cab967355..5a13c2874 100644 --- a/SDL2/SDL_HapticDirection.md +++ b/SDL2/SDL_HapticDirection.md @@ -70,11 +70,11 @@ direction.dir[0] = 9000; // Since we only have two axes we don't need more param ## Data Fields -| | | | -| ------ | ---------- | ---------------------------------------------- | -| Uint8 | '''type''' | the type of encoding; see Remarks for details | -| Sint32 | '''dir''' | the encoded direction; see Remarks for details | - +| | | | +| ------ | -------- | ---------------------------------------------- | +| Uint8 | **type** | the type of encoding; see Remarks for details | +| Sint32 | **dir** | the encoded direction; see Remarks for details | + ## Related Structures diff --git a/SDL2/SDL_HapticEffect.md b/SDL2/SDL_HapticEffect.md index 1a29c865f..81964e9d7 100644 --- a/SDL2/SDL_HapticEffect.md +++ b/SDL2/SDL_HapticEffect.md @@ -61,15 +61,15 @@ Common parts: ## Data Fields -| | | | -| ------------------------------------------ | --------------- | --------------------------------------------------------------------- | -| Uint16 | '''type''' | effect type; see [SDL_HapticPeriodic](SDL_HapticPeriodic) for details | -| [SDL_HapticConstant](SDL_HapticConstant) | '''constant''' | constant effect; see Remarks for details | -| [SDL_HapticPeriodic](SDL_HapticPeriodic) | '''periodic''' | periodic effect; see Remarks for details | -| [SDL_HapticCondition](SDL_HapticCondition) | '''condition''' | condition effect; see Remarks for details | -| [SDL_HapticRamp](SDL_HapticRamp) | '''ramp''' | ramp effect; see Remarks for details | -| [SDL_HapticLeftRight](SDL_HapticLeftRight) | '''leftright''' | left/right effect; see Remarks for details | -| [SDL_HapticCustom](SDL_HapticCustom) | '''custom''' | custom effect; see Remarks for details | +| | | | +| ------------------------------------------ | ------------- | --------------------------------------------------------------------- | +| Uint16 | **type** | effect type; see [SDL_HapticPeriodic](SDL_HapticPeriodic) for details | +| [SDL_HapticConstant](SDL_HapticConstant) | **constant** | constant effect; see Remarks for details | +| [SDL_HapticPeriodic](SDL_HapticPeriodic) | **periodic** | periodic effect; see Remarks for details | +| [SDL_HapticCondition](SDL_HapticCondition) | **condition** | condition effect; see Remarks for details | +| [SDL_HapticRamp](SDL_HapticRamp) | **ramp** | ramp effect; see Remarks for details | +| [SDL_HapticLeftRight](SDL_HapticLeftRight) | **leftright** | left/right effect; see Remarks for details | +| [SDL_HapticCustom](SDL_HapticCustom) | **custom** | custom effect; see Remarks for details | ## Related Structures diff --git a/SDL2/SDL_HapticLeftRight.md b/SDL2/SDL_HapticLeftRight.md index d0e266f5a..0d6681b34 100644 --- a/SDL2/SDL_HapticLeftRight.md +++ b/SDL2/SDL_HapticLeftRight.md @@ -48,15 +48,15 @@ is high frequency, and the large (left) motor is low frequency. ## Data Fields -| | | | -| ------ | --------------------- | ------------------------------------- | -| | | ''Header'' | -| Uint16 | '''type''' | SDL_HAPTIC_LEFTRIGHT | -| | | ''Replay'' | -| Uint32 | '''length''' | duration of the effect | -| | | ''Rumble'' | -| Uint16 | '''large_magnitude''' | control of the large controller motor | -| Uint16 | '''small_magnitude''' | control of the small controller motor | +| | | | +| ------ | ------------------- | ------------------------------------- | +| | | ''Header'' | +| Uint16 | **type** | SDL_HAPTIC_LEFTRIGHT | +| | | ''Replay'' | +| Uint32 | **length** | duration of the effect | +| | | ''Rumble'' | +| Uint16 | **large_magnitude** | control of the large controller motor | +| Uint16 | **small_magnitude** | control of the small controller motor | ## Related Structures diff --git a/SDL2/SDL_HapticPeriodic.md b/SDL2/SDL_HapticPeriodic.md index 8263d4ced..ef87a08fb 100644 --- a/SDL2/SDL_HapticPeriodic.md +++ b/SDL2/SDL_HapticPeriodic.md @@ -77,27 +77,27 @@ Examples: ## Data Fields -| | | | -| ------------------------------------------ | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| | | ''Header'' | -| Uint16 | '''type''' | the shape of the waves; see Remarks for details | -| [SDL_HapticDirection](SDL_HapticDirection) | '''direction''' | direction of the effect (relative to the user) | -| | | ''Replay'' | -| Uint32 | '''length''' | duration of the effect | -| Uint16 | '''delay''' | delay before starting the effect | -| | | ''Trigger'' | -| Uint16 | '''button''' | button that triggers the effect | -| Uint16 | '''interval''' | how soon it can be triggered again after '''button''' | -| | | ''Periodic'' | -| Uint16 | '''period''' | period of the wave | -| Sint16 | '''magnitude''' | peak value; if negative, equivalent to 180 degrees extra phase shift | -| Sint16 | '''offset''' | mean value of the wave | -| Uint16 | '''phase''' | positive phase shift given by hundredth of a degree; see Remarks for details | -| | | ''Envelope'' | -| Uint16 | '''attack_length''' | duration of the attack | -| Uint16 | '''attack_level''' | level at the start of the attack | -| Uint16 | '''fade_length''' | duration of the fade | -| Uint16 | '''fade_level''' | level at the end of the fade | +| | | | +| ------------------------------------------ | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| | | ''Header'' | +| Uint16 | **type** | the shape of the waves; see Remarks for details | +| [SDL_HapticDirection](SDL_HapticDirection) | **direction** | direction of the effect (relative to the user) | +| | | ''Replay'' | +| Uint32 | **length** | duration of the effect | +| Uint16 | **delay** | delay before starting the effect | +| | | ''Trigger'' | +| Uint16 | **button** | button that triggers the effect | +| Uint16 | **interval** | how soon it can be triggered again after **button** | +| | | ''Periodic'' | +| Uint16 | **period** | period of the wave | +| Sint16 | **magnitude** | peak value; if negative, equivalent to 180 degrees extra phase shift | +| Sint16 | **offset** | mean value of the wave | +| Uint16 | **phase** | positive phase shift given by hundredth of a degree; see Remarks for details | +| | | ''Envelope'' | +| Uint16 | **attack_length** | duration of the attack | +| Uint16 | **attack_level** | level at the start of the attack | +| Uint16 | **fade_length** | duration of the fade | +| Uint16 | **fade_level** | level at the end of the fade | ## Related Structures diff --git a/SDL2/SDL_HapticRamp.md b/SDL2/SDL_HapticRamp.md index 32671ce8f..c02d33c93 100644 --- a/SDL2/SDL_HapticRamp.md +++ b/SDL2/SDL_HapticRamp.md @@ -58,25 +58,25 @@ instead of linear. ## Data Fields -| | | | -| ------------------------------------------ | ------------------- | ----------------------------------------------------- | -| | | ''Header'' | -| Uint16 | '''type''' | SDL_HAPTIC_RAMP | -| [SDL_HapticDirection](SDL_HapticDirection) | '''direction''' | direction of the effect | -| | | ''Replay'' | -| Uint32 | '''length''' | duration of the effect | -| Uint16 | '''delay''' | delay before starting the effect | -| | | ''Trigger'' | -| Uint16 | '''button''' | button that triggers the effect | -| Uint16 | '''interval''' | how soon it can be triggered again after '''button''' | -| | | ''Ramp'' | -| Sint16 | '''start''' | beginning strength level | -| Sint16 | '''end''' | ending strength level | -| | | ''Envelope'' | -| Uint16 | '''attack_length''' | duration of the attack | -| Uint16 | '''attack_level''' | level at the start of the attack | -| Uint16 | '''fade_length''' | duration of the fade | -| Uint16 | '''fade_level''' | level at the end of the fade | +| | | | +| ------------------------------------------ | ----------------- | --------------------------------------------------- | +| | | ''Header'' | +| Uint16 | **type** | SDL_HAPTIC_RAMP | +| [SDL_HapticDirection](SDL_HapticDirection) | **direction** | direction of the effect | +| | | ''Replay'' | +| Uint32 | **length** | duration of the effect | +| Uint16 | **delay** | delay before starting the effect | +| | | ''Trigger'' | +| Uint16 | **button** | button that triggers the effect | +| Uint16 | **interval** | how soon it can be triggered again after **button** | +| | | ''Ramp'' | +| Sint16 | **start** | beginning strength level | +| Sint16 | **end** | ending strength level | +| | | ''Envelope'' | +| Uint16 | **attack_length** | duration of the attack | +| Uint16 | **attack_level** | level at the start of the attack | +| Uint16 | **fade_length** | duration of the fade | +| Uint16 | **fade_level** | level at the end of the fade | ## Related Structures diff --git a/SDL2/SDL_JoyAxisEvent.md b/SDL2/SDL_JoyAxisEvent.md index 09ecd65a8..c13005205 100644 --- a/SDL2/SDL_JoyAxisEvent.md +++ b/SDL2/SDL_JoyAxisEvent.md @@ -26,13 +26,13 @@ typedef struct SDL_JoyAxisEvent ## Data Fields -| | | | -| -------------- | --------------- | --------------------------------------------------------- | -| Uint32 | '''type''' | SDL_JOYAXISMOTION | -| Uint32 | '''timestamp''' | timestamp of the event | -| SDL_JoystickID | '''which''' | the instance id of the joystick that reported the event | -| Uint8 | '''axis''' | the index of the axis that changed | -| Sint16 | '''value''' | the current position of the axis (range: -32768 to 32767) | +| | | | +| -------------- | ------------- | --------------------------------------------------------- | +| Uint32 | **type** | SDL_JOYAXISMOTION | +| Uint32 | **timestamp** | timestamp of the event | +| SDL_JoystickID | **which** | the instance id of the joystick that reported the event | +| Uint8 | **axis** | the index of the axis that changed | +| Sint16 | **value** | the current position of the axis (range: -32768 to 32767) | ## Related Enumerations diff --git a/SDL2/SDL_JoyBallEvent.md b/SDL2/SDL_JoyBallEvent.md index 230f39052..372310db2 100644 --- a/SDL2/SDL_JoyBallEvent.md +++ b/SDL2/SDL_JoyBallEvent.md @@ -26,14 +26,14 @@ typedef struct SDL_JoyBallEvent ## Data Fields -| | | | -| -------------- | --------------- | ------------------------------------------------------- | -| Uint32 | '''type''' | SDL_JOYBALLMOTION | -| Uint32 | '''timestamp''' | timestamp of the event | -| SDL_JoystickID | '''which''' | the instance id of the joystick that reported the event | -| Uint8 | '''ball''' | the index of the trackball that changed | -| Sint16 | '''xrel''' | the relative motion in the X direction | -| Sint16 | '''yrel''' | the relative motion in the Y direction | +| | | | +| -------------- | ------------- | ------------------------------------------------------- | +| Uint32 | **type** | SDL_JOYBALLMOTION | +| Uint32 | **timestamp** | timestamp of the event | +| SDL_JoystickID | **which** | the instance id of the joystick that reported the event | +| Uint8 | **ball** | the index of the trackball that changed | +| Sint16 | **xrel** | the relative motion in the X direction | +| Sint16 | **yrel** | the relative motion in the Y direction | ## Related Enumerations diff --git a/SDL2/SDL_JoyButtonEvent.md b/SDL2/SDL_JoyButtonEvent.md index e05b909c7..cc523ed69 100644 --- a/SDL2/SDL_JoyButtonEvent.md +++ b/SDL2/SDL_JoyButtonEvent.md @@ -24,13 +24,13 @@ typedef struct SDL_JoyButtonEvent ## Data Fields -| | | | -| -------------- | --------------- | ------------------------------------------------------- | -| Uint32 | '''type''' | the event type; SDL_JOYBUTTONDOWN or SDL_JOYBUTTONUP | -| Uint32 | '''timestamp''' | timestamp of the event | -| SDL_JoystickID | '''which''' | the instance id of the joystick that reported the event | -| Uint8 | '''button''' | the index of the button that changed | -| Uint8 | '''state''' | the state of the button; SDL_PRESSED or SDL_RELEASED | +| | | | +| -------------- | ------------- | ------------------------------------------------------- | +| Uint32 | **type** | the event type; SDL_JOYBUTTONDOWN or SDL_JOYBUTTONUP | +| Uint32 | **timestamp** | timestamp of the event | +| SDL_JoystickID | **which** | the instance id of the joystick that reported the event | +| Uint8 | **button** | the index of the button that changed | +| Uint8 | **state** | the state of the button; SDL_PRESSED or SDL_RELEASED | ## Related Enumerations diff --git a/SDL2/SDL_JoyDeviceEvent.md b/SDL2/SDL_JoyDeviceEvent.md index 82e16aa01..6f4f1eb35 100644 --- a/SDL2/SDL_JoyDeviceEvent.md +++ b/SDL2/SDL_JoyDeviceEvent.md @@ -27,11 +27,11 @@ typedef struct SDL_JoyDeviceEvent ## Data Fields -| | | | -| ------ | --------------- | ---------------------------------------------------------------------------------------------------------------- | -| Uint32 | '''type''' | SDL_JOYDEVICEADDED or SDL_JOYDEVICEREMOVED | -| Uint32 | '''timestamp''' | the timestamp of the event | -| Sint32 | '''which''' | the joystick device index for the SDL_JOYDEVICEADDED event or the instance id for the SDL_JOYDEVICEREMOVED event | +| | | | +| ------ | ------------- | ---------------------------------------------------------------------------------------------------------------- | +| Uint32 | **type** | SDL_JOYDEVICEADDED or SDL_JOYDEVICEREMOVED | +| Uint32 | **timestamp** | the timestamp of the event | +| Sint32 | **which** | the joystick device index for the SDL_JOYDEVICEADDED event or the instance id for the SDL_JOYDEVICEREMOVED event | ## Related Enumerations diff --git a/SDL2/SDL_JoyHatEvent.md b/SDL2/SDL_JoyHatEvent.md index b3a7361e4..88324bb4f 100644 --- a/SDL2/SDL_JoyHatEvent.md +++ b/SDL2/SDL_JoyHatEvent.md @@ -30,13 +30,13 @@ typedef struct SDL_JoyHatEvent ## Data Fields -| | | | -| -------------- | --------------- | ------------------------------------------------------- | -| Uint32 | '''type''' | SDL_JOYHATMOTION | -| Uint32 | '''timestamp''' | timestamp of the event | -| SDL_JoystickID | '''which''' | the instance id of the joystick that reported the event | -| Uint8 | '''hat''' | the index of the hat that changed | -| Uint8 | '''value''' | the new position of the hat; see Remarks for details | +| | | | +| -------------- | ------------- | ------------------------------------------------------- | +| Uint32 | **type** | SDL_JOYHATMOTION | +| Uint32 | **timestamp** | timestamp of the event | +| SDL_JoystickID | **which** | the instance id of the joystick that reported the event | +| Uint8 | **hat** | the index of the hat that changed | +| Uint8 | **value** | the new position of the hat; see Remarks for details | ## Related Enumerations diff --git a/SDL2/SDL_KeyboardEvent.md b/SDL2/SDL_KeyboardEvent.md index 57dd96ca3..398a8ea4b 100644 --- a/SDL2/SDL_KeyboardEvent.md +++ b/SDL2/SDL_KeyboardEvent.md @@ -25,14 +25,14 @@ typedef struct SDL_KeyboardEvent ## Data Fields -| | | | -| ------------------------ | --------------- | ------------------------------------------------------------------------------ | -| Uint32 | '''type''' | the event type; SDL_KEYDOWN or SDL_KEYUP | -| Uint32 | '''timestamp''' | timestamp of the event | -| Uint32 | '''windowID''' | the window with keyboard focus, if any | -| Uint8 | '''state''' | the state of the key; SDL_PRESSED or SDL_RELEASED | -| Uint8 | '''repeat''' | non-zero if this is a key repeat | -| [SDL_Keysym](SDL_Keysym) | '''keysym''' | the [SDL_Keysym](SDL_Keysym) representing the key that was pressed or released | +| | | | +| ------------------------ | ------------- | ------------------------------------------------------------------------------ | +| Uint32 | **type** | the event type; SDL_KEYDOWN or SDL_KEYUP | +| Uint32 | **timestamp** | timestamp of the event | +| Uint32 | **windowID** | the window with keyboard focus, if any | +| Uint8 | **state** | the state of the key; SDL_PRESSED or SDL_RELEASED | +| Uint8 | **repeat** | non-zero if this is a key repeat | +| [SDL_Keysym](SDL_Keysym) | **keysym** | the [SDL_Keysym](SDL_Keysym) representing the key that was pressed or released | ## Related Enumerations diff --git a/SDL2/SDL_Keysym.md b/SDL2/SDL_Keysym.md index 5917d9ca0..d9398e6fc 100644 --- a/SDL2/SDL_Keysym.md +++ b/SDL2/SDL_Keysym.md @@ -21,12 +21,12 @@ typedef struct SDL_Keysym ## Data Fields -| | | | -| ------------------------------------------ | ------------------------------------------------ | ------------------------------------------------------------------- | -| [SDL_Scancode](SDL_Scancode) | '''scancode''' | SDL physical key code; see [SDL_Scancode](SDL_Scancode) for details | -| [SDL_Keycode](SDL_Keycode) | '''sym''' | SDL virtual key code; see [SDL_Keycode](SDL_Keycode) for details | -| Uint16 | '''mod''' | current key modifiers; see [SDL_Keymod](SDL_Keymod) for details | -| Uint32 | '''unused''' | | +| | | | +| ------------------------------------------ | ---------------------------------------------- | ------------------------------------------------------------------- | +| [SDL_Scancode](SDL_Scancode) | **scancode** | SDL physical key code; see [SDL_Scancode](SDL_Scancode) for details | +| [SDL_Keycode](SDL_Keycode) | **sym** | SDL virtual key code; see [SDL_Keycode](SDL_Keycode) for details | +| Uint16 | **mod** | current key modifiers; see [SDL_Keymod](SDL_Keymod) for details | +| Uint32 | **unused** | | ## Related Enumerations diff --git a/SDL2/SDL_MessageBoxButtonData.md b/SDL2/SDL_MessageBoxButtonData.md index 31d363a32..0adf581d3 100644 --- a/SDL2/SDL_MessageBoxButtonData.md +++ b/SDL2/SDL_MessageBoxButtonData.md @@ -27,11 +27,11 @@ typedef struct SDL_MessageBoxButtonData ## Data Fields -| | | | -| ------------- | --------------- | ---------------------------------------------------------------------------------------- | -| Uint32 | '''flags''' | one of the values from [SDL_MessageBoxButtonFlags](SDL_MessageBoxButtonFlags) | -| int | '''buttonid''' | user defined button id (value returned via [SDL_ShowMessageBox](SDL_ShowMessageBox)()) | -| const char* | '''text''' | the UTF-8 button text | +| | | | +| ------------- | ------------- | ---------------------------------------------------------------------------------------- | +| Uint32 | **flags** | one of the values from [SDL_MessageBoxButtonFlags](SDL_MessageBoxButtonFlags) | +| int | **buttonid** | user defined button id (value returned via [SDL_ShowMessageBox](SDL_ShowMessageBox)()) | +| const char* | **text** | the UTF-8 button text | ## Related Enumerations diff --git a/SDL2/SDL_MessageBoxColor.md b/SDL2/SDL_MessageBoxColor.md index bf4a4aed2..c6048f427 100644 --- a/SDL2/SDL_MessageBoxColor.md +++ b/SDL2/SDL_MessageBoxColor.md @@ -25,11 +25,11 @@ typedef struct SDL_MessageBoxColor ## Data Fields -| | | | -| ----- | ------- | -------------------------------------- | -| Uint8 | '''r''' | the red component in the range 0-255 | -| Uint8 | '''g''' | the green component in the range 0-255 | -| Uint8 | '''b''' | the blue component in the range 0-255 | +| | | | +| ----- | ----- | -------------------------------------- | +| Uint8 | **r** | the red component in the range 0-255 | +| Uint8 | **g** | the green component in the range 0-255 | +| Uint8 | **b** | the blue component in the range 0-255 | ## Related Structures diff --git a/SDL2/SDL_MessageBoxColorScheme.md b/SDL2/SDL_MessageBoxColorScheme.md index 659e58921..4cd5a9251 100644 --- a/SDL2/SDL_MessageBoxColorScheme.md +++ b/SDL2/SDL_MessageBoxColorScheme.md @@ -25,9 +25,9 @@ typedef struct SDL_MessageBoxColorScheme ## Data Fields -| | | | -| --------------------------------------------- | ------------ | - | -| [SDL_MessageBoxColor](SDL_MessageBoxColor)[5] | '''colors''' | | +| | | | +| --------------------------------------------- | ---------- | - | +| [SDL_MessageBoxColor](SDL_MessageBoxColor)[5] | **colors** | | ## Related Enumerations diff --git a/SDL2/SDL_MessageBoxData.md b/SDL2/SDL_MessageBoxData.md index fe5339f5b..6b9e15f82 100644 --- a/SDL2/SDL_MessageBoxData.md +++ b/SDL2/SDL_MessageBoxData.md @@ -33,15 +33,15 @@ typedef struct SDL_MessageBoxData ## Data Fields -| | | | -| --------------------------------------------------------------- | ------------------- | -------------------------------------------------------------------------------------------------- | -| Uint32 | '''flags''' | an [SDL_MessageBoxFlags](SDL_MessageBoxFlags) | -| SDL_Window* | '''window''' | an parent window, can be NULL | -| const char* | '''title''' | an UTF-8 title | -| const char* | '''message''' | an UTF-8 message text | -| int | '''numbuttons''' | the number of buttons | -| const [SDL_MessageBoxButtonData](SDL_MessageBoxButtonData)* | '''buttons''' | an array of [SDL_MessageBoxButtonData](SDL_MessageBoxButtonData) with length of '''numbuttons''' | -| const [SDL_MessageBoxColorScheme](SDL_MessageBoxColorScheme)* | '''colorScheme''' | an [SDL_MessageBoxColorScheme](SDL_MessageBoxColorScheme), can be NULL to use system settings | +| | | | +| --------------------------------------------------------------- | ----------------- | ------------------------------------------------------------------------------------------------ | +| Uint32 | **flags** | an [SDL_MessageBoxFlags](SDL_MessageBoxFlags) | +| SDL_Window* | **window** | an parent window, can be NULL | +| const char* | **title** | an UTF-8 title | +| const char* | **message** | an UTF-8 message text | +| int | **numbuttons** | the number of buttons | +| const [SDL_MessageBoxButtonData](SDL_MessageBoxButtonData)* | **buttons** | an array of [SDL_MessageBoxButtonData](SDL_MessageBoxButtonData) with length of **numbuttons** | +| const [SDL_MessageBoxColorScheme](SDL_MessageBoxColorScheme)* | **colorScheme** | an [SDL_MessageBoxColorScheme](SDL_MessageBoxColorScheme), can be NULL to use system settings | ## Related Enumerations diff --git a/SDL2/SDL_MouseButtonEvent.md b/SDL2/SDL_MouseButtonEvent.md index 50d4168b3..e7230b60b 100644 --- a/SDL2/SDL_MouseButtonEvent.md +++ b/SDL2/SDL_MouseButtonEvent.md @@ -27,17 +27,17 @@ typedef struct SDL_MouseButtonEvent ## Data Fields -| | | | -| ------ | --------------- | -------------------------------------------------------------------- | -| Uint32 | '''type''' | the event type; SDL_MOUSEBUTTONDOWN or SDL_MOUSEBUTTONUP | -| Uint32 | '''timestamp''' | timestamp of the event | -| Uint32 | '''windowID''' | the window with mouse focus, if any | -| Uint32 | '''which''' | the mouse instance id, or SDL_TOUCH_MOUSEID; see Remarks for details | -| Uint8 | '''button''' | the button that changed; see Remarks for details | -| Uint8 | '''state''' | the state of the button; SDL_PRESSED or SDL_RELEASED | -| Uint8 | '''clicks''' | 1 for single-click, 2 for double-click, etc. (>= SDL 2.0.2) | -| Sint32 | '''x''' | X coordinate, relative to window | -| Sint32 | '''y''' | Y coordinate, relative to window | +| | | | +| ------ | ------------- | -------------------------------------------------------------------- | +| Uint32 | **type** | the event type; SDL_MOUSEBUTTONDOWN or SDL_MOUSEBUTTONUP | +| Uint32 | **timestamp** | timestamp of the event | +| Uint32 | **windowID** | the window with mouse focus, if any | +| Uint32 | **which** | the mouse instance id, or SDL_TOUCH_MOUSEID; see Remarks for details | +| Uint8 | **button** | the button that changed; see Remarks for details | +| Uint8 | **state** | the state of the button; SDL_PRESSED or SDL_RELEASED | +| Uint8 | **clicks** | 1 for single-click, 2 for double-click, etc. (>= SDL 2.0.2) | +| Sint32 | **x** | X coordinate, relative to window | +| Sint32 | **y** | Y coordinate, relative to window | ## Related Enumerations diff --git a/SDL2/SDL_MouseMotionEvent.md b/SDL2/SDL_MouseMotionEvent.md index 62815a2da..46e17b9eb 100644 --- a/SDL2/SDL_MouseMotionEvent.md +++ b/SDL2/SDL_MouseMotionEvent.md @@ -26,17 +26,17 @@ typedef struct SDL_MouseMotionEvent ## Data Fields -| | | | -| ------ | --------------- | -------------------------------------------------------------------- | -| Uint32 | '''type''' | the event type; SDL_MOUSEMOTION | -| Uint32 | '''timestamp''' | timestamp of the event | -| Uint32 | '''windowID''' | the window with mouse focus, if any | -| Uint32 | '''which''' | the mouse instance id, or SDL_TOUCH_MOUSEID; see Remarks for details | -| Uint32 | '''state''' | the state of the button; see Remarks for details | -| Sint32 | '''x''' | X coordinate, relative to window | -| Sint32 | '''y''' | Y coordinate, relative to window | -| Sint32 | '''xrel''' | relative motion in the X direction | -| Sint32 | '''yrel''' | relative motion in the Y direction | +| | | | +| ------ | ------------- | -------------------------------------------------------------------- | +| Uint32 | **type** | the event type; SDL_MOUSEMOTION | +| Uint32 | **timestamp** | timestamp of the event | +| Uint32 | **windowID** | the window with mouse focus, if any | +| Uint32 | **which** | the mouse instance id, or SDL_TOUCH_MOUSEID; see Remarks for details | +| Uint32 | **state** | the state of the button; see Remarks for details | +| Sint32 | **x** | X coordinate, relative to window | +| Sint32 | **y** | Y coordinate, relative to window | +| Sint32 | **xrel** | relative motion in the X direction | +| Sint32 | **yrel** | relative motion in the Y direction | ## Related Enumerations diff --git a/SDL2/SDL_MouseWheelEvent.md b/SDL2/SDL_MouseWheelEvent.md index 8b06502dc..4dbc42c1d 100644 --- a/SDL2/SDL_MouseWheelEvent.md +++ b/SDL2/SDL_MouseWheelEvent.md @@ -64,17 +64,17 @@ while( SDL_PollEvent( &event ) ) ## Data Fields -| | | | -| ------ | --------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| Uint32 | '''type''' | SDL_MOUSEWHEEL | -| Uint32 | '''timestamp''' | timestamp of the event | -| Uint32 | '''windowID''' | the window with mouse focus, if any | -| Uint32 | '''which''' | the mouse instance id, or SDL_TOUCH_MOUSEID; see Remarks for details | -| Sint32 | '''x''' | the amount scrolled horizontally, positive to the right and negative to the left | -| Sint32 | '''y''' | the amount scrolled vertically, positive away from the user and negative towards the user | -| Uint32 | '''direction''' | SDL_MOUSEWHEEL_NORMAL or SDL_MOUSEWHEEL_FLIPPED; see Remarks for details (>= SDL 2.0.4) | -| float | '''preciseX''' | the amount scrolled horizontally, positive to the right and negative to the left, with float precision (added in 2.0.18) | -| float | '''preciseY''' | the amount scrolled vertically, positive away from the user and negative toward the user, with float precision (added in 2.0.18) | +| | | | +| ------ | ------------- | -------------------------------------------------------------------------------------------------------------------------------- | +| Uint32 | **type** | SDL_MOUSEWHEEL | +| Uint32 | **timestamp** | timestamp of the event | +| Uint32 | **windowID** | the window with mouse focus, if any | +| Uint32 | **which** | the mouse instance id, or SDL_TOUCH_MOUSEID; see Remarks for details | +| Sint32 | **x** | the amount scrolled horizontally, positive to the right and negative to the left | +| Sint32 | **y** | the amount scrolled vertically, positive away from the user and negative towards the user | +| Uint32 | **direction** | SDL_MOUSEWHEEL_NORMAL or SDL_MOUSEWHEEL_FLIPPED; see Remarks for details (>= SDL 2.0.4) | +| float | **preciseX** | the amount scrolled horizontally, positive to the right and negative to the left, with float precision (added in 2.0.18) | +| float | **preciseY** | the amount scrolled vertically, positive away from the user and negative toward the user, with float precision (added in 2.0.18) | ## Related Enumerations diff --git a/SDL2/SDL_MultiGestureEvent.md b/SDL2/SDL_MultiGestureEvent.md index d89cd8a23..66b259e86 100644 --- a/SDL2/SDL_MultiGestureEvent.md +++ b/SDL2/SDL_MultiGestureEvent.md @@ -30,16 +30,16 @@ typedef struct SDL_MultiGestureEvent ## Data Fields -| | | | -| ----------- | ---------------- | ------------------------------------------------------------------ | -| Uint32 | '''type''' | SDL_MULTIGESTURE | -| Uint32 | '''timestamp''' | timestamp of the event | -| SDL_TouchID | '''touchId''' | the touch device id | -| float | '''dTheta''' | the amount that the fingers rotated during this motion, in radians | -| float | '''dDist''' | the amount that the fingers pinched during this motion | -| float | '''x''' | the normalized center of gesture | -| float | '''y''' | the normalized center of gesture | -| Uint16 | '''numFingers''' | the number of fingers used in the gesture | +| | | | +| ----------- | -------------- | ------------------------------------------------------------------ | +| Uint32 | **type** | SDL_MULTIGESTURE | +| Uint32 | **timestamp** | timestamp of the event | +| SDL_TouchID | **touchId** | the touch device id | +| float | **dTheta** | the amount that the fingers rotated during this motion, in radians | +| float | **dDist** | the amount that the fingers pinched during this motion | +| float | **x** | the normalized center of gesture | +| float | **y** | the normalized center of gesture | +| Uint16 | **numFingers** | the number of fingers used in the gesture | ## Related Enumerations diff --git a/SDL2/SDL_Point.md b/SDL2/SDL_Point.md index be9afec64..a66286f8c 100644 --- a/SDL2/SDL_Point.md +++ b/SDL2/SDL_Point.md @@ -82,10 +82,10 @@ int main(int argc, char *argv[]) { ## Data Fields -| | | | -| --- | ------- | ----------------------------- | -| int | '''x''' | the x coordinate of the point | -| int | '''y''' | the y coordinate of the point | +| | | | +| --- | ----- | ----------------------------- | +| int | **x** | the x coordinate of the point | +| int | **y** | the y coordinate of the point | ## Related Structures diff --git a/SDL2/SDL_QuitEvent.md b/SDL2/SDL_QuitEvent.md index 05c9b6731..1d9eb0ddf 100644 --- a/SDL2/SDL_QuitEvent.md +++ b/SDL2/SDL_QuitEvent.md @@ -32,10 +32,10 @@ for (;;) { ## Data Fields -| | | | -| ------ | --------------- | ---------------------- | -| Uint32 | '''type''' | SDL_QUIT | -| Uint32 | '''timestamp''' | timestamp of the event | +| | | | +| ------ | ------------- | ---------------------- | +| Uint32 | **type** | SDL_QUIT | +| Uint32 | **timestamp** | timestamp of the event | ## Related Enumerations diff --git a/SDL2/SDL_RWops.md b/SDL2/SDL_RWops.md index 13519bac8..b8f8fa603 100644 --- a/SDL2/SDL_RWops.md +++ b/SDL2/SDL_RWops.md @@ -124,15 +124,15 @@ if (io != NULL) { ## Data Fields -| | | | -| ----------------------------------------------------- | ------------ | ------------------------------------------------ | -| Sint64 (*)(SDL_RWops *) | '''size''' | callback that reports stream size; see Remarks | -| Sint64 (*)(SDL_RWops *, Sint64, int) | '''seek''' | callback that seeks in stream; see Remarks | -| size_t (*)(SDL_RWops *, void *, size_t, size_t) | '''read''' | callback that reads from the stream; see Remarks | -| size_t (*)(SDL_RWops *, const void *, size_t, size_t) | '''write''' | callback that writes to the stream; see Remarks | -| int (*)(SDL_RWops *) | '''close''' | callback that closes the stream; see Remarks | -| Uint32 | '''type''' | type of stream; see Remarks | -| union | '''hidden''' | type-specific data; see Remarks | +| | | | +| ----------------------------------------------------- | ---------- | ------------------------------------------------ | +| Sint64 (*)(SDL_RWops *) | **size** | callback that reports stream size; see Remarks | +| Sint64 (*)(SDL_RWops *, Sint64, int) | **seek** | callback that seeks in stream; see Remarks | +| size_t (*)(SDL_RWops *, void *, size_t, size_t) | **read** | callback that reads from the stream; see Remarks | +| size_t (*)(SDL_RWops *, const void *, size_t, size_t) | **write** | callback that writes to the stream; see Remarks | +| int (*)(SDL_RWops *) | **close** | callback that closes the stream; see Remarks | +| Uint32 | **type** | type of stream; see Remarks | +| union | **hidden** | type-specific data; see Remarks | ---- [CategoryAPI](CategoryAPI), [CategoryAPIStruct](CategoryAPIStruct), [CategoryStruct](CategoryStruct), [CategoryIO](CategoryIO) diff --git a/SDL2/SDL_Rect.md b/SDL2/SDL_Rect.md index ba6d0634d..0cb77b2e8 100644 --- a/SDL2/SDL_Rect.md +++ b/SDL2/SDL_Rect.md @@ -49,12 +49,12 @@ SDL_BlitSurface(src, &srcrect, dst, &dstrect); ## Data Fields -| | | | -| --- | ------- | --------------------------------------------------- | -| int | '''x''' | the x location of the rectangle's upper left corner | -| int | '''y''' | the y location of the rectangle's upper left corner | -| int | '''w''' | the width of the rectangle | -| int | '''h''' | the height of the rectangle | +| | | | +| --- | ----- | --------------------------------------------------- | +| int | **x** | the x location of the rectangle's upper left corner | +| int | **y** | the y location of the rectangle's upper left corner | +| int | **w** | the width of the rectangle | +| int | **h** | the height of the rectangle | ---- [CategoryAPI](CategoryAPI), [CategoryAPIStruct](CategoryAPIStruct), [CategoryStruct](CategoryStruct), [CategoryRect](CategoryRect) diff --git a/SDL2/SDL_RendererInfo.md b/SDL2/SDL_RendererInfo.md index f007d7f26..f5ef0ec6b 100644 --- a/SDL2/SDL_RendererInfo.md +++ b/SDL2/SDL_RendererInfo.md @@ -23,14 +23,14 @@ typedef struct SDL_RendererInfo ## Data Fields -| | | | -| ----------- | ------------------------- | ----------------------------------------------------------- | -| const char* | '''name''' | the name of the renderer | -| Uint32 | '''flags''' | a mask of supported renderer flags; see Remarks for details | -| Uint32 | '''num_texture_formats''' | the number of available texture formats | -| Uint32[16] | '''texture_formats''' | the available texture formats; see Remarks for details | -| int | '''max_texture_width''' | the maximum texture width | -| int | '''max_texture_height''' | the maximum texture height | +| | | | +| ----------- | ----------------------- | ----------------------------------------------------------- | +| const char* | **name** | the name of the renderer | +| Uint32 | **flags** | a mask of supported renderer flags; see Remarks for details | +| Uint32 | **num_texture_formats** | the number of available texture formats | +| Uint32[16] | **texture_formats** | the available texture formats; see Remarks for details | +| int | **max_texture_width** | the maximum texture width | +| int | **max_texture_height** | the maximum texture height | ## Related Enumerations diff --git a/SDL2/SDL_SensorEvent.md b/SDL2/SDL_SensorEvent.md index f7340c24b..cdc175e43 100644 --- a/SDL2/SDL_SensorEvent.md +++ b/SDL2/SDL_SensorEvent.md @@ -22,12 +22,12 @@ typedef struct SDL_SensorEvent ## Data Fields -| | | | -| -------- | --------------- | ------------------------------------------------------------------------------------------- | -| Uint32 | '''type''' | SDL_SENSORUPDATE | -| Uint32 | '''timestamp''' | In milliseconds, populated using SDL_GetTicks() | -| Sint32 | '''which''' | The instance ID of the sensor | -| float[6] | '''data''' | Up to 6 values from the sensor - additional values can be queried using SDL_SensorGetData() | +| | | | +| -------- | ------------- | ------------------------------------------------------------------------------------------- | +| Uint32 | **type** | SDL_SENSORUPDATE | +| Uint32 | **timestamp** | In milliseconds, populated using SDL_GetTicks() | +| Sint32 | **which** | The instance ID of the sensor | +| float[6] | **data** | Up to 6 values from the sensor - additional values can be queried using SDL_SensorGetData() | ## Related Enumerations diff --git a/SDL2/SDL_Surface.md b/SDL2/SDL_Surface.md index 80d3982cb..7195e109b 100644 --- a/SDL2/SDL_Surface.md +++ b/SDL2/SDL_Surface.md @@ -60,19 +60,19 @@ void WipeSurface(SDL_Surface *surface) ## Data Fields -| | | | -| ------------------------------------------------------------ | --------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| Uint32 | '''flags''' | (internal use) | -| [SDL_PixelFormat](SDL_PixelFormat)* | '''format''' | the format of the pixels stored in the surface; see [SDL_PixelFormat](SDL_PixelFormat) for details (read-only) | -| int | '''w, h''' | the width and height in pixels (read-only) | -| int | '''pitch''' | the length of a row of pixels in bytes (read-only) | -| void* | '''pixels''' | the pointer to the actual pixel data; see Remarks for details (read-write) | -| void* | '''userdata''' | an arbitrary pointer you can set (read-write) | -| int | '''locked''' | used for surfaces that require locking (internal use) | -| void* | '''lock_data''' | used for surfaces that require locking (internal use) | -| [SDL_Rect](SDL_Rect) | '''clip_rect''' | an [SDL_Rect](SDL_Rect) structure used to clip blits to the surface which can be set by [SDL_SetClipRect](SDL_SetClipRect)() (read-only) | -| SDL_BlitMap* | '''map''' | info for fast blit mapping to other surfaces (internal use) | -| int | '''refcount''' | reference count that can be incremented by the application | +| | | | +| ------------------------------------------------------------ | ------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | +| Uint32 | **flags** | (internal use) | +| [SDL_PixelFormat](SDL_PixelFormat)* | **format** | the format of the pixels stored in the surface; see [SDL_PixelFormat](SDL_PixelFormat) for details (read-only) | +| int | **w, h** | the width and height in pixels (read-only) | +| int | **pitch** | the length of a row of pixels in bytes (read-only) | +| void* | **pixels** | the pointer to the actual pixel data; see Remarks for details (read-write) | +| void* | **userdata** | an arbitrary pointer you can set (read-write) | +| int | **locked** | used for surfaces that require locking (internal use) | +| void* | **lock_data** | used for surfaces that require locking (internal use) | +| [SDL_Rect](SDL_Rect) | **clip_rect** | an [SDL_Rect](SDL_Rect) structure used to clip blits to the surface which can be set by [SDL_SetClipRect](SDL_SetClipRect)() (read-only) | +| SDL_BlitMap* | **map** | info for fast blit mapping to other surfaces (internal use) | +| int | **refcount** | reference count that can be incremented by the application | ---- [CategoryAPI](CategoryAPI), [CategoryAPIStruct](CategoryAPIStruct), [CategoryStruct](CategoryStruct), [CategorySurface](CategorySurface) diff --git a/SDL2/SDL_SysWMEvent.md b/SDL2/SDL_SysWMEvent.md index 34be4cc2d..e44634b06 100644 --- a/SDL2/SDL_SysWMEvent.md +++ b/SDL2/SDL_SysWMEvent.md @@ -20,11 +20,11 @@ typedef struct SDL_SysWMEvent ## Data Fields -| | | | -| ----------------------------- | --------------- | --------------------------------------------- | -| Uint32 | '''type''' | SDL_SYSWMEVENT | -| Uint32 | '''timestamp''' | timestamp of the event | -| [SDL_SysWMmsg](SDL_SysWMmsg)* | '''msg''' | driver dependent data, defined in SDL_syswm.h | +| | | | +| ----------------------------- | ------------- | --------------------------------------------- | +| Uint32 | **type** | SDL_SYSWMEVENT | +| Uint32 | **timestamp** | timestamp of the event | +| [SDL_SysWMmsg](SDL_SysWMmsg)* | **msg** | driver dependent data, defined in SDL_syswm.h | ## Related Enumerations diff --git a/SDL2/SDL_SysWMinfo.md b/SDL2/SDL_SysWMinfo.md index c4a101510..d3c6661de 100644 --- a/SDL2/SDL_SysWMinfo.md +++ b/SDL2/SDL_SysWMinfo.md @@ -144,45 +144,45 @@ system it is using, and will be one of [SDL_SYSWM_TYPE](SDL_SYSWM_TYPE). ## Data Fields -| | | | -| -------------------------------- | -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| | | style="background-color: #EDEDED;" | ''All Subsystems'' | -| [SDL_version](SDL_version) | '''version''' | an [SDL_version](SDL_version) structure that contains the current SDL version | -| [SDL_SYSWM_TYPE](SDL_SYSWM_TYPE) | '''subsystem''' | the windowing system type; see Remarks for details | -| style="color: #808080;" | int | style="color: #808080;" | '''dummy''' | style="color: #808080;" | unused (to help compilers when no specific system is available) | -| | | style="background-color: #EDEDED;" | ''SDL_SYSWM_WINDOWS'' | -| HWND | '''win.window''' | the window handle | -| HDC | '''win.hdc''' | the window device context (>= SDL 2.0.4) | -| HINSTANCE | '''win.hinstance''' | the window hinstance (>= SDL 2.0.6) | -| | | style="background-color: #EDEDED;" | ''SDL_SYSWM_WINRT'' (>= SDL 2.0.3) | -| IInspectable* | '''winrt.window''' | the WinRT CoreWindow | -| | | style="background-color: #EDEDED;" | ''SDL_SYSWM_X11'' | -| Display* | '''x11.display''' | the X11 display | -| Window | '''x11.window''' | the X11 window | -| | | style="background-color: #EDEDED;" | ''SDL_SYSWM_DIRECTFB'' | -| IDirectFB* | '''dfb.dfb''' | the DirectFB main interface | -| IDirectFBWindow* | '''dfb.window''' | the DirectFB window handle | -| IDirectFBSurface* | '''dfb.surface''' | the DirectFB client surface | -| | | style="background-color: #EDEDED;" | ''SDL_SYSWM_COCOA'' | -| NSWindow* | '''cocoa.window''' | the Cocoa window | -| | | style="background-color: #EDEDED;" | ''SDL_SYSWM_UIKIT'' | -| UIWindow* | '''uikit.window''' | the UIKit window | -| GLuint | '''uikit.framebuffer''' | the GL view's Framebuffer Object; it must be bound when rendering to the screen using GL (>= SDL 2.0.4) | -| GLuint | '''uikit.colorbuffer''' | the GL view's color Renderbuffer Object; it must be bound when [SDL_GL_SwapWindow](SDL_GL_SwapWindow)() is called (>= SDL 2.0.4) | -| GLuint | '''uikit.resolveFramebuffer''' | the Framebuffer Object which holds the resolve color Renderbuffer, when MSAA is used (>= SDL 2.0.4) | -| | | style="background-color: #EDEDED;" | ''SDL_SYSWM_WAYLAND'' (>= SDL 2.0.2) | -| wl_display* | '''wl.display''' | the Wayland display | -| wl_surface* | '''wl.surface''' | the Wayland surface | -| wl_shell_surface* | '''wl.shell_surface''' | the Wayland shell_surface (window manager handle) | -| | | style="background-color: #EDEDED;" | ''SDL_SYSWM_MIR'' (>= SDL 2.0.2) | -| MirConnection* | '''mir.connection''' | the Mir display server connection | -| MirSurface* | '''mir.surface''' | the Mir surface | -| | | style="background-color: #EDEDED;" | ''SDL_SYSWM_ANDROID'' (>= SDL 2.0.4) | -| ANativeWindow* | '''android.window''' | the Android native window | -| EGLSurface | '''android.surface''' | the Android EGL surface | -| | | style="background-color: #EDEDED;" | ''SDL_SYSWM_VIVANTE'' (>= SDL 2.0.5) | -| EGLNativeDisplayType | '''vivante.display''' | the Vivante EGL display type | -| EGLNativeWindowType | '''vivante.window''' | the Vivante EGL window type | +| | | | +| -------------------------------- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------- | +| | | style="background-color: #EDEDED;" | ''All Subsystems'' | +| [SDL_version](SDL_version) | **version** | an [SDL_version](SDL_version) structure that contains the current SDL version | +| [SDL_SYSWM_TYPE](SDL_SYSWM_TYPE) | **subsystem** | the windowing system type; see Remarks for details | +| style="color: #808080;" | int | style="color: #808080;" | **dummy** | style="color: #808080;" | unused (to help compilers when no specific system is available) | +| | | style="background-color: #EDEDED;" | ''SDL_SYSWM_WINDOWS'' | +| HWND | **win.window** | the window handle | +| HDC | **win.hdc** | the window device context (>= SDL 2.0.4) | +| HINSTANCE | **win.hinstance** | the window hinstance (>= SDL 2.0.6) | +| | | style="background-color: #EDEDED;" | ''SDL_SYSWM_WINRT'' (>= SDL 2.0.3) | +| IInspectable* | **winrt.window** | the WinRT CoreWindow | +| | | style="background-color: #EDEDED;" | ''SDL_SYSWM_X11'' | +| Display* | **x11.display** | the X11 display | +| Window | **x11.window** | the X11 window | +| | | style="background-color: #EDEDED;" | ''SDL_SYSWM_DIRECTFB'' | +| IDirectFB* | **dfb.dfb** | the DirectFB main interface | +| IDirectFBWindow* | **dfb.window** | the DirectFB window handle | +| IDirectFBSurface* | **dfb.surface** | the DirectFB client surface | +| | | style="background-color: #EDEDED;" | ''SDL_SYSWM_COCOA'' | +| NSWindow* | **cocoa.window** | the Cocoa window | +| | | style="background-color: #EDEDED;" | ''SDL_SYSWM_UIKIT'' | +| UIWindow* | **uikit.window** | the UIKit window | +| GLuint | **uikit.framebuffer** | the GL view's Framebuffer Object; it must be bound when rendering to the screen using GL (>= SDL 2.0.4) | +| GLuint | **uikit.colorbuffer** | the GL view's color Renderbuffer Object; it must be bound when [SDL_GL_SwapWindow](SDL_GL_SwapWindow)() is called (>= SDL 2.0.4) | +| GLuint | **uikit.resolveFramebuffer** | the Framebuffer Object which holds the resolve color Renderbuffer, when MSAA is used (>= SDL 2.0.4) | +| | | style="background-color: #EDEDED;" | ''SDL_SYSWM_WAYLAND'' (>= SDL 2.0.2) | +| wl_display* | **wl.display** | the Wayland display | +| wl_surface* | **wl.surface** | the Wayland surface | +| wl_shell_surface* | **wl.shell_surface** | the Wayland shell_surface (window manager handle) | +| | | style="background-color: #EDEDED;" | ''SDL_SYSWM_MIR'' (>= SDL 2.0.2) | +| MirConnection* | **mir.connection** | the Mir display server connection | +| MirSurface* | **mir.surface** | the Mir surface | +| | | style="background-color: #EDEDED;" | ''SDL_SYSWM_ANDROID'' (>= SDL 2.0.4) | +| ANativeWindow* | **android.window** | the Android native window | +| EGLSurface | **android.surface** | the Android EGL surface | +| | | style="background-color: #EDEDED;" | ''SDL_SYSWM_VIVANTE'' (>= SDL 2.0.5) | +| EGLNativeDisplayType | **vivante.display** | the Vivante EGL display type | +| EGLNativeWindowType | **vivante.window** | the Vivante EGL window type | ## Related Enumerations diff --git a/SDL2/SDL_SysWMmsg.md b/SDL2/SDL_SysWMmsg.md index caf170020..a4363a55b 100644 --- a/SDL2/SDL_SysWMmsg.md +++ b/SDL2/SDL_SysWMmsg.md @@ -76,27 +76,27 @@ struct SDL_SysWMmsg ## Data Fields -| | | | -| -------------------------------- | -------------------------------------------- | ---------------------------------------------------------------------------------------- | -| | | ''All Subsystems'' | -| [SDL_version](SDL_version) | '''version''' | an [SDL_version](SDL_version) structure that contains the current SDL version | -| [SDL_SYSWM_TYPE](SDL_SYSWM_TYPE) | '''subsystem''' | the windowing system type; see Remarks for details | -| int | '''dummy''' | unused (to help compilers when no specific system is available) | -| | | ''SDL_SYSWM_WINDOWS'' | -| HWND | '''win.hwnd''' | the window for the message | -| UINT | '''win.msg''' | the type of message | -| WPARAM | '''win.wParam''' | WORD message parameter | -| LPARAM | '''win.lParam''' | LONG message parameter | -| | | ''SDL_SYSWM_X11'' | -| XEvent | '''x11.event''' | the native x11 event structure | -| | | ''SDL_SYSWM_DIRECTFB'' | -| DFBEvent | '''dfb.event''' | the DirectFB event | -| | | ''SDL_SYSWM_COCOA'' | -| int | '''cocoa.dummy''' | unused (>= SDL 2.0.4) | -| | | ''SDL_SYSWM_UIKIT'' | -| int | '''uikit.dummy''' | unused (>= SDL 2.0.4) | -| | | ''SDL_SYSWM_VIVANTE'' | -| int | '''vivante.dummy''' | unused (>= SDL 2.0.5) | +| | | | +| -------------------------------- | ------------------------------------------ | ---------------------------------------------------------------------------------------- | +| | | ''All Subsystems'' | +| [SDL_version](SDL_version) | **version** | an [SDL_version](SDL_version) structure that contains the current SDL version | +| [SDL_SYSWM_TYPE](SDL_SYSWM_TYPE) | **subsystem** | the windowing system type; see Remarks for details | +| int | **dummy** | unused (to help compilers when no specific system is available) | +| | | ''SDL_SYSWM_WINDOWS'' | +| HWND | **win.hwnd** | the window for the message | +| UINT | **win.msg** | the type of message | +| WPARAM | **win.wParam** | WORD message parameter | +| LPARAM | **win.lParam** | LONG message parameter | +| | | ''SDL_SYSWM_X11'' | +| XEvent | **x11.event** | the native x11 event structure | +| | | ''SDL_SYSWM_DIRECTFB'' | +| DFBEvent | **dfb.event** | the DirectFB event | +| | | ''SDL_SYSWM_COCOA'' | +| int | **cocoa.dummy** | unused (>= SDL 2.0.4) | +| | | ''SDL_SYSWM_UIKIT'' | +| int | **uikit.dummy** | unused (>= SDL 2.0.4) | +| | | ''SDL_SYSWM_VIVANTE'' | +| int | **vivante.dummy** | unused (>= SDL 2.0.5) | ## Related Enumerations diff --git a/SDL2/SDL_TextEditingEvent.md b/SDL2/SDL_TextEditingEvent.md index c681fe9de..0cf864ce3 100644 --- a/SDL2/SDL_TextEditingEvent.md +++ b/SDL2/SDL_TextEditingEvent.md @@ -23,14 +23,14 @@ typedef struct SDL_TextEditingEvent ## Data Fields -| | | | -| -------- | --------------- | ----------------------------------------------------- | -| Uint32 | '''type''' | SDL_TEXTEDITING | -| Uint32 | '''timestamp''' | timestamp of the event | -| Uint32 | '''windowID''' | the window with keyboard focus, if any | -| char[32] | '''text''' | the null-terminated editing text in UTF-8 encoding | -| Sint32 | '''start''' | the location to begin editing from | -| Sint32 | '''length''' | the number of characters to edit from the start point | +| | | | +| -------- | ------------- | ----------------------------------------------------- | +| Uint32 | **type** | SDL_TEXTEDITING | +| Uint32 | **timestamp** | timestamp of the event | +| Uint32 | **windowID** | the window with keyboard focus, if any | +| char[32] | **text** | the null-terminated editing text in UTF-8 encoding | +| Sint32 | **start** | the location to begin editing from | +| Sint32 | **length** | the number of characters to edit from the start point | ## Related Enumerations diff --git a/SDL2/SDL_TextInputEvent.md b/SDL2/SDL_TextInputEvent.md index ab873aa3d..59cf9efcf 100644 --- a/SDL2/SDL_TextInputEvent.md +++ b/SDL2/SDL_TextInputEvent.md @@ -21,12 +21,12 @@ typedef struct SDL_TextInputEvent ## Data Fields -| | | | -| --------- | --------------- | ------------------------------------------------- | -| Uint32 | '''type''' | SDL_TEXTINPUT | -| Uint32 | '''timestamp''' | timestamp of the event | -| Uint32 | '''windowID''' | the window with keyboard focus, if any | -| char[32] | '''text''' | the null-terminated input text in UTF-8 encoding | +| | | | +| --------- | ------------- | ------------------------------------------------- | +| Uint32 | **type** | SDL_TEXTINPUT | +| Uint32 | **timestamp** | timestamp of the event | +| Uint32 | **windowID** | the window with keyboard focus, if any | +| char[32] | **text** | the null-terminated input text in UTF-8 encoding | ## Related Enumerations diff --git a/SDL2/SDL_TouchFingerEvent.md b/SDL2/SDL_TouchFingerEvent.md index 71241a5e7..1a487e422 100644 --- a/SDL2/SDL_TouchFingerEvent.md +++ b/SDL2/SDL_TouchFingerEvent.md @@ -27,18 +27,18 @@ typedef struct SDL_TouchFingerEvent ## Data Fields -| | | | -| ------------ | --------------- | ---------------------------------------------------------- | -| Uint32 | '''type''' | SDL_FINGERMOTION, SDL_FINGERDOWN, or SDL_FINGERUP | -| Uint32 | '''timestamp''' | timestamp of the event | -| SDL_TouchID | '''touchId''' | the touch device id | -| SDL_FingerID | '''fingerId''' | the finger id | -| float | '''x''' | the x-axis location of the touch event, normalized (0...1) | -| float | '''y''' | the y-axis location of the touch event, normalized (0...1) | -| float | '''dx''' | the distance moved in the x-axis, normalized (-1...1) | -| float | '''dy''' | the distance moved in the y-axis, normalized (-1...1) | -| float | '''pressure''' | the quantity of pressure applied, normalized (0...1) | -| Uint32 | '''windowID''' | the window underneath the finger, if any | +| | | | +| ------------ | ------------- | ---------------------------------------------------------- | +| Uint32 | **type** | SDL_FINGERMOTION, SDL_FINGERDOWN, or SDL_FINGERUP | +| Uint32 | **timestamp** | timestamp of the event | +| SDL_TouchID | **touchId** | the touch device id | +| SDL_FingerID | **fingerId** | the finger id | +| float | **x** | the x-axis location of the touch event, normalized (0...1) | +| float | **y** | the y-axis location of the touch event, normalized (0...1) | +| float | **dx** | the distance moved in the x-axis, normalized (-1...1) | +| float | **dy** | the distance moved in the y-axis, normalized (-1...1) | +| float | **pressure** | the quantity of pressure applied, normalized (0...1) | +| Uint32 | **windowID** | the window underneath the finger, if any | ## Related Enumerations diff --git a/SDL2/SDL_UserEvent.md b/SDL2/SDL_UserEvent.md index 26b4b75ec..2864b230f 100644 --- a/SDL2/SDL_UserEvent.md +++ b/SDL2/SDL_UserEvent.md @@ -41,14 +41,14 @@ if (myEventType != ((Uint32)-1)) { ## Data Fields -| | | | -| ------ | --------------- | -------------------------------------------------------------- | -| Uint32 | '''type''' | value obtained from [SDL_RegisterEvents](SDL_RegisterEvents)() | -| Uint32 | '''timestamp''' | timestamp of the event | -| Uint32 | '''windowID''' | the associated window, if any | -| Sint32 | '''code''' | user defined event code | -| void* | '''data1''' | user defined data pointer | -| void* | '''data2''' | user defined data pointer | +| | | | +| ------ | ------------- | -------------------------------------------------------------- | +| Uint32 | **type** | value obtained from [SDL_RegisterEvents](SDL_RegisterEvents)() | +| Uint32 | **timestamp** | timestamp of the event | +| Uint32 | **windowID** | the associated window, if any | +| Sint32 | **code** | user defined event code | +| void* | **data1** | user defined data pointer | +| void* | **data2** | user defined data pointer | ## Related Enumerations diff --git a/SDL2/SDL_Vertex.md b/SDL2/SDL_Vertex.md index 4f62ad771..2100a8f17 100644 --- a/SDL2/SDL_Vertex.md +++ b/SDL2/SDL_Vertex.md @@ -20,11 +20,11 @@ typedef struct SDL_Vertex ## Data Fields -| | | | -| ---------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | -| SDL_FPoint | '''position''' | Vertex position, in SDL_Renderer coordinates | -| SDL_Color | '''color''' | Vertex color | -| SDL_FPoint | '''tex_coord''' | Normalized texture coordinates, if needed (Range from 0 to 1, i.ie for a 64x64px texture, beginning at 32x32px will be entered as 0.5,0,5) | +| | | | +| ---------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | +| SDL_FPoint | **position** | Vertex position, in SDL_Renderer coordinates | +| SDL_Color | **color** | Vertex color | +| SDL_FPoint | **tex_coord** | Normalized texture coordinates, if needed (Range from 0 to 1, i.ie for a 64x64px texture, beginning at 32x32px will be entered as 0.5,0,5) | ## Related Structures diff --git a/SDL2/SDL_WindowEvent.md b/SDL2/SDL_WindowEvent.md index 04b308342..595a3d013 100644 --- a/SDL2/SDL_WindowEvent.md +++ b/SDL2/SDL_WindowEvent.md @@ -103,14 +103,14 @@ void PrintEvent(const SDL_Event *event) ## Data Fields -| | | | -| ------ | --------------- | -------------------------------------- | -| Uint32 | '''type''' | SDL_WINDOWEVENT | -| Uint32 | '''timestamp''' | timestamp of the event | -| Uint32 | '''windowID''' | the associated window | -| Uint8 | '''event''' | [SDL_WindowEventID](SDL_WindowEventID) | -| Sint32 | '''data1''' | event dependent data | -| Sint32 | '''data2''' | event dependent data | +| | | | +| ------ | ------------- | -------------------------------------- | +| Uint32 | **type** | SDL_WINDOWEVENT | +| Uint32 | **timestamp** | timestamp of the event | +| Uint32 | **windowID** | the associated window | +| Uint8 | **event** | [SDL_WindowEventID](SDL_WindowEventID) | +| Sint32 | **data1** | event dependent data | +| Sint32 | **data2** | event dependent data | ## Related Enumerations diff --git a/SDL2/SDL_atomic_t.md b/SDL2/SDL_atomic_t.md index 3e8b8fc5a..887cc19bc 100644 --- a/SDL2/SDL_atomic_t.md +++ b/SDL2/SDL_atomic_t.md @@ -84,9 +84,9 @@ quit: ## Data Fields -| | | | -| --- | ----------- | ------------------------ | -| int | '''value''' | the atomic integer value | +| | | | +| --- | --------- | ------------------------ | +| int | **value** | the atomic integer value | ---- [CategoryAPI](CategoryAPI), [CategoryAPIStruct](CategoryAPIStruct), [CategoryStruct](CategoryStruct), [CategoryAtomic](CategoryAtomic)