We are currently migrating Bugzilla to GitHub issues.
Any changes made to the bug tracker now will be lost, so please do not post new bugs or make changes to them.
When we're done, all bug URLs will redirect to their equivalent location on the new bug tracker.

Documentation fix patch

document-event-timestamps.patch (text/plain), 9.25 KB, created by Charles Huber on 2013-11-22 23:17:47 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Charles Huber

Created: 2013-11-22 23:17:47 UTC

Size: 9.25 KB

patch

obsolete

># HG changeset patch
># User Charles Huber <genpfault@gmail.com>
># Date 1385162046 21600
>#      Fri Nov 22 17:14:06 2013 -0600
># Branch fixdocs
># Node ID 867c8be37398498f63a4407a78257192d533635a
># Parent  7396e3cc5337e846314ccff0eade0c00be7b4a82
>Document event timestamp members
>
>Add a note to each event indicating the units and source of the timestamp member.
>
>diff -r 7396e3cc5337 -r 867c8be37398 include/SDL_events.h
>--- a/include/SDL_events.h	Fri Nov 22 14:19:52 2013 -0300
>+++ b/include/SDL_events.h	Fri Nov 22 17:14:06 2013 -0600
>@@ -151,7 +151,7 @@
> typedef struct SDL_CommonEvent
> {
>     Uint32 type;
>-    Uint32 timestamp;
>+    Uint32 timestamp;   /**< In milliseconds, populated using SDL_GetTicks() */
> } SDL_CommonEvent;
> 
> /**
>@@ -160,7 +160,7 @@
> typedef struct SDL_WindowEvent
> {
>     Uint32 type;        /**< ::SDL_WINDOWEVENT */
>-    Uint32 timestamp;
>+    Uint32 timestamp;   /**< In milliseconds, populated using SDL_GetTicks() */
>     Uint32 windowID;    /**< The associated window */
>     Uint8 event;        /**< ::SDL_WindowEventID */
>     Uint8 padding1;
>@@ -176,7 +176,7 @@
> typedef struct SDL_KeyboardEvent
> {
>     Uint32 type;        /**< ::SDL_KEYDOWN or ::SDL_KEYUP */
>-    Uint32 timestamp;
>+    Uint32 timestamp;   /**< In milliseconds, populated using SDL_GetTicks() */
>     Uint32 windowID;    /**< The window with keyboard focus, if any */
>     Uint8 state;        /**< ::SDL_PRESSED or ::SDL_RELEASED */
>     Uint8 repeat;       /**< Non-zero if this is a key repeat */
>@@ -192,7 +192,7 @@
> typedef struct SDL_TextEditingEvent
> {
>     Uint32 type;                                /**< ::SDL_TEXTEDITING */
>-    Uint32 timestamp;
>+    Uint32 timestamp;                           /**< In milliseconds, populated using SDL_GetTicks() */
>     Uint32 windowID;                            /**< The window with keyboard focus, if any */
>     char text[SDL_TEXTEDITINGEVENT_TEXT_SIZE];  /**< The editing text */
>     Sint32 start;                               /**< The start cursor of selected editing text */
>@@ -207,7 +207,7 @@
> typedef struct SDL_TextInputEvent
> {
>     Uint32 type;                              /**< ::SDL_TEXTINPUT */
>-    Uint32 timestamp;
>+    Uint32 timestamp;                         /**< In milliseconds, populated using SDL_GetTicks() */
>     Uint32 windowID;                          /**< The window with keyboard focus, if any */
>     char text[SDL_TEXTINPUTEVENT_TEXT_SIZE];  /**< The input text */
> } SDL_TextInputEvent;
>@@ -218,7 +218,7 @@
> typedef struct SDL_MouseMotionEvent
> {
>     Uint32 type;        /**< ::SDL_MOUSEMOTION */
>-    Uint32 timestamp;
>+    Uint32 timestamp;   /**< In milliseconds, populated using SDL_GetTicks() */
>     Uint32 windowID;    /**< The window with mouse focus, if any */
>     Uint32 which;       /**< The mouse instance id, or SDL_TOUCH_MOUSEID */
>     Uint32 state;       /**< The current button state */
>@@ -234,7 +234,7 @@
> typedef struct SDL_MouseButtonEvent
> {
>     Uint32 type;        /**< ::SDL_MOUSEBUTTONDOWN or ::SDL_MOUSEBUTTONUP */
>-    Uint32 timestamp;
>+    Uint32 timestamp;   /**< In milliseconds, populated using SDL_GetTicks() */
>     Uint32 windowID;    /**< The window with mouse focus, if any */
>     Uint32 which;       /**< The mouse instance id, or SDL_TOUCH_MOUSEID */
>     Uint8 button;       /**< The mouse button index */
>@@ -251,7 +251,7 @@
> typedef struct SDL_MouseWheelEvent
> {
>     Uint32 type;        /**< ::SDL_MOUSEWHEEL */
>-    Uint32 timestamp;
>+    Uint32 timestamp;   /**< In milliseconds, populated using SDL_GetTicks() */
>     Uint32 windowID;    /**< The window with mouse focus, if any */
>     Uint32 which;       /**< The mouse instance id, or SDL_TOUCH_MOUSEID */
>     Sint32 x;           /**< The amount scrolled horizontally */
>@@ -264,7 +264,7 @@
> typedef struct SDL_JoyAxisEvent
> {
>     Uint32 type;        /**< ::SDL_JOYAXISMOTION */
>-    Uint32 timestamp;
>+    Uint32 timestamp;   /**< In milliseconds, populated using SDL_GetTicks() */
>     SDL_JoystickID which; /**< The joystick instance id */
>     Uint8 axis;         /**< The joystick axis index */
>     Uint8 padding1;
>@@ -280,7 +280,7 @@
> typedef struct SDL_JoyBallEvent
> {
>     Uint32 type;        /**< ::SDL_JOYBALLMOTION */
>-    Uint32 timestamp;
>+    Uint32 timestamp;   /**< In milliseconds, populated using SDL_GetTicks() */
>     SDL_JoystickID which; /**< The joystick instance id */
>     Uint8 ball;         /**< The joystick trackball index */
>     Uint8 padding1;
>@@ -296,7 +296,7 @@
> typedef struct SDL_JoyHatEvent
> {
>     Uint32 type;        /**< ::SDL_JOYHATMOTION */
>-    Uint32 timestamp;
>+    Uint32 timestamp;   /**< In milliseconds, populated using SDL_GetTicks() */
>     SDL_JoystickID which; /**< The joystick instance id */
>     Uint8 hat;          /**< The joystick hat index */
>     Uint8 value;        /**< The hat position value.
>@@ -316,7 +316,7 @@
> typedef struct SDL_JoyButtonEvent
> {
>     Uint32 type;        /**< ::SDL_JOYBUTTONDOWN or ::SDL_JOYBUTTONUP */
>-    Uint32 timestamp;
>+    Uint32 timestamp;   /**< In milliseconds, populated using SDL_GetTicks() */
>     SDL_JoystickID which; /**< The joystick instance id */
>     Uint8 button;       /**< The joystick button index */
>     Uint8 state;        /**< ::SDL_PRESSED or ::SDL_RELEASED */
>@@ -330,7 +330,7 @@
> typedef struct SDL_JoyDeviceEvent
> {
>     Uint32 type;        /**< ::SDL_JOYDEVICEADDED or ::SDL_JOYDEVICEREMOVED */
>-    Uint32 timestamp;
>+    Uint32 timestamp;   /**< In milliseconds, populated using SDL_GetTicks() */
>     Sint32 which;       /**< The joystick device index for the ADDED event, instance id for the REMOVED event */
> } SDL_JoyDeviceEvent;
> 
>@@ -341,7 +341,7 @@
> typedef struct SDL_ControllerAxisEvent
> {
>     Uint32 type;        /**< ::SDL_CONTROLLERAXISMOTION */
>-    Uint32 timestamp;
>+    Uint32 timestamp;   /**< In milliseconds, populated using SDL_GetTicks() */
>     SDL_JoystickID which; /**< The joystick instance id */
>     Uint8 axis;         /**< The controller axis (SDL_GameControllerAxis) */
>     Uint8 padding1;
>@@ -358,7 +358,7 @@
> typedef struct SDL_ControllerButtonEvent
> {
>     Uint32 type;        /**< ::SDL_CONTROLLERBUTTONDOWN or ::SDL_CONTROLLERBUTTONUP */
>-    Uint32 timestamp;
>+    Uint32 timestamp;   /**< In milliseconds, populated using SDL_GetTicks() */
>     SDL_JoystickID which; /**< The joystick instance id */
>     Uint8 button;       /**< The controller button (SDL_GameControllerButton) */
>     Uint8 state;        /**< ::SDL_PRESSED or ::SDL_RELEASED */
>@@ -373,7 +373,7 @@
> typedef struct SDL_ControllerDeviceEvent
> {
>     Uint32 type;        /**< ::SDL_CONTROLLERDEVICEADDED, ::SDL_CONTROLLERDEVICEREMOVED, or ::SDL_CONTROLLERDEVICEREMAPPED */
>-    Uint32 timestamp;
>+    Uint32 timestamp;   /**< In milliseconds, populated using SDL_GetTicks() */
>     Sint32 which;       /**< The joystick device index for the ADDED event, instance id for the REMOVED or REMAPPED event */
> } SDL_ControllerDeviceEvent;
> 
>@@ -384,7 +384,7 @@
> typedef struct SDL_TouchFingerEvent
> {
>     Uint32 type;        /**< ::SDL_FINGERMOTION or ::SDL_FINGERDOWN or ::SDL_FINGERUP */
>-    Uint32 timestamp;
>+    Uint32 timestamp;   /**< In milliseconds, populated using SDL_GetTicks() */
>     SDL_TouchID touchId; /**< The touch device id */
>     SDL_FingerID fingerId;
>     float x;            /**< Normalized in the range 0...1 */
>@@ -401,7 +401,7 @@
> typedef struct SDL_MultiGestureEvent
> {
>     Uint32 type;        /**< ::SDL_MULTIGESTURE */
>-    Uint32 timestamp;
>+    Uint32 timestamp;   /**< In milliseconds, populated using SDL_GetTicks() */
>     SDL_TouchID touchId; /**< The touch device index */
>     float dTheta;
>     float dDist;
>@@ -418,7 +418,7 @@
> typedef struct SDL_DollarGestureEvent
> {
>     Uint32 type;        /**< ::SDL_DOLLARGESTURE */
>-    Uint32 timestamp;
>+    Uint32 timestamp;   /**< In milliseconds, populated using SDL_GetTicks() */
>     SDL_TouchID touchId; /**< The touch device id */
>     SDL_GestureID gestureId;
>     Uint32 numFingers;
>@@ -436,7 +436,7 @@
> typedef struct SDL_DropEvent
> {
>     Uint32 type;        /**< ::SDL_DROPFILE */
>-    Uint32 timestamp;
>+    Uint32 timestamp;   /**< In milliseconds, populated using SDL_GetTicks() */
>     char *file;         /**< The file name, which should be freed with SDL_free() */
> } SDL_DropEvent;
> 
>@@ -447,7 +447,7 @@
> typedef struct SDL_QuitEvent
> {
>     Uint32 type;        /**< ::SDL_QUIT */
>-    Uint32 timestamp;
>+    Uint32 timestamp;   /**< In milliseconds, populated using SDL_GetTicks() */
> } SDL_QuitEvent;
> 
> /**
>@@ -456,7 +456,7 @@
> typedef struct SDL_OSEvent
> {
>     Uint32 type;        /**< ::SDL_QUIT */
>-    Uint32 timestamp;
>+    Uint32 timestamp;   /**< In milliseconds, populated using SDL_GetTicks() */
> } SDL_OSEvent;
> 
> /**
>@@ -465,7 +465,7 @@
> typedef struct SDL_UserEvent
> {
>     Uint32 type;        /**< ::SDL_USEREVENT through ::SDL_LASTEVENT-1 */
>-    Uint32 timestamp;
>+    Uint32 timestamp;   /**< In milliseconds, populated using SDL_GetTicks() */
>     Uint32 windowID;    /**< The associated window if any */
>     Sint32 code;        /**< User defined event code */
>     void *data1;        /**< User defined data pointer */
>@@ -485,7 +485,7 @@
> typedef struct SDL_SysWMEvent
> {
>     Uint32 type;        /**< ::SDL_SYSWMEVENT */
>-    Uint32 timestamp;
>+    Uint32 timestamp;   /**< In milliseconds, populated using SDL_GetTicks() */
>     SDL_SysWMmsg *msg;  /**< driver dependent data, defined in SDL_syswm.h */
> } SDL_SysWMEvent;
>

Actions: View

Attachments on bug 2263: 1466

We are currently migrating Bugzilla to GitHub issues.Any changes made to the bug tracker now will be lost, so please do not post new bugs or make changes to them.When we're done, all bug URLs will redirect to their equivalent location on the new bug tracker.

We are currently migrating Bugzilla to GitHub issues.
Any changes made to the bug tracker now will be lost, so please do not post new bugs or make changes to them.
When we're done, all bug URLs will redirect to their equivalent location on the new bug tracker.