all: support SDL2 v2.30.0

Author: larpon

.github/workflows/ci.yml

@@ -14,7 +14,7 @@ jobs:
     timeout-minutes: 30
     env:
       VFLAGS: -cc tcc -no-retry-compilation
-      SDL2_VERSION: 2.28.0
+      SDL2_VERSION: 2.30.0
     steps:
       - name: Install dependencies
         run: |
@@ -81,7 +81,7 @@ jobs:
     runs-on: macos-11
     timeout-minutes: 30
     env:
-      SDL2_VERSION: 2.28.0
+      SDL2_VERSION: 2.30.0
     steps:
       - name: Checkout V
         uses: actions/checkout@v2
@@ -150,7 +150,7 @@ jobs:
     timeout-minutes: 30
     env:
       VFLAGS: -cc gcc -no-retry-compilation
-      SDL2_VERSION: 2.28.0
+      SDL2_VERSION: 2.30.0
     steps:
       - name: Install V
         uses: vlang/setup-v@v1
@@ -185,7 +185,7 @@ jobs:
     timeout-minutes: 30
     env:
       VFLAGS: -cc tcc -no-retry-compilation
-      SDL2_VERSION: 2.28.0
+      SDL2_VERSION: 2.30.0
     steps:
 
       - name: Install V

README.md

@@ -119,7 +119,7 @@ This will create a directory called "thirdparty" which will be used to download
 To successfully run a provided example or your own projects, the sdl dlls must be copied to the main application directory.
 e.g.:
 ```bash
-copy thirdparty\SDL2-2.28.0\lib\x64\SDL2.dll examples\basic_window\
+copy thirdparty\SDL2-2.30.0\lib\x64\SDL2.dll examples\basic_window\
 cd ..
 v run sdl\examples\basic_window\main.v
 ```

blendmode.c.v

@@ -22,8 +22,8 @@ pub enum BlendMode {
 // BlendOperation is C.SDL_BlendOperation
 pub enum BlendOperation {
 	add          = C.SDL_BLENDOPERATION_ADD // 0x1, dst + src: supported by all renderers
-	subtract     = C.SDL_BLENDOPERATION_SUBTRACT // 0x2, dst - src : supported by D3D9, D3D11, OpenGL, OpenGLES
-	rev_subtract = C.SDL_BLENDOPERATION_REV_SUBTRACT // 0x3, src - dst : supported by D3D9, D3D11, OpenGL, OpenGLES
+	subtract     = C.SDL_BLENDOPERATION_SUBTRACT // 0x2, src - dst : supported by D3D9, D3D11, OpenGL, OpenGLES
+	rev_subtract = C.SDL_BLENDOPERATION_REV_SUBTRACT // 0x3, dst - src : supported by D3D9, D3D11, OpenGL, OpenGLES
 	minimum      = C.SDL_BLENDOPERATION_MINIMUM // 0x4, min(dst, src) : supported by D3D9, D3D11
 	maximum      = C.SDL_BLENDOPERATION_MAXIMUM // 0x5 max(dst, src) : supported by D3D9, D3D11
 }

c/sdl.c.v

@@ -26,11 +26,11 @@ $if !windows {
 #flag -DSDL_DISABLE_IMMINTRIN_H
 
 $if x64 {
-	#flag windows -L @VMODROOT/thirdparty/SDL2-2.28.0/lib/x64
+	#flag windows -L @VMODROOT/thirdparty/SDL2-2.30.0/lib/x64
 } $else {
-	#flag windows -L @VMODROOT/thirdparty/SDL2-2.28.0/lib/x86
+	#flag windows -L @VMODROOT/thirdparty/SDL2-2.30.0/lib/x86
 }
-#flag windows -I @VMODROOT/thirdparty/SDL2-2.28.0/include
+#flag windows -I @VMODROOT/thirdparty/SDL2-2.30.0/include
 #flag windows -Dmain=SDL_main
 #flag windows -lSDL2main -lSDL2
 

events.c.v

@@ -40,100 +40,102 @@ pub type EventFilter = fn (userdata voidptr, event &Event)
 
 // EventType is C.SDL_EventType
 pub enum EventType {
-	firstevent               = C.SDL_FIRSTEVENT // Unused (do not remove)
-	quit                     = C.SDL_QUIT // 0x100 User-requested quit
+	firstevent                                 = C.SDL_FIRSTEVENT // Unused (do not remove)
+	quit                                       = C.SDL_QUIT // 0x100 User-requested quit
 	// These application events have special meaning on iOS, see README-ios.md in SDL for details
 	// The application is being terminated by the OS
 	// Called on iOS in applicationWillTerminate()
 	// Called on Android in onDestroy()
-	app_terminating          = C.SDL_APP_TERMINATING
+	app_terminating                            = C.SDL_APP_TERMINATING
 	// The application is low on memory, free memory if possible.
 	// Called on iOS in applicationDidReceiveMemoryWarning()
 	// Called on Android in onLowMemory()
-	app_lowmemory            = C.SDL_APP_LOWMEMORY
+	app_lowmemory                              = C.SDL_APP_LOWMEMORY
 	// The application is about to enter the background
 	// Called on iOS in applicationWillResignActive()
 	// Called on Android in onPause()
-	app_willenterbackground  = C.SDL_APP_WILLENTERBACKGROUND
+	app_willenterbackground                    = C.SDL_APP_WILLENTERBACKGROUND
 	// The application did enter the background and may not get CPU for some time
 	// Called on iOS in applicationDidEnterBackground()
 	// Called on Android in onPause()
-	app_didenterbackground   = C.SDL_APP_DIDENTERBACKGROUND
+	app_didenterbackground                     = C.SDL_APP_DIDENTERBACKGROUND
 	// The application is about to enter the foreground
 	// Called on iOS in applicationWillEnterForeground()
 	// Called on Android in onResume()
-	app_willenterforeground  = C.SDL_APP_WILLENTERFOREGROUND
+	app_willenterforeground                    = C.SDL_APP_WILLENTERFOREGROUND
 	// The application is now interactive
 	// Called on iOS in applicationDidBecomeActive()
 	// Called on Android in onResume()
-	app_didenterforeground   = C.SDL_APP_DIDENTERFOREGROUND
-	localechanged            = C.SDL_LOCALECHANGED // The user's locale preferences have changed.
+	app_didenterforeground                     = C.SDL_APP_DIDENTERFOREGROUND
+	localechanged                              = C.SDL_LOCALECHANGED // The user's locale preferences have changed.
 	// Display events
-	displayevent             = C.SDL_DISPLAYEVENT // 0x150 Display state change
+	displayevent                               = C.SDL_DISPLAYEVENT // 0x150 Display state change
 	// Window events
-	windowevent              = C.SDL_WINDOWEVENT // 0x200 Window state change
-	syswmevent               = C.SDL_SYSWMEVENT
+	windowevent                                = C.SDL_WINDOWEVENT // 0x200 Window state change
+	syswmevent                                 = C.SDL_SYSWMEVENT
 	// Keyboard events
-	keydown                  = C.SDL_KEYDOWN // 0x300, Key pressed
-	keyup                    = C.SDL_KEYUP // Key released
-	textediting              = C.SDL_TEXTEDITING // Keyboard text editing (composition)
-	textinput                = C.SDL_TEXTINPUT // Keyboard text input
-	keymapchanged            = C.SDL_KEYMAPCHANGED // Keymap changed due to a system event such as an input language or keyboard layout change.
-	textediting_ext          = C.SDL_TEXTEDITING_EXT // Extended keyboard text editing (composition)
+	keydown                                    = C.SDL_KEYDOWN // 0x300, Key pressed
+	keyup                                      = C.SDL_KEYUP // Key released
+	textediting                                = C.SDL_TEXTEDITING // Keyboard text editing (composition)
+	textinput                                  = C.SDL_TEXTINPUT // Keyboard text input
+	keymapchanged                              = C.SDL_KEYMAPCHANGED // Keymap changed due to a system event such as an input language or keyboard layout change.
+	textediting_ext                            = C.SDL_TEXTEDITING_EXT // Extended keyboard text editing (composition)
 	// Mouse events
-	mousemotion              = C.SDL_MOUSEMOTION // 0x400, Mouse moved
-	mousebuttondown          = C.SDL_MOUSEBUTTONDOWN // Mouse button pressed
-	mousebuttonup            = C.SDL_MOUSEBUTTONUP // Mouse button released
-	mousewheel               = C.SDL_MOUSEWHEEL // Mouse wheel motion
+	mousemotion                                = C.SDL_MOUSEMOTION // 0x400, Mouse moved
+	mousebuttondown                            = C.SDL_MOUSEBUTTONDOWN // Mouse button pressed
+	mousebuttonup                              = C.SDL_MOUSEBUTTONUP // Mouse button released
+	mousewheel                                 = C.SDL_MOUSEWHEEL // Mouse wheel motion
 	// Joystick events
-	joyaxismotion            = C.SDL_JOYAXISMOTION // 0x600, Joystick axis motion
-	joyballmotion            = C.SDL_JOYBALLMOTION // Joystick trackball motion
-	joyhatmotion             = C.SDL_JOYHATMOTION // Joystick hat position change
-	joybuttondown            = C.SDL_JOYBUTTONDOWN // Joystick button pressed
-	joybuttonup              = C.SDL_JOYBUTTONUP // Joystick button released
-	joydeviceadded           = C.SDL_JOYDEVICEADDED // A new joystick has been inserted into the system
-	joydeviceremoved         = C.SDL_JOYDEVICEREMOVED // An opened joystick has been removed
-	joybatteryupdated        = C.SDL_JOYBATTERYUPDATED // Joystick battery level change
+	joyaxismotion                              = C.SDL_JOYAXISMOTION // 0x600, Joystick axis motion
+	joyballmotion                              = C.SDL_JOYBALLMOTION // Joystick trackball motion
+	joyhatmotion                               = C.SDL_JOYHATMOTION // Joystick hat position change
+	joybuttondown                              = C.SDL_JOYBUTTONDOWN // Joystick button pressed
+	joybuttonup                                = C.SDL_JOYBUTTONUP // Joystick button released
+	joydeviceadded                             = C.SDL_JOYDEVICEADDED // A new joystick has been inserted into the system
+	joydeviceremoved                           = C.SDL_JOYDEVICEREMOVED // An opened joystick has been removed
+	joybatteryupdated                          = C.SDL_JOYBATTERYUPDATED // Joystick battery level change
 	// Game controller events
-	controlleraxismotion     = C.SDL_CONTROLLERAXISMOTION // 0x650, Game controller axis motion
-	controllerbuttondown     = C.SDL_CONTROLLERBUTTONDOWN // Game controller button pressed
-	controllerbuttonup       = C.SDL_CONTROLLERBUTTONUP // Game controller button released
-	controllerdeviceadded    = C.SDL_CONTROLLERDEVICEADDED // A new Game controller has been inserted into the system
-	controllerdeviceremoved  = C.SDL_CONTROLLERDEVICEREMOVED // An opened Game controller has been removed
-	controllerdeviceremapped = C.SDL_CONTROLLERDEVICEREMAPPED // The controller mapping was updated
-	controllertouchpaddown   = C.SDL_CONTROLLERTOUCHPADDOWN // Game controller touchpad was touched
-	controllertouchpadmotion = C.SDL_CONTROLLERTOUCHPADMOTION // Game controller touchpad finger was moved
-	controllertouchpadup     = C.SDL_CONTROLLERTOUCHPADUP // Game controller touchpad finger was lifted
-	controllersensorupdate   = C.SDL_CONTROLLERSENSORUPDATE // Game controller sensor was updated
+	controlleraxismotion                       = C.SDL_CONTROLLERAXISMOTION // 0x650, Game controller axis motion
+	controllerbuttondown                       = C.SDL_CONTROLLERBUTTONDOWN // Game controller button pressed
+	controllerbuttonup                         = C.SDL_CONTROLLERBUTTONUP // Game controller button released
+	controllerdeviceadded                      = C.SDL_CONTROLLERDEVICEADDED // A new Game controller has been inserted into the system
+	controllerdeviceremoved                    = C.SDL_CONTROLLERDEVICEREMOVED // An opened Game controller has been removed
+	controllerdeviceremapped                   = C.SDL_CONTROLLERDEVICEREMAPPED // The controller mapping was updated
+	controllertouchpaddown                     = C.SDL_CONTROLLERTOUCHPADDOWN // Game controller touchpad was touched
+	controllertouchpadmotion                   = C.SDL_CONTROLLERTOUCHPADMOTION // Game controller touchpad finger was moved
+	controllertouchpadup                       = C.SDL_CONTROLLERTOUCHPADUP // Game controller touchpad finger was lifted
+	controllersensorupdate                     = C.SDL_CONTROLLERSENSORUPDATE // Game controller sensor was updated
+	controllerupdatecomplete_reserved_for_sdl3 = C.SDL_CONTROLLERUPDATECOMPLETE_RESERVED_FOR_SDL3
+	controllersteamhandleupdated               = C.SDL_CONTROLLERSTEAMHANDLEUPDATED // Game controller Steam handle has changed
 	// Touch events
-	fingerdown               = C.SDL_FINGERDOWN // 0x700
-	fingerup                 = C.SDL_FINGERUP
-	fingermotion             = C.SDL_FINGERMOTION
+	fingerdown                                 = C.SDL_FINGERDOWN // 0x700
+	fingerup                                   = C.SDL_FINGERUP
+	fingermotion                               = C.SDL_FINGERMOTION
 	// Gesture events
-	dollargesture            = C.SDL_DOLLARGESTURE // 0x800
-	dollarrecord             = C.SDL_DOLLARRECORD
-	multigesture             = C.SDL_MULTIGESTURE
+	dollargesture                              = C.SDL_DOLLARGESTURE // 0x800
+	dollarrecord                               = C.SDL_DOLLARRECORD
+	multigesture                               = C.SDL_MULTIGESTURE
 	// Clipboard events
-	clipboardupdate          = C.SDL_CLIPBOARDUPDATE // 0x900 The clipboard or primary selection changed
+	clipboardupdate                            = C.SDL_CLIPBOARDUPDATE // 0x900 The clipboard or primary selection changed
 	// Drag and drop events
-	dropfile                 = C.SDL_DROPFILE // 0x1000 The system requests a file open
-	droptext                 = C.SDL_DROPTEXT // text/plain drag-and-drop event
-	dropbegin                = C.SDL_DROPBEGIN // A new set of drops is beginning (NULL filename)
-	dropcomplete             = C.SDL_DROPCOMPLETE // Current set of drops is now complete (NULL filename)
+	dropfile                                   = C.SDL_DROPFILE // 0x1000 The system requests a file open
+	droptext                                   = C.SDL_DROPTEXT // text/plain drag-and-drop event
+	dropbegin                                  = C.SDL_DROPBEGIN // A new set of drops is beginning (NULL filename)
+	dropcomplete                               = C.SDL_DROPCOMPLETE // Current set of drops is now complete (NULL filename)
 	// Audio hotplug events
-	audiodeviceadded         = C.SDL_AUDIODEVICEADDED // 0x1100 A new audio device is available
-	audiodeviceremoved       = C.SDL_AUDIODEVICEREMOVED // An audio device has been removed.
+	audiodeviceadded                           = C.SDL_AUDIODEVICEADDED // 0x1100 A new audio device is available
+	audiodeviceremoved                         = C.SDL_AUDIODEVICEREMOVED // An audio device has been removed.
 	// Sensor events
-	sensorupdate             = C.SDL_SENSORUPDATE // 0x1200 A sensor was updated
+	sensorupdate                               = C.SDL_SENSORUPDATE // 0x1200 A sensor was updated
 	// Render events
-	render_targets_reset     = C.SDL_RENDER_TARGETS_RESET // 0x2000 The render targets have been reset and their contents need to be updated
-	render_device_reset      = C.SDL_RENDER_DEVICE_RESET // The device has been reset and all textures need to be recreated
+	render_targets_reset                       = C.SDL_RENDER_TARGETS_RESET // 0x2000 The render targets have been reset and their contents need to be updated
+	render_device_reset                        = C.SDL_RENDER_DEVICE_RESET // The device has been reset and all textures need to be recreated
 	// Internal events
-	pollsentinel             = C.SDL_POLLSENTINEL // 0x7F00, Signals the end of an event poll cycle
+	pollsentinel                               = C.SDL_POLLSENTINEL // 0x7F00, Signals the end of an event poll cycle
 	// Events ::SDL_USEREVENT through ::SDL_LASTEVENT are for your use, and should be allocated with SDL_RegisterEvents()
-	userevent                = C.SDL_USEREVENT
+	userevent                                  = C.SDL_USEREVENT
 	// This last event is only for bounding internal arrays
-	lastevent                = C.SDL_LASTEVENT // 0xFFFF
+	lastevent                                  = C.SDL_LASTEVENT // 0xFFFF
 }
 
 // CommonEvent is fields shared by every event
@@ -416,7 +418,7 @@ pub type ControllerButtonEvent = C.SDL_ControllerButtonEvent
 @[typedef]
 pub struct C.SDL_ControllerDeviceEvent {
 pub:
-	@type     EventType // ::SDL_CONTROLLERDEVICEADDED, ::SDL_CONTROLLERDEVICEREMOVED, or ::SDL_CONTROLLERDEVICEREMAPPED
+	@type     EventType // ::SDL_CONTROLLERDEVICEADDED, ::SDL_CONTROLLERDEVICEREMOVED, ::SDL_CONTROLLERDEVICEREMAPPED, or ::SDL_CONTROLLERSTEAMHANDLEUPDATED
 	timestamp u32       // In milliseconds, populated using SDL_GetTicks()
 	which     int       // The joystick device index for the ADDED event, instance id for the REMOVED or REMAPPED event
 }
@@ -557,16 +559,6 @@ pub:
 
 pub type QuitEvent = C.SDL_QuitEvent
 
-// OSEvent is an OS Specific event
-@[typedef]
-pub struct C.SDL_OSEvent {
-pub:
-	@type     EventType // ::SDL_QUIT
-	timestamp u32       // In milliseconds, populated using SDL_GetTicks()
-}
-
-pub type OSEvent = C.SDL_OSEvent
-
 // UserEvent is an user-defined event type (event.user.*)
 @[typedef]
 pub struct C.SDL_UserEvent {

filesystem.c.v

@@ -35,7 +35,7 @@ fn C.SDL_GetBasePath() &char
 // directory of the application as it is uncommon to store resources outside
 // the executable. As such it is not a writable directory.
 //
-// The returned path is guaranteed to end with a path separator ('\' on
+// The returned path is guaranteed to end with a path separator ('\\' on
 // Windows, '/' on most other platforms).
 //
 // The pointer returned is owned by the caller. Please call SDL_free() on the
@@ -93,7 +93,7 @@ fn C.SDL_GetPrefPath(const_org &char, const_app &char) &char
 // - ...only use letters, numbers, and spaces. Avoid punctuation like "Game
 //   Name 2: Bad Guy's Revenge!" ... "Game Name 2" is sufficient.
 //
-// The returned path is guaranteed to end with a path separator ('\' on
+// The returned path is guaranteed to end with a path separator ('\\' on
 // Windows, '/' on most other platforms).
 //
 // The pointer returned is owned by the caller. Please call SDL_free() on the

gamecontroller.c.v

@@ -39,6 +39,7 @@ pub enum GameControllerType {
 	nintendo_switch_joycon_left  = C.SDL_CONTROLLER_TYPE_NINTENDO_SWITCH_JOYCON_LEFT
 	nintendo_switch_joycon_right = C.SDL_CONTROLLER_TYPE_NINTENDO_SWITCH_JOYCON_RIGHT
 	nintendo_switch_joycon_pair  = C.SDL_CONTROLLER_TYPE_NINTENDO_SWITCH_JOYCON_PAIR
+	max                          = C.SDL_CONTROLLER_TYPE_MAX
 }
 
 // GameControllerBindType is C.SDL_GameControllerBindType
@@ -544,6 +545,21 @@ pub fn game_controller_get_serial(gamecontroller &GameController) &char {
 	return C.SDL_GameControllerGetSerial(gamecontroller)
 }
 
+fn C.SDL_GameControllerGetSteamHandle(gamecontroller &GameController) u64
+
+// Get the Steam Input handle of an opened controller, if available.
+//
+// Returns an InputHandle_t for the controller that can be used with Steam Input API:
+// https://partner.steamgames.com/doc/api/ISteamInput
+//
+// `gamecontroller` the game controller object to query.
+// returns the gamepad handle, or 0 if unavailable.
+//
+// NOTE This function is available since SDL 2.30.0.
+pub fn game_controller_get_steam_handle(gamecontroller &GameController) u64 {
+	return C.SDL_GameControllerGetSteamHandle(gamecontroller)
+}
+
 fn C.SDL_GameControllerGetAttached(gamecontroller &C.SDL_GameController) bool
 
 // game_controller_get_attached checks if a controller has been opened and is currently connected.
@@ -625,7 +641,9 @@ pub fn game_controller_update() {
 // and are centered within ~8000 of zero, though advanced UI will allow users to set
 // or autodetect the dead zone, which varies between controllers.
 //
-// Trigger axis values range from 0 to SDL_JOYSTICK_AXIS_MAX.
+// Trigger axis values range from 0 (released) to SDL_JOYSTICK_AXIS_MAX
+// (fully pressed) when reported by SDL_GameControllerGetAxis(). Note that this is not the
+// same range that will be reported by the lower-level SDL_GetJoystickAxis().
 //
 // GameControllerAxis is C.SDL_GameControllerAxis
 pub enum GameControllerAxis {
@@ -720,8 +738,13 @@ fn C.SDL_GameControllerGetAxis(gamecontroller &C.SDL_GameController, axis C.SDL_
 //
 // The axis indices start at index 0.
 //
-// The state is a value ranging from -32768 to 32767. Triggers, however, range
-// from 0 to 32767 (they never return a negative value).
+// For thumbsticks, the state is a value ranging from -32768 (up/left)
+// to 32767 (down/right).
+//
+// Triggers range from 0 when released to 32767 when fully pressed, and
+// never return a negative value. Note that this differs from the value
+// reported by the lower-level SDL_GetJoystickAxis(), which normally uses
+// the full range.
 //
 // `gamecontroller` a game controller
 // `axis` an axis index (one of the SDL_GameControllerAxis values)