Skip to content

Migrate in_ cvars #1839

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
slipher merged 4 commits into from
Oct 4, 2025
Merged

Migrate in_ cvars #1839

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7e2838f
Call IN_ShutdownJoystick in non-pedantic shutdown
slipher Oct 3, 2025
d48b9f3
Add game controller logger (logs.level.client.controller)
slipher Oct 3, 2025
0509d0e
Migrate cvar in_joystickNo to new style
slipher Oct 3, 2025
a10c8d8
Migrate in_* cvars to new style
slipher Oct 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/engine/client/cl_main.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2444,6 +2444,10 @@ void CL_Shutdown()
CL_SendDisconnect();
CL_StopRecord();
StopVideo();

// Just to avoid the SDL nag message "Leaked SDL_Gamepad (0x123456)" making us look bad
IN_ShutdownJoystick();

// TODO: call DL_StopDownload when deleting the temp file is implemented
return;
}
Expand Down
4 changes: 4 additions & 0 deletions src/engine/null/null_input.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,10 @@ void IN_Shutdown()
{
}

void IN_ShutdownJoystick()
{
}

void IN_CenterMouse()
{
}
Expand Down
1 change: 1 addition & 0 deletions src/engine/qcommon/qcommon.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -452,6 +452,7 @@ void IN_Frame();
void IN_FrameEnd();
void IN_Restart();
void IN_Shutdown();
void IN_ShutdownJoystick();
bool IN_IsNumLockOn();
void IN_DropInputsForFrame();
void IN_CenterMouse();
Expand Down
136 changes: 56 additions & 80 deletions src/engine/sys/sdl_input.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,24 +41,24 @@ Maryland 20850 USA.
#include "qcommon/qcommon.h"
#include "qcommon/sys.h"
#include "framework/CommandSystem.h"
#include "framework/CvarSystem.h"
#include "sys/sys_events.h"

static Log::Logger mouseLog("client.mouse", "");
static Log::Logger controllerLog = Log::Logger("client.controller", "", Log::Level::NOTICE);

static cvar_t *in_keyboardDebug = nullptr;
static Cvar::Cvar<bool> in_keyboardDebug("in_keyboardDebug", "log debug info about key presses", Cvar::NONE, false);

static SDL_Joystick *stick = nullptr;
static SDL_Gamepad *gamepad = nullptr;

static cvar_t *in_nograb;
static Cvar::Cvar<bool> in_nograb("in_nograb", "disable mouse grabbing and cursor hiding", Cvar::NONE, false);

static cvar_t *in_joystick = nullptr;
static cvar_t *in_joystickThreshold = nullptr;
static cvar_t *in_joystickNo = nullptr;
static cvar_t *in_joystickUseAnalog = nullptr;
static cvar_t *in_gameControllerTriggerDeadzone = nullptr;

static cvar_t *in_gameControllerDebug = nullptr;
static Cvar::Cvar<bool> in_joystick("in_joystick", "enable game controller", Cvar::NONE, false);
static Cvar::Cvar<float> in_joystickThreshold("in_joystickThreshold", "ignore analog stick deflections less than this", Cvar::NONE, 0.15);
static Cvar::Cvar<int> in_joystickNo("in_joystickNo", "which game controller to use", Cvar::NONE, 0);
static Cvar::Cvar<bool> in_joystickUseAnalog("in_joystickUseAnalog", "something about joystick control style", Cvar::NONE, false);
static Cvar::Cvar<float> in_gameControllerTriggerDeadzone("in_gameControllerTriggerDeadzone", "how far trigger must be pulled for key down event", Cvar::NONE, 0.5);

static SDL_Window *window = nullptr;

Expand Down Expand Up @@ -392,7 +392,7 @@ static Keyboard::Key IN_TranslateSDLToQ3Key( SDL_KeyboardEvent *event, bool down
}
}

if ( in_keyboardDebug->integer )
if ( in_keyboardDebug.Get() )
{
IN_PrintKey( event->mod, event->scancode, event->key, key, down );
}
Expand Down Expand Up @@ -434,7 +434,7 @@ static bool MouseModeAllowed( MouseMode mode )
*/
void IN_SetMouseMode(MouseMode newMode)
{
if ( in_nograb->integer && newMode == MouseMode::Deltas )
if ( in_nograb.Get() && newMode == MouseMode::Deltas )
{
newMode = MouseMode::SystemCursor;
}
Expand Down Expand Up @@ -566,6 +566,9 @@ IN_InitJoystick
*/
static void IN_InitJoystick()
{
Cvar::Latch( in_joystick );
Cvar::Latch( in_joystickNo );

if ( stick != nullptr )
{
SDL_CloseJoystick( stick );
Expand All @@ -574,62 +577,52 @@ static void IN_InitJoystick()
stick = nullptr;
stick_state = {};

if ( !in_joystick->integer )
if ( !in_joystick.Get() )
{
Log::Debug( "Joystick is not active." );

if ( !gamepad )
{
Log::Debug( "Gamepad is not active." );
}

controllerLog.Verbose( "Game controllers disabled" );
return;
}

if ( !SDL_WasInit( SDL_INIT_JOYSTICK ) )
{
Log::Debug( "Calling SDL_Init(SDL_INIT_JOYSTICK)..." );
controllerLog.Verbose( "Calling SDL_Init(SDL_INIT_JOYSTICK)..." );

if ( !SDL_Init( SDL_INIT_JOYSTICK ) )
{
Log::Warn( "SDL_Init(SDL_INIT_JOYSTICK) failed: %s", SDL_GetError() );
controllerLog.Warn( "SDL_Init(SDL_INIT_JOYSTICK) failed: %s", SDL_GetError() );
return;
}

Log::Debug( "SDL_Init(SDL_INIT_JOYSTICK) passed." );
}

int total = 0;
SDL_JoystickID* ids = SDL_GetJoysticks( &total );
Log::Debug( "%d possible joysticks", total );
controllerLog.Notice( "%d possible joystick(s):", total );

for ( int i = 0; i < total; i++ )
{
Log::Debug( "[%d] %s", i, JoystickNameForID( ids[i] ) );
controllerLog.Notice( "[%d] %s", i, JoystickNameForID( ids[i] ) );
}

in_joystickNo = Cvar_Get( "in_joystickNo", "0", 0 );
in_joystickUseAnalog = Cvar_Get( "in_joystickUseAnalog", "0", 0 );

if ( total <= 0 )
{
SDL_free( ids );
return;
}

if ( in_joystickNo->integer < 0 || in_joystickNo->integer >= total )
int stickIndex = in_joystickNo.Get();
if ( stickIndex < 0 || stickIndex >= total )
{
Cvar_Set( "in_joystickNo", "0" );
stickIndex = 0;
}

SDL_JoystickID id = ids[ in_joystickNo->integer ];
SDL_JoystickID id = ids[ stickIndex ];
SDL_free( ids );

stick = SDL_OpenJoystick( id );

if ( stick == nullptr )
{
Log::Debug( "No joystick opened: %s.", SDL_GetError() );
controllerLog.Warn( "No joystick opened: %s", SDL_GetError() );
return;
}

Expand All @@ -643,14 +636,14 @@ static void IN_InitJoystick()
}
}

Log::Debug( "Joystick %d opened", in_joystickNo->integer );
Log::Debug( "Name: %s", JoystickNameForID( id ) );
Log::Debug( "Axes: %d", SDL_GetNumJoystickAxes( stick ) );
Log::Debug( "Hats: %d", SDL_GetNumJoystickHats( stick ) );
Log::Debug( "Buttons: %d", SDL_GetNumJoystickButtons( stick ) );
Log::Debug( "Balls: %d", SDL_GetNumJoystickBalls( stick ) );
Log::Debug( "Use Analog: %s", in_joystickUseAnalog->integer ? "Yes" : "No" );
Log::Debug( "Use SDL2 GameController mappings: %s", gamepad ? "Yes" : "No" );
controllerLog.Notice( "Joystick %d opened", stickIndex );
controllerLog.Verbose( "Name: %s", JoystickNameForID( id ) );
controllerLog.Verbose( "Axes: %d", SDL_GetNumJoystickAxes( stick ) );
controllerLog.Verbose( "Hats: %d", SDL_GetNumJoystickHats( stick ) );
controllerLog.Verbose( "Buttons: %d", SDL_GetNumJoystickButtons( stick ) );
controllerLog.Verbose( "Balls: %d", SDL_GetNumJoystickBalls( stick ) );
controllerLog.Verbose( "Use Analog: %s", in_joystickUseAnalog.Get() ? "Yes" : "No" );
controllerLog.Verbose( "Use SDL GameController mappings: %s", gamepad ? "Yes" : "No" );

SDL_GamepadEventsEnabled();
}
Expand All @@ -660,7 +653,7 @@ static void IN_InitJoystick()
IN_ShutdownJoystick
===============
*/
static void IN_ShutdownJoystick()
void IN_ShutdownJoystick()
{
if ( gamepad )
{
Expand Down Expand Up @@ -902,15 +895,15 @@ static void IN_JoyMove()
{
Sint16 axis = SDL_GetJoystickAxis( stick, i );

if ( !in_joystickUseAnalog->integer )
if ( !in_joystickUseAnalog.Get() )
{
float f = ( ( float ) axis ) / 32767.0f;

if ( f < -in_joystickThreshold->value )
if ( f < -in_joystickThreshold.Get() )
{
axes |= ( 1 << ( i * 2 ) );
}
else if ( f > in_joystickThreshold->value )
else if ( f > in_joystickThreshold.Get() )
{
axes |= ( 1 << ( ( i * 2 ) + 1 ) );
}
Expand All @@ -919,7 +912,7 @@ static void IN_JoyMove()
{
float f = ( ( float ) abs( axis ) ) / 32767.0f;

if ( f < in_joystickThreshold->value ) { axis = 0; }
if ( f < in_joystickThreshold.Get() ) { axis = 0; }

if ( axis != stick_state.oldaaxes[ i ] )
{
Expand Down Expand Up @@ -957,17 +950,13 @@ static void IN_GameControllerAxis( SDL_GamepadAxis controllerAxis, joystickAxis_
Sint16 axis = SDL_GetGamepadAxis( gamepad, controllerAxis );
float f = ( ( float ) axis ) / 32767.0f;

if ( f > -in_joystickThreshold->value && f < in_joystickThreshold->value )
if ( f > -in_joystickThreshold.Get() && f < in_joystickThreshold.Get() )
{
Com_QueueEvent( Util::make_unique<Sys::JoystickEvent>(Util::ordinal(gameAxis), 0) );
}
else
{
if ( in_gameControllerDebug->integer )
{
Log::Notice( "GameController axis %i = %f", controllerAxis, f );
}

controllerLog.Debug( "GameController axis %i = %f", controllerAxis, f );
Com_QueueEvent( Util::make_unique<Sys::JoystickEvent>(Util::ordinal(gameAxis), static_cast<int>(f * scale)) );
}
}
Expand All @@ -980,31 +969,29 @@ static int IN_GameControllerAxisToButton( SDL_GamepadAxis controllerAxis, keyNum
Sint16 axis = SDL_GetGamepadAxis( gamepad, controllerAxis );
float f = ( ( float ) axis ) / 32767.0f;

if ( f > in_gameControllerTriggerDeadzone->value )
if ( f > in_gameControllerTriggerDeadzone.Get() )
{
axes |= ( 1 << ( controllerAxis ) );
}

if ( ( axes & ( 1 << controllerAxis ) ) && !( stick_state.oldaxes & ( 1 << controllerAxis ) ) )
{
QueueKeyEvent( key, true );
if ( in_gameControllerDebug->integer )
{
Log::Notice( "GameController axis = %s to key = Q:0x%02x(%s), value = %f",
SDL_GetGamepadStringForAxis( controllerAxis ), key,
Keyboard::KeyToString( Key(key) ), f );
}
controllerLog.DoDebugCode( [&] {
controllerLog.Debug( "GameController axis = %s to key = Q:0x%02x(%s), value = %f",
SDL_GetGamepadStringForAxis( controllerAxis ), key,
Keyboard::KeyToString( Key(key) ), f );
});
}

if ( !( axes & ( 1 << controllerAxis ) ) && ( stick_state.oldaxes & ( 1 << controllerAxis ) ) )
{
QueueKeyEvent( key, false );
if ( in_gameControllerDebug->integer )
{
Log::Notice( "GameController axis = %s to key = Q:0x%02x(%s), value = %f",
SDL_GetGamepadStringForAxis( controllerAxis ), key,
Keyboard::KeyToString( Key(key) ), f );
}
controllerLog.DoDebugCode( [&] {
controllerLog.Debug( "GameController axis = %s to key = Q:0x%02x(%s), value = %f",
SDL_GetGamepadStringForAxis( controllerAxis ), key,
Keyboard::KeyToString( Key(key) ), f );
});
}

return axes;
Expand Down Expand Up @@ -1036,12 +1023,11 @@ static void IN_GameControllerMove()
{
QueueKeyEvent( Util::enum_cast<keyNum_t>(K_CONTROLLER_A + i), pressed );

if ( in_gameControllerDebug->integer )
{
Log::Notice( "GameController button %s = %s",
SDL_GetGamepadStringForButton( Util::enum_cast< SDL_GamepadButton >(i) ),
pressed ? "Pressed" : "Released" );
}
controllerLog.DoDebugCode([&] {
controllerLog.Debug( "GameController button %s = %s",
SDL_GetGamepadStringForButton( Util::enum_cast< SDL_GamepadButton >(i) ),
pressed ? "Pressed" : "Released" );
});

stick_state.buttons[ i ] = pressed;
}
Expand Down Expand Up @@ -1314,16 +1300,6 @@ void IN_Init( void *windowData )

Log::Debug( "------- Input Initialization -------" );

in_keyboardDebug = Cvar_Get( "in_keyboardDebug", "0", CVAR_TEMP );

// mouse variables
in_nograb = Cvar_Get( "in_nograb", "0", 0 );

in_joystick = Cvar_Get( "in_joystick", "0", CVAR_LATCH );
in_joystickThreshold = Cvar_Get( "in_joystickThreshold", "0.15", 0 );
in_gameControllerTriggerDeadzone = Cvar_Get( "in_gameControllerTriggerDeadzone", "0.5", 0);

in_gameControllerDebug = Cvar_Get( "in_gameControllerDebug", "0", CVAR_TEMP );
SDL_StartTextInput( window );
IN_SetMouseMode( MouseMode::SystemCursor );

Expand Down