Просмотр исходного кода

gamecontroller: Added docs to SDL_GameControllerBindType, to fix wiki docs.

Ryan C. Gordon 13 часов назад
Родитель
Сommit
b8b3f5ef20
1 измененных файлов с 13 добавлено и 0 удалено
  1. 13 0
      include/SDL_gamecontroller.h

+ 13 - 0
include/SDL_gamecontroller.h

@@ -79,6 +79,19 @@ typedef enum SDL_GameControllerType
     SDL_CONTROLLER_TYPE_MAX
     SDL_CONTROLLER_TYPE_MAX
 } SDL_GameControllerType;
 } SDL_GameControllerType;
 
 
+/**
+ * Types of game controller control bindings.
+ *
+ * A game controller is a collection of bindings that map arbitrary joystick
+ * buttons, axes and hat switches to specific positions on a generic
+ * console-style gamepad.
+ *
+ * \since This enum is available since SDL 2.0.0.
+ *
+ * \sa SDL_GameControllerButtonBind
+ * \sa SDL_GameControllerGetBindForAxis
+ * \sa SDL_GameControllerGetBindForButton
+ */
 typedef enum SDL_GameControllerBindType
 typedef enum SDL_GameControllerBindType
 {
 {
     SDL_CONTROLLER_BINDTYPE_NONE = 0,
     SDL_CONTROLLER_BINDTYPE_NONE = 0,