UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::WindowsApplication::TouchpadSensitivity Namespace Reference

Classes

struct  tagTOUCHPAD_PARAMETERS_V0
 

Typedefs

typedef BOOL(* SetMaxTouchpadSensitivityProc) (_In_ BOOL enable)
 
typedef enum UE::WindowsApplication::TouchpadSensitivity::LEGACY_TOUCHPAD_FEATURES LEGACY_TOUCHPAD_FEATURES
 
typedef enum UE::WindowsApplication::TouchpadSensitivity::TOUCHPAD_SENSITIVITY_LEVEL TOUCHPAD_SENSITIVITY_LEVEL
 
typedef struct UE::WindowsApplication::TouchpadSensitivity::tagTOUCHPAD_PARAMETERS_V0 TOUCHPAD_PARAMETERS_V0
 
typedef struct UE::WindowsApplication::TouchpadSensitivity::tagTOUCHPAD_PARAMETERS_V0PTOUCHPAD_PARAMETERS_V0
 

Enumerations

enum class  EForceMaxTouchpadSensitivityMode { NotCached , DoNothing , SetTouchpadParameters , SetMaxTouchpadSensitivity }
 
enum  LEGACY_TOUCHPAD_FEATURES { LEGACY_TOUCHPAD_FEATURE_NONE = 0x00000000 , LEGACY_TOUCHPAD_FEATURE_ENABLE_DISABLE = 0x00000001 , LEGACY_TOUCHPAD_FEATURE_REVERSE_SCROLL_DIRECTION = 0x00000004 }
 
enum  TOUCHPAD_SENSITIVITY_LEVEL {
  TOUCHPAD_SENSITIVITY_LEVEL_MOST_SENSITIVE = 0x00000000 , TOUCHPAD_SENSITIVITY_LEVEL_HIGH_SENSITIVITY = 0x00000001 , TOUCHPAD_SENSITIVITY_LEVEL_MEDIUM_SENSITIVITY = 0x00000002 , TOUCHPAD_SENSITIVITY_LEVEL_LOW_SENSITIVITY = 0x00000003 ,
  TOUCHPAD_SENSITIVITY_LEVEL_LEAST_SENSITIVE = 0x00000004 , TOUCHPAD_SENSITIVITY_LEVEL_NOT_SET = 0x0000000F
}
 

Functions

 DECLARE_LOG_CATEGORY_EXTERN (LogWindowsTouchpad, Display, VeryVerbose)
 
 DEFINE_LOG_CATEGORY (LogWindowsTouchpad)
 
bool SetMaxTouchpadSensitivity (bool Enable)
 
bool TryCacheSetMaxTouchpadSensitivityProc ()
 
void CacheForceMaxTouchpadSensitivityMode ()
 
EForceMaxTouchpadSensitivityMode GetForceMaxTouchpadSensitivityMode ()
 
bool SupportsForceMaxTouchpadSensitivity ()
 
void GetRegistryStoreIdAndSection (FString &OutStoreId, FString &OutSectionName)
 
void WriteSavedSensitivityToRegistry (TOUCHPAD_SENSITIVITY_LEVEL SavedSensitivity)
 
void ReadSavedSensitivityFromRegistry (TOUCHPAD_SENSITIVITY_LEVEL &OutSavedSensitivity, bool &OutbSuccess)
 
void ClearSavedSensitivityFromRegistry ()
 
FWindowsApplication::EForceMaxTouchpadSensitivityRestorationValues GetForceMaxTouchpadSensitivityRestorationValue ()
 
void OnWMSettingChangeSetTouchpadParameters ()
 
void ApplyForceMaxTouchpadSensitivity ()
 
void RemoveForceMaxTouchpadSensitivity ()
 
void RemoveForceMaxTouchpadSensitivityOnErrorShutdown ()
 
void HandleStartupApp ()
 
void HandleActivateApp (bool bActivate)
 
void HandleDestroyApplication ()
 
void HandleShutDownAfterError ()
 

Variables

FAutoConsoleVariableRef CVarForceMaxTouchpadSensitivity (TEXT("WindowsApplication.ForceMaxTouchpadSensitivity"), bForceMaxTouchpadSensitivity, TEXT("Force Touchpad sensitivity to maximum in game when the app is active (aka has focus)." " The sensitivity setting can reject touchpad touches while typing on the theory that they are accidental, but that is not a good assumption for games." " The setting defaults to 'Medium'. The 'Most sensitive' setting does not reject any touches, so that is what we want.." " On Windows10 22H2 we force the global system setting to 'Most Sensitive', but do not write that to the registry persistently." " We will set it back when the app loses focus and on exit, but it may not happen in the case of a crash leaving the setting altered until a reboot." " On Window11 24H2 (excepting very early installs of 24H2) a new api SetMaxTouchpadSensitivity exists and we use that." " SetMaxTouchpadSensitivity changes the setting only for this app, so we do not need to handle clean-up." " When the cvar is changed a CVarSinkHandler will attempt to apply or remove max sensitivity."))
 
FAutoConsoleVariableRef CVarDisableForceMaxTouchpadSensitivity_SetTouchpadParameters (TEXT("WindowsApplication.DisableForceMaxTouchpadSensitivity_SetTouchpadParameters"), bDisableForceMaxTouchpadSensitivity_SetTouchpadParameters,)
 
FAutoConsoleVariableRef CVarDisableForceMaxTouchpadSensitivity_SetMaxTouchpadSensitivity (TEXT("WindowsApplication.DisableForceMaxTouchpadSensitivity_SetMaxTouchpadSensitivity"), bDisableForceMaxTouchpadSensitivity_SetMaxTouchpadSensitivity,)
 
FAutoConsoleVariableRef CVarWriteSavedTouchpadSensitivityToRegistry (TEXT("WindowsApplication.WriteSavedTouchpadSensitivityToRegistry"), bWriteSavedTouchpadSensitivityToRegistry,)
 
FAutoConsoleVariableRef CVarRestoreTouchpadSensitivityFromRegistry (TEXT("WindowsApplication.RestoreTouchpadSensitivityFromRegistry"), bRestoreTouchpadSensitivityFromRegistry,)
 
const UINT SPI_GETTOUCHPADPARAMETERS = 0x00AE
 
const UINT SPI_SETTOUCHPADPARAMETERS = 0x00AF
 

Typedef Documentation

◆ LEGACY_TOUCHPAD_FEATURES

◆ PTOUCHPAD_PARAMETERS_V0

◆ SetMaxTouchpadSensitivityProc

typedef BOOL(* UE::WindowsApplication::TouchpadSensitivity::SetMaxTouchpadSensitivityProc) (_In_ BOOL enable)

◆ TOUCHPAD_PARAMETERS_V0

◆ TOUCHPAD_SENSITIVITY_LEVEL

Enumeration Type Documentation

◆ EForceMaxTouchpadSensitivityMode

Enumerator
NotCached 
DoNothing 
SetTouchpadParameters 
SetMaxTouchpadSensitivity 

◆ LEGACY_TOUCHPAD_FEATURES

Enumerator
LEGACY_TOUCHPAD_FEATURE_NONE 
LEGACY_TOUCHPAD_FEATURE_ENABLE_DISABLE 
LEGACY_TOUCHPAD_FEATURE_REVERSE_SCROLL_DIRECTION 

◆ TOUCHPAD_SENSITIVITY_LEVEL

Enumerator
TOUCHPAD_SENSITIVITY_LEVEL_MOST_SENSITIVE 
TOUCHPAD_SENSITIVITY_LEVEL_HIGH_SENSITIVITY 
TOUCHPAD_SENSITIVITY_LEVEL_MEDIUM_SENSITIVITY 
TOUCHPAD_SENSITIVITY_LEVEL_LOW_SENSITIVITY 
TOUCHPAD_SENSITIVITY_LEVEL_LEAST_SENSITIVE 
TOUCHPAD_SENSITIVITY_LEVEL_NOT_SET 

Function Documentation

◆ ApplyForceMaxTouchpadSensitivity()

void UE::WindowsApplication::TouchpadSensitivity::ApplyForceMaxTouchpadSensitivity ( )

◆ CacheForceMaxTouchpadSensitivityMode()

void UE::WindowsApplication::TouchpadSensitivity::CacheForceMaxTouchpadSensitivityMode ( )

◆ ClearSavedSensitivityFromRegistry()

void UE::WindowsApplication::TouchpadSensitivity::ClearSavedSensitivityFromRegistry ( )

◆ DECLARE_LOG_CATEGORY_EXTERN()

UE::WindowsApplication::TouchpadSensitivity::DECLARE_LOG_CATEGORY_EXTERN ( LogWindowsTouchpad  ,
Display  ,
VeryVerbose   
)

◆ DEFINE_LOG_CATEGORY()

UE::WindowsApplication::TouchpadSensitivity::DEFINE_LOG_CATEGORY ( LogWindowsTouchpad  )

◆ GetForceMaxTouchpadSensitivityMode()

EForceMaxTouchpadSensitivityMode UE::WindowsApplication::TouchpadSensitivity::GetForceMaxTouchpadSensitivityMode ( )

◆ GetForceMaxTouchpadSensitivityRestorationValue()

FWindowsApplication::EForceMaxTouchpadSensitivityRestorationValues UE::WindowsApplication::TouchpadSensitivity::GetForceMaxTouchpadSensitivityRestorationValue ( )

◆ GetRegistryStoreIdAndSection()

void UE::WindowsApplication::TouchpadSensitivity::GetRegistryStoreIdAndSection ( FString &  OutStoreId,
FString &  OutSectionName 
)

◆ HandleActivateApp()

void UE::WindowsApplication::TouchpadSensitivity::HandleActivateApp ( bool  bActivate)

◆ HandleDestroyApplication()

void UE::WindowsApplication::TouchpadSensitivity::HandleDestroyApplication ( )

◆ HandleShutDownAfterError()

void UE::WindowsApplication::TouchpadSensitivity::HandleShutDownAfterError ( )

◆ HandleStartupApp()

void UE::WindowsApplication::TouchpadSensitivity::HandleStartupApp ( )

◆ OnWMSettingChangeSetTouchpadParameters()

void UE::WindowsApplication::TouchpadSensitivity::OnWMSettingChangeSetTouchpadParameters ( )

◆ ReadSavedSensitivityFromRegistry()

void UE::WindowsApplication::TouchpadSensitivity::ReadSavedSensitivityFromRegistry ( TOUCHPAD_SENSITIVITY_LEVEL OutSavedSensitivity,
bool OutbSuccess 
)

◆ RemoveForceMaxTouchpadSensitivity()

void UE::WindowsApplication::TouchpadSensitivity::RemoveForceMaxTouchpadSensitivity ( )

◆ RemoveForceMaxTouchpadSensitivityOnErrorShutdown()

void UE::WindowsApplication::TouchpadSensitivity::RemoveForceMaxTouchpadSensitivityOnErrorShutdown ( )

◆ SetMaxTouchpadSensitivity()

bool UE::WindowsApplication::TouchpadSensitivity::SetMaxTouchpadSensitivity ( bool  Enable)

◆ SupportsForceMaxTouchpadSensitivity()

bool UE::WindowsApplication::TouchpadSensitivity::SupportsForceMaxTouchpadSensitivity ( )

◆ TryCacheSetMaxTouchpadSensitivityProc()

bool UE::WindowsApplication::TouchpadSensitivity::TryCacheSetMaxTouchpadSensitivityProc ( )

◆ WriteSavedSensitivityToRegistry()

void UE::WindowsApplication::TouchpadSensitivity::WriteSavedSensitivityToRegistry ( TOUCHPAD_SENSITIVITY_LEVEL  SavedSensitivity)

Variable Documentation

◆ CVarDisableForceMaxTouchpadSensitivity_SetMaxTouchpadSensitivity

FAutoConsoleVariableRef UE::WindowsApplication::TouchpadSensitivity::CVarDisableForceMaxTouchpadSensitivity_SetMaxTouchpadSensitivity(TEXT("WindowsApplication.DisableForceMaxTouchpadSensitivity_SetMaxTouchpadSensitivity"), bDisableForceMaxTouchpadSensitivity_SetMaxTouchpadSensitivity,) ( TEXT("WindowsApplication.DisableForceMaxTouchpadSensitivity_SetMaxTouchpadSensitivity")  ,
bDisableForceMaxTouchpadSensitivity_SetMaxTouchpadSensitivity   
)

◆ CVarDisableForceMaxTouchpadSensitivity_SetTouchpadParameters

FAutoConsoleVariableRef UE::WindowsApplication::TouchpadSensitivity::CVarDisableForceMaxTouchpadSensitivity_SetTouchpadParameters(TEXT("WindowsApplication.DisableForceMaxTouchpadSensitivity_SetTouchpadParameters"), bDisableForceMaxTouchpadSensitivity_SetTouchpadParameters,) ( TEXT("WindowsApplication.DisableForceMaxTouchpadSensitivity_SetTouchpadParameters")  ,
bDisableForceMaxTouchpadSensitivity_SetTouchpadParameters   
)

◆ CVarForceMaxTouchpadSensitivity

FAutoConsoleVariableRef UE::WindowsApplication::TouchpadSensitivity::CVarForceMaxTouchpadSensitivity(TEXT("WindowsApplication.ForceMaxTouchpadSensitivity"), bForceMaxTouchpadSensitivity, TEXT("Force Touchpad sensitivity to maximum in game when the app is active (aka has focus)." " The sensitivity setting can reject touchpad touches while typing on the theory that they are accidental, but that is not a good assumption for games." " The setting defaults to 'Medium'. The 'Most sensitive' setting does not reject any touches, so that is what we want.." " On Windows10 22H2 we force the global system setting to 'Most Sensitive', but do not write that to the registry persistently." " We will set it back when the app loses focus and on exit, but it may not happen in the case of a crash leaving the setting altered until a reboot." " On Window11 24H2 (excepting very early installs of 24H2) a new api SetMaxTouchpadSensitivity exists and we use that." " SetMaxTouchpadSensitivity changes the setting only for this app, so we do not need to handle clean-up." " When the cvar is changed a CVarSinkHandler will attempt to apply or remove max sensitivity.")) ( TEXT("WindowsApplication.ForceMaxTouchpadSensitivity")  ,
bForceMaxTouchpadSensitivity  ,
TEXT("Force Touchpad sensitivity to maximum in game when the app is active (aka has focus)." " The sensitivity setting can reject touchpad touches while typing on the theory that they are accidental, but that is not a good assumption for games." " The setting defaults to 'Medium'. The 'Most sensitive' setting does not reject any touches, so that is what we want.." " On Windows10 22H2 we force the global system setting to 'Most Sensitive', but do not write that to the registry persistently." " We will set it back when the app loses focus and on exit, but it may not happen in the case of a crash leaving the setting altered until a reboot." " On Window11 24H2 (excepting very early installs of 24H2) a new api SetMaxTouchpadSensitivity exists and we use that." " SetMaxTouchpadSensitivity changes the setting only for this app, so we do not need to handle clean-up." " When the cvar is changed a CVarSinkHandler will attempt to apply or remove max sensitivity.")   
)

◆ CVarRestoreTouchpadSensitivityFromRegistry

FAutoConsoleVariableRef UE::WindowsApplication::TouchpadSensitivity::CVarRestoreTouchpadSensitivityFromRegistry(TEXT("WindowsApplication.RestoreTouchpadSensitivityFromRegistry"), bRestoreTouchpadSensitivityFromRegistry,) ( TEXT("WindowsApplication.RestoreTouchpadSensitivityFromRegistry")  ,
bRestoreTouchpadSensitivityFromRegistry   
)

◆ CVarWriteSavedTouchpadSensitivityToRegistry

FAutoConsoleVariableRef UE::WindowsApplication::TouchpadSensitivity::CVarWriteSavedTouchpadSensitivityToRegistry(TEXT("WindowsApplication.WriteSavedTouchpadSensitivityToRegistry"), bWriteSavedTouchpadSensitivityToRegistry,) ( TEXT("WindowsApplication.WriteSavedTouchpadSensitivityToRegistry")  ,
bWriteSavedTouchpadSensitivityToRegistry   
)

◆ SPI_GETTOUCHPADPARAMETERS

const UINT UE::WindowsApplication::TouchpadSensitivity::SPI_GETTOUCHPADPARAMETERS = 0x00AE

◆ SPI_SETTOUCHPADPARAMETERS

const UINT UE::WindowsApplication::TouchpadSensitivity::SPI_SETTOUCHPADPARAMETERS = 0x00AF