src/haptic/windows/SDL_windowshaptic_c.h
author Ryan C. Gordon <icculus@icculus.org>
Sun, 03 Jan 2016 06:50:50 -0500
changeset 10003 d91a2c45825e
parent 9998 f67cf37e9cd4
child 10737 3406a0f8b041
permissions -rw-r--r--
Remove almost all instances of "volatile" keyword.

As Tiffany pointed out in Bugzilla, volatile is not useful for thread safety:

https://software.intel.com/en-us/blogs/2007/11/30/volatile-almost-useless-for-multi-threaded-programming/

Some of these volatiles didn't need to be, some were otherwise protected by
spinlocks or mutexes, and some got moved over to SDL_atomic_t data, etc.

Fixes Bugzilla #3220.
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2016 Sam Lantinga <slouken@libsdl.org>
     4 
     5   This software is provided 'as-is', without any express or implied
     6   warranty.  In no event will the authors be held liable for any damages
     7   arising from the use of this software.
     8 
     9   Permission is granted to anyone to use this software for any purpose,
    10   including commercial applications, and to alter it and redistribute it
    11   freely, subject to the following restrictions:
    12 
    13   1. The origin of this software must not be misrepresented; you must not
    14      claim that you wrote the original software. If you use this software
    15      in a product, an acknowledgment in the product documentation would be
    16      appreciated but is not required.
    17   2. Altered source versions must be plainly marked as such, and must not be
    18      misrepresented as being the original software.
    19   3. This notice may not be removed or altered from any source distribution.
    20 */
    21 #include "../../SDL_internal.h"
    22 
    23 #ifndef _SDL_windowshaptic_c_h
    24 #define _SDL_windowshaptic_c_h
    25 
    26 #include "SDL_thread.h"
    27 #include "../SDL_syshaptic.h"
    28 #include "../../core/windows/SDL_directx.h"
    29 #include "../../core/windows/SDL_xinput.h"
    30 
    31 /*
    32  * Haptic system hardware data.
    33  */
    34 struct haptic_hwdata
    35 {
    36 #if SDL_HAPTIC_DINPUT
    37     LPDIRECTINPUTDEVICE8 device;
    38 #endif
    39     DWORD axes[3];              /* Axes to use. */
    40     SDL_bool is_joystick;       /* Device is loaded as joystick. */
    41     Uint8 bXInputHaptic; /* Supports force feedback via XInput. */
    42     Uint8 userid; /* XInput userid index for this joystick */
    43     SDL_Thread *thread;
    44     SDL_mutex *mutex;
    45     Uint32 stopTicks;
    46     SDL_atomic_t stopThread;
    47 };
    48 
    49 
    50 /*
    51  * Haptic system effect data.
    52  */
    53 struct haptic_hweffect
    54 {
    55 #if SDL_HAPTIC_DINPUT
    56     DIEFFECT effect;
    57     LPDIRECTINPUTEFFECT ref;
    58 #endif
    59 #if SDL_HAPTIC_XINPUT
    60     XINPUT_VIBRATION vibration;
    61 #endif
    62 };
    63 
    64 /*
    65 * List of available haptic devices.
    66 */
    67 typedef struct SDL_hapticlist_item
    68 {
    69     char *name;
    70     SDL_Haptic *haptic;
    71 #if SDL_HAPTIC_DINPUT
    72     DIDEVICEINSTANCE instance;
    73     DIDEVCAPS capabilities;
    74 #endif
    75     SDL_bool bXInputHaptic; /* Supports force feedback via XInput. */
    76     Uint8 userid; /* XInput userid index for this joystick */
    77     struct SDL_hapticlist_item *next;
    78 } SDL_hapticlist_item;
    79 
    80 extern SDL_hapticlist_item *SDL_hapticlist;
    81 
    82 extern int SDL_SYS_AddHapticDevice(SDL_hapticlist_item *item);
    83 extern int SDL_SYS_RemoveHapticDevice(SDL_hapticlist_item *prev, SDL_hapticlist_item *item);
    84 
    85 #endif /* _SDL_windowshaptic_c_h */
    86 
    87 /* vi: set ts=4 sw=4 expandtab: */
    88