SDLJoystick.h

Go to the documentation of this file.

#pragma once
 
#include <QtCore/QString>
#include <QtCore/QVariantMap>
 
#include <functional>
 
// Forward-declare SDL types so consumers don't pull <SDL3/SDL.h> through
// this header. Both are typedef'd from struct tags of the same name.
struct SDL_Gamepad;
struct SDL_GamepadBinding;
 
namespace SDLJoystick {
 
// ============================================================================
// Initialization
// ============================================================================
 
bool init();
 
void shutdown();
 
bool isInitialized();
 
// ============================================================================
// Event Control
// ============================================================================
 
void pumpEvents();
 
void setJoystickEventsEnabled(bool enabled);
bool joystickEventsEnabled();
 
void setGamepadEventsEnabled(bool enabled);
bool gamepadEventsEnabled();
 
void updateJoysticks();
void updateGamepads();
 
// ============================================================================
// Thread Safety
// ============================================================================
 
void lockJoysticks();
void unlockJoysticks();
 
class JoystickLock {
public:
    JoystickLock() { lockJoysticks(); }
    ~JoystickLock() { unlockJoysticks(); }
    JoystickLock(const JoystickLock&) = delete;
    JoystickLock& operator=(const JoystickLock&) = delete;
};
 
// ============================================================================
// Type/String Conversions
// ============================================================================
 
QString gamepadTypeToString(int type);
int gamepadTypeFromString(const QString &str);
QString gamepadTypeDisplayName(int type);
 
QString gamepadAxisToString(int axis);
int gamepadAxisFromString(const QString &str);
 
QString gamepadButtonToString(int button);
int gamepadButtonFromString(const QString &str);
 
QString connectionStateToString(int state);
 
// ============================================================================
// GUID Utilities
// ============================================================================
 
QVariantMap getGUIDInfo(const QString &guid);
 
QString getMappingForGUID(const QString &guid);
 
// ============================================================================
// Mapping Management
// ============================================================================
 
int addMappingsFromFile(const QString &filePath);
 
bool addMapping(const QString &mapping);
 
bool addMappingPersistent(const QString &mapping);
 
bool reloadMappings();
 
QString userMappingsFilePath();
 
// ============================================================================
// Player Index
// ============================================================================
 
int getInstanceIdFromPlayerIndex(int playerIndex);
 
// ============================================================================
// Pre-Open Device Queries (query device info without opening)
// ============================================================================
 
QString getNameForInstanceId(int instanceId);
 
QString getPathForInstanceId(int instanceId);
 
QString getGUIDForInstanceId(int instanceId);
 
int getVendorForInstanceId(int instanceId);
 
int getProductForInstanceId(int instanceId);
 
int getProductVersionForInstanceId(int instanceId);
 
QString getTypeForInstanceId(int instanceId);
 
QString getRealTypeForInstanceId(int instanceId);
 
int getPlayerIndexForInstanceId(int instanceId);
 
QString getConnectionStateForInstanceId(int instanceId);
 
// ============================================================================
// Virtual Joystick
// ============================================================================
 
int createVirtualJoystick(const QString &name, int axisCount, int buttonCount, int hatCount);
 
bool destroyVirtualJoystick(int instanceId);
 
bool isVirtualJoystick(int instanceId);
 
// ============================================================================
// Gamepad Binding Utilities
// ============================================================================
 
void populateBindingResult(QVariantMap &result, const SDL_GamepadBinding *binding);
 
QVariantMap findBinding(SDL_Gamepad *gamepad,
                        const std::function<bool(const SDL_GamepadBinding *)> &matchFunc);
 
} // namespace SDLJoystick