Prefer positional mapping for controllers with a diamond button confi…

…guration
libsdl-org · Jul 27, 2023 · 76b6e91 · 76b6e91
1 parent 4cffbc3
commit 76b6e91
Show file tree

Hide file tree

Showing 6 changed files with 238 additions and 234 deletions.
diff --git a/docs/README-migration.md b/docs/README-migration.md
@@ -252,6 +252,8 @@ The functions SDL_GetGamepads(), SDL_GetGamepadInstanceName(), SDL_GetGamepadIns
 
 The gamepad binding structure has been removed in favor of exchanging bindings in text format.
 
+Controllers with a diamond button configuration by default will their buttons mapped according to position, instead of by label (affects for instance Nintendo controllers). As before, this can be adjusted using the SDL_GAMECONTROLLER_USE_BUTTON_LABELS hint.
+
 SDL_GameControllerGetSensorDataWithTimestamp() has been removed. If you want timestamps for the sensor data, you should use the sensor_timestamp member of SDL_EVENT_GAMEPAD_SENSOR_UPDATE events.
 
 SDL_CONTROLLER_TYPE_VIRTUAL has been removed, so virtual controllers can emulate other gamepad types. If you need to know whether a controller is virtual, you can use SDL_IsJoystickVirtual().

diff --git a/include/SDL3/SDL_hints.h b/include/SDL3/SDL_hints.h
@@ -558,7 +558,7 @@ extern "C" {
  *    "0"       - Report the face buttons by position, as though they were on an Xbox controller.
  *    "1"       - Report the face buttons by label instead of position
  *
- *  The default value is "1".  This hint may be set at any time.
+ *  By default this is disabled for controllers that have a diamond button configuration, and enabled for the controllers that don't.  This hint may be set at any time.
  */
 #define SDL_HINT_GAMECONTROLLER_USE_BUTTON_LABELS "SDL_GAMECONTROLLER_USE_BUTTON_LABELS"