Module hints
Available on crate feature
dep_sdl3 only.Expand description
This file contains functions to set and get configuration hints, as well as listing each of them alphabetically.
The convention for naming hints is SDL_HINT_X, where “SDL_X” is the environment variable that can be used to override the default.
In general these hints are just that - they may or may not be supported or applicable on any given platform, but they provide a way for an application or user to give the library a hint as to how they would like the library to work.
Structs§
- SDL_
Hint Priority - An enumeration of hint priorities.
Constants§
- SDL_
HINT_ ALLOW_ ALT_ TAB_ WHILE_ GRABBED - Specify the behavior of Alt+Tab while the keyboard is grabbed.
- SDL_
HINT_ ANDROID_ ALLOW_ RECREATE_ ACTIVITY - A variable to control whether the SDL activity is allowed to be re-created.
- SDL_
HINT_ ANDROID_ BLOCK_ ON_ PAUSE - A variable to control whether the event loop will block itself when the app is paused.
- SDL_
HINT_ ANDROID_ LOW_ LATENCY_ AUDIO - A variable to control whether low latency audio should be enabled.
- SDL_
HINT_ ANDROID_ TRAP_ BACK_ BUTTON - A variable to control whether we trap the Android back button to handle it manually.
- SDL_
HINT_ APPLE_ TV_ CONTROLLER_ UI_ EVENTS - A variable controlling whether controllers used with the Apple TV generate UI events.
- SDL_
HINT_ APPLE_ TV_ REMOTE_ ALLOW_ ROTATION - A variable controlling whether the Apple TV remote’s joystick axes will automatically match the rotation of the remote.
- SDL_
HINT_ APP_ ID - A variable setting the app ID string.
- SDL_
HINT_ APP_ NAME - A variable setting the application name.
- SDL_
HINT_ ASSERT - A variable controlling response to [
SDL_assert] failures. - SDL_
HINT_ AUDIO_ ALSA_ DEFAULT_ DEVICE - Specify the default ALSA audio device name.
- SDL_
HINT_ AUDIO_ ALSA_ DEFAULT_ PLAYBACK_ DEVICE - Specify the default ALSA audio playback device name.
- SDL_
HINT_ AUDIO_ ALSA_ DEFAULT_ RECORDING_ DEVICE - Specify the default ALSA audio recording device name.
- SDL_
HINT_ AUDIO_ CATEGORY - A variable controlling the audio category on iOS and macOS.
- SDL_
HINT_ AUDIO_ CHANNELS - A variable controlling the default audio channel count.
- SDL_
HINT_ AUDIO_ DEVICE_ APP_ ICON_ NAME - Specify an application icon name for an audio device.
- SDL_
HINT_ AUDIO_ DEVICE_ SAMPLE_ FRAMES - A variable controlling device buffer size.
- SDL_
HINT_ AUDIO_ DEVICE_ STREAM_ NAME - Specify an audio stream name for an audio device.
- SDL_
HINT_ AUDIO_ DEVICE_ STREAM_ ROLE - Specify an application role for an audio device.
- SDL_
HINT_ AUDIO_ DISK_ INPUT_ FILE - Specify the input file when recording audio using the disk audio driver.
- SDL_
HINT_ AUDIO_ DISK_ OUTPUT_ FILE - Specify the output file when playing audio using the disk audio driver.
- SDL_
HINT_ AUDIO_ DISK_ TIMESCALE - A variable controlling the audio rate when using the disk audio driver.
- SDL_
HINT_ AUDIO_ DRIVER - A variable that specifies an audio backend to use.
- SDL_
HINT_ AUDIO_ DUMMY_ TIMESCALE - A variable controlling the audio rate when using the dummy audio driver.
- SDL_
HINT_ AUDIO_ FORMAT - A variable controlling the default audio format.
- SDL_
HINT_ AUDIO_ FREQUENCY - A variable controlling the default audio frequency.
- SDL_
HINT_ AUDIO_ INCLUDE_ MONITORS - A variable that causes SDL to not ignore audio “monitors”.
- SDL_
HINT_ AUTO_ UPDATE_ JOYSTICKS - A variable controlling whether SDL updates joystick state when getting input events.
- SDL_
HINT_ AUTO_ UPDATE_ SENSORS - A variable controlling whether SDL updates sensor state when getting input events.
- SDL_
HINT_ BMP_ SAVE_ LEGACY_ FORMAT - Prevent SDL from using version 4 of the bitmap header when saving BMPs.
- SDL_
HINT_ CAMERA_ DRIVER - A variable that decides what camera backend to use.
- SDL_
HINT_ CPU_ FEATURE_ MASK - A variable that limits what CPU features are available.
- SDL_
HINT_ DEFAULT - SDL_
HINT_ DISPLAY_ USABLE_ BOUNDS - Override for [
SDL_GetDisplayUsableBounds()]. - SDL_
HINT_ EGL_ LIBRARY - Specify the EGL library to load.
- SDL_
HINT_ EMSCRIPTEN_ ASYNCIFY - Disable giving back control to the browser automatically when running with asyncify.
- SDL_
HINT_ EMSCRIPTEN_ CANVAS_ SELECTOR - Specify the CSS selector used for the “default” window/canvas.
- SDL_
HINT_ EMSCRIPTEN_ KEYBOARD_ ELEMENT - Override the binding element for keyboard inputs for Emscripten builds.
- SDL_
HINT_ ENABLE_ SCREEN_ KEYBOARD - A variable that controls whether the on-screen keyboard should be shown when text input is active.
- SDL_
HINT_ EVDEV_ DEVICES - A variable containing a list of evdev devices to use if udev is not available.
- SDL_
HINT_ EVENT_ LOGGING - A variable controlling verbosity of the logging of SDL events pushed onto the internal queue.
- SDL_
HINT_ FILE_ DIALOG_ DRIVER - A variable that specifies a dialog backend to use.
- SDL_
HINT_ FORCE_ RAISEWINDOW - A variable controlling whether raising the window should be done more forcefully.
- SDL_
HINT_ FRAMEBUFFER_ ACCELERATION - A variable controlling how 3D acceleration is used to accelerate the SDL screen surface.
- SDL_
HINT_ GAMECONTROLLERCONFIG - A variable that lets you manually hint extra gamecontroller db entries.
- SDL_
HINT_ GAMECONTROLLERCONFIG_ FILE - A variable that lets you provide a file with extra gamecontroller db entries.
- SDL_
HINT_ GAMECONTROLLERTYPE - A variable that overrides the automatic controller type detection.
- SDL_
HINT_ GAMECONTROLLER_ IGNORE_ DEVICES - A variable containing a list of devices to skip when scanning for game controllers.
- SDL_
HINT_ GAMECONTROLLER_ IGNORE_ DEVICES_ EXCEPT - If set, all devices will be skipped when scanning for game controllers except for the ones listed in this variable.
- SDL_
HINT_ GAMECONTROLLER_ SENSOR_ FUSION - A variable that controls whether the device’s built-in accelerometer and gyro should be used as sensors for gamepads.
- SDL_
HINT_ GDK_ TEXTINPUT_ DEFAULT_ TEXT - This variable sets the default text of the TextInput window on GDK platforms.
- SDL_
HINT_ GDK_ TEXTINPUT_ DESCRIPTION - This variable sets the description of the TextInput window on GDK platforms.
- SDL_
HINT_ GDK_ TEXTINPUT_ MAX_ LENGTH - This variable sets the maximum input length of the TextInput window on GDK platforms.
- SDL_
HINT_ GDK_ TEXTINPUT_ SCOPE - This variable sets the input scope of the TextInput window on GDK platforms.
- SDL_
HINT_ GDK_ TEXTINPUT_ TITLE - This variable sets the title of the TextInput window on GDK platforms.
- SDL_
HINT_ GPU_ DRIVER - A variable that specifies a GPU backend to use.
- SDL_
HINT_ HIDAPI_ ENUMERATE_ ONLY_ CONTROLLERS - A variable to control whether [
SDL_hid_enumerate()] enumerates all HID devices or only controllers. - SDL_
HINT_ HIDAPI_ IGNORE_ DEVICES - A variable containing a list of devices to ignore in [
SDL_hid_enumerate()]. - SDL_
HINT_ HIDAPI_ LIBUSB - A variable to control whether HIDAPI uses libusb for device access.
- SDL_
HINT_ HIDAPI_ LIBUSB_ WHITELIST - A variable to control whether HIDAPI uses libusb only for whitelisted devices.
- SDL_
HINT_ HIDAPI_ UDEV - A variable to control whether HIDAPI uses udev for device detection.
- SDL_
HINT_ IME_ IMPLEMENTED_ UI - A variable describing what IME UI elements the application can display.
- SDL_
HINT_ IOS_ HIDE_ HOME_ INDICATOR - A variable controlling whether the home indicator bar on iPhone X should be hidden.
- SDL_
HINT_ JOYSTICK_ ALLOW_ BACKGROUND_ EVENTS - A variable that lets you enable joystick (and gamecontroller) events even when your app is in the background.
- SDL_
HINT_ JOYSTICK_ ARCADESTICK_ DEVICES - A variable containing a list of arcade stick style controllers.
- SDL_
HINT_ JOYSTICK_ ARCADESTICK_ DEVICES_ EXCLUDED - A variable containing a list of devices that are not arcade stick style controllers.
- SDL_
HINT_ JOYSTICK_ BLACKLIST_ DEVICES - A variable containing a list of devices that should not be considered joysticks.
- SDL_
HINT_ JOYSTICK_ BLACKLIST_ DEVICES_ EXCLUDED - A variable containing a list of devices that should be considered joysticks.
- SDL_
HINT_ JOYSTICK_ DEVICE - A variable containing a comma separated list of devices to open as joysticks.
- SDL_
HINT_ JOYSTICK_ DIRECTINPUT - A variable controlling whether DirectInput should be used for controllers.
- SDL_
HINT_ JOYSTICK_ ENHANCED_ REPORTS - A variable controlling whether enhanced reports should be used for controllers when using the HIDAPI driver.
- SDL_
HINT_ JOYSTICK_ FLIGHTSTICK_ DEVICES - A variable containing a list of flightstick style controllers.
- SDL_
HINT_ JOYSTICK_ FLIGHTSTICK_ DEVICES_ EXCLUDED - A variable containing a list of devices that are not flightstick style controllers.
- SDL_
HINT_ JOYSTICK_ GAMECUBE_ DEVICES - A variable containing a list of devices known to have a GameCube form factor.
- SDL_
HINT_ JOYSTICK_ GAMECUBE_ DEVICES_ EXCLUDED - A variable containing a list of devices known not to have a GameCube form factor.
- SDL_
HINT_ JOYSTICK_ GAMEINPUT - A variable controlling whether GameInput should be used for controller handling on Windows.
- SDL_
HINT_ JOYSTICK_ HIDAPI - A variable controlling whether the HIDAPI joystick drivers should be used.
- SDL_
HINT_ JOYSTICK_ HIDAPI_ COMBINE_ JOY_ CONS - A variable controlling whether Nintendo Switch Joy-Con controllers will be combined into a single Pro-like controller when using the HIDAPI driver.
- SDL_
HINT_ JOYSTICK_ HIDAPI_ GAMECUBE - A variable controlling whether the HIDAPI driver for Nintendo GameCube controllers should be used.
- SDL_
HINT_ JOYSTICK_ HIDAPI_ GAMECUBE_ RUMBLE_ BRAKE - A variable controlling whether rumble is used to implement the GameCube controller’s 3 rumble modes, Stop(0), Rumble(1), and StopHard(2).
- SDL_
HINT_ JOYSTICK_ HIDAPI_ JOYCON_ HOME_ LED - A variable controlling whether the Home button LED should be turned on when a Nintendo Switch Joy-Con controller is opened.
- SDL_
HINT_ JOYSTICK_ HIDAPI_ JOY_ CONS - A variable controlling whether the HIDAPI driver for Nintendo Switch Joy-Cons should be used.
- SDL_
HINT_ JOYSTICK_ HIDAPI_ LUNA - A variable controlling whether the HIDAPI driver for Amazon Luna controllers connected via Bluetooth should be used.
- SDL_
HINT_ JOYSTICK_ HIDAPI_ NINTENDO_ CLASSIC - A variable controlling whether the HIDAPI driver for Nintendo Online classic controllers should be used.
- SDL_
HINT_ JOYSTICK_ HIDAPI_ PS3 - A variable controlling whether the HIDAPI driver for PS3 controllers should be used.
- SDL_
HINT_ JOYSTICK_ HIDAPI_ PS4 - A variable controlling whether the HIDAPI driver for PS4 controllers should be used.
- SDL_
HINT_ JOYSTICK_ HIDAPI_ PS5 - A variable controlling whether the HIDAPI driver for PS5 controllers should be used.
- SDL_
HINT_ JOYSTICK_ HIDAPI_ PS3_ SIXAXIS_ DRIVER - A variable controlling whether the Sony driver (sixaxis.sys) for PS3 controllers (Sixaxis/DualShock 3) should be used.
- SDL_
HINT_ JOYSTICK_ HIDAPI_ PS4_ REPORT_ INTERVAL - A variable controlling the update rate of the PS4 controller over Bluetooth when using the HIDAPI driver.
- SDL_
HINT_ JOYSTICK_ HIDAPI_ PS5_ PLAYER_ LED - A variable controlling whether the player LEDs should be lit to indicate which player is associated with a PS5 controller.
- SDL_
HINT_ JOYSTICK_ HIDAPI_ SHIELD - A variable controlling whether the HIDAPI driver for NVIDIA SHIELD controllers should be used.
- SDL_
HINT_ JOYSTICK_ HIDAPI_ STADIA - A variable controlling whether the HIDAPI driver for Google Stadia controllers should be used.
- SDL_
HINT_ JOYSTICK_ HIDAPI_ STEAM - A variable controlling whether the HIDAPI driver for Bluetooth Steam Controllers should be used.
- SDL_
HINT_ JOYSTICK_ HIDAPI_ STEAMDECK - A variable controlling whether the HIDAPI driver for the Steam Deck builtin controller should be used.
- SDL_
HINT_ JOYSTICK_ HIDAPI_ STEAM_ HOME_ LED - A variable controlling whether the Steam button LED should be turned on when a Steam controller is opened.
- SDL_
HINT_ JOYSTICK_ HIDAPI_ STEAM_ HORI - A variable controlling whether the HIDAPI driver for HORI licensed Steam controllers should be used.
- SDL_
HINT_ JOYSTICK_ HIDAPI_ SWITCH - A variable controlling whether the HIDAPI driver for Nintendo Switch controllers should be used.
- SDL_
HINT_ JOYSTICK_ HIDAPI_ SWITCH_ HOME_ LED - A variable controlling whether the Home button LED should be turned on when a Nintendo Switch Pro controller is opened.
- SDL_
HINT_ JOYSTICK_ HIDAPI_ SWITCH_ PLAYER_ LED - A variable controlling whether the player LEDs should be lit to indicate which player is associated with a Nintendo Switch controller.
- SDL_
HINT_ JOYSTICK_ HIDAPI_ VERTICAL_ JOY_ CONS - A variable controlling whether Nintendo Switch Joy-Con controllers will be in vertical mode when using the HIDAPI driver.
- SDL_
HINT_ JOYSTICK_ HIDAPI_ WII - A variable controlling whether the HIDAPI driver for Nintendo Wii and Wii U controllers should be used.
- SDL_
HINT_ JOYSTICK_ HIDAPI_ WII_ PLAYER_ LED - A variable controlling whether the player LEDs should be lit to indicate which player is associated with a Wii controller.
- SDL_
HINT_ JOYSTICK_ HIDAPI_ XBOX - A variable controlling whether the HIDAPI driver for XBox controllers should be used.
- SDL_
HINT_ JOYSTICK_ HIDAPI_ XBOX_ 360 - A variable controlling whether the HIDAPI driver for XBox 360 controllers should be used.
- SDL_
HINT_ JOYSTICK_ HIDAPI_ XBOX_ 360_ PLAYER_ LED - A variable controlling whether the player LEDs should be lit to indicate which player is associated with an Xbox 360 controller.
- SDL_
HINT_ JOYSTICK_ HIDAPI_ XBOX_ 360_ WIRELESS - A variable controlling whether the HIDAPI driver for XBox 360 wireless controllers should be used.
- SDL_
HINT_ JOYSTICK_ HIDAPI_ XBOX_ ONE - A variable controlling whether the HIDAPI driver for XBox One controllers should be used.
- SDL_
HINT_ JOYSTICK_ HIDAPI_ XBOX_ ONE_ HOME_ LED - A variable controlling whether the Home button LED should be turned on when an Xbox One controller is opened.
- SDL_
HINT_ JOYSTICK_ IOKIT - A variable controlling whether IOKit should be used for controller handling.
- SDL_
HINT_ JOYSTICK_ LINUX_ CLASSIC - A variable controlling whether to use the classic /dev/input/js* joystick interface or the newer /dev/input/event* joystick interface on Linux.
- SDL_
HINT_ JOYSTICK_ LINUX_ DEADZONES - A variable controlling whether joysticks on Linux adhere to their HID-defined deadzones or return unfiltered values.
- SDL_
HINT_ JOYSTICK_ LINUX_ DIGITAL_ HATS - A variable controlling whether joysticks on Linux will always treat ‘hat’ axis inputs (ABS_HAT0X - ABS_HAT3Y) as 8-way digital hats without checking whether they may be analog.
- SDL_
HINT_ JOYSTICK_ LINUX_ HAT_ DEADZONES - A variable controlling whether digital hats on Linux will apply deadzones to their underlying input axes or use unfiltered values.
- SDL_
HINT_ JOYSTICK_ MFI - A variable controlling whether GCController should be used for controller handling.
- SDL_
HINT_ JOYSTICK_ RAWINPUT - A variable controlling whether the RAWINPUT joystick drivers should be used for better handling XInput-capable devices.
- SDL_
HINT_ JOYSTICK_ RAWINPUT_ CORRELATE_ XINPUT - A variable controlling whether the RAWINPUT driver should pull correlated data from XInput.
- SDL_
HINT_ JOYSTICK_ ROG_ CHAKRAM - A variable controlling whether the ROG Chakram mice should show up as joysticks.
- SDL_
HINT_ JOYSTICK_ THREAD - A variable controlling whether a separate thread should be used for handling joystick detection and raw input messages on Windows.
- SDL_
HINT_ JOYSTICK_ THROTTLE_ DEVICES - A variable containing a list of throttle style controllers.
- SDL_
HINT_ JOYSTICK_ THROTTLE_ DEVICES_ EXCLUDED - A variable containing a list of devices that are not throttle style controllers.
- SDL_
HINT_ JOYSTICK_ WGI - A variable controlling whether Windows.Gaming.Input should be used for controller handling.
- SDL_
HINT_ JOYSTICK_ WHEEL_ DEVICES - A variable containing a list of wheel style controllers.
- SDL_
HINT_ JOYSTICK_ WHEEL_ DEVICES_ EXCLUDED - A variable containing a list of devices that are not wheel style controllers.
- SDL_
HINT_ JOYSTICK_ ZERO_ CENTERED_ DEVICES - A variable containing a list of devices known to have all axes centered at zero.
- SDL_
HINT_ KEYCODE_ OPTIONS - A variable that controls keycode representation in keyboard events.
- SDL_
HINT_ KMSDRM_ DEVICE_ INDEX - A variable that controls what KMSDRM device to use.
- SDL_
HINT_ KMSDRM_ REQUIRE_ DRM_ MASTER - A variable that controls whether SDL requires DRM master access in order to initialize the KMSDRM video backend.
- SDL_
HINT_ LOGGING - A variable controlling the default SDL log levels.
- SDL_
HINT_ MAC_ BACKGROUND_ APP - A variable controlling whether to force the application to become the foreground process when launched on macOS.
- SDL_
HINT_ MAC_ CTRL_ CLICK_ EMULATE_ RIGHT_ CLICK - A variable that determines whether Ctrl+Click should generate a right-click event on macOS.
- SDL_
HINT_ MAC_ OPENGL_ ASYNC_ DISPATCH - A variable controlling whether dispatching OpenGL context updates should block the dispatching thread until the main thread finishes processing on macOS.
- SDL_
HINT_ MAC_ OPTION_ AS_ ALT - A variable controlling whether the Option key on macOS should be remapped to act as the Alt key.
- SDL_
HINT_ MAC_ SCROLL_ MOMENTUM - A variable controlling whether [
SDL_EVENT_MOUSE_WHEEL] event values will have momentum on macOS. - SDL_
HINT_ MAIN_ CALLBACK_ RATE - Request [
SDL_AppIterate()] be called at a specific rate. - SDL_
HINT_ MOUSE_ AUTO_ CAPTURE - A variable controlling whether the mouse is captured while mouse buttons are pressed.
- SDL_
HINT_ MOUSE_ DEFAULT_ SYSTEM_ CURSOR - A variable setting which system cursor to use as the default cursor.
- SDL_
HINT_ MOUSE_ DOUBLE_ CLICK_ RADIUS - A variable setting the double click radius, in pixels.
- SDL_
HINT_ MOUSE_ DOUBLE_ CLICK_ TIME - A variable setting the double click time, in milliseconds.
- SDL_
HINT_ MOUSE_ EMULATE_ WARP_ WITH_ RELATIVE - A variable controlling whether warping a hidden mouse cursor will activate relative mouse mode.
- SDL_
HINT_ MOUSE_ FOCUS_ CLICKTHROUGH - Allow mouse click events when clicking to focus an SDL window.
- SDL_
HINT_ MOUSE_ NORMAL_ SPEED_ SCALE - A variable setting the speed scale for mouse motion, in floating point, when the mouse is not in relative mode.
- SDL_
HINT_ MOUSE_ RELATIVE_ CURSOR_ VISIBLE - A variable controlling whether the hardware cursor stays visible when relative mode is active.
- SDL_
HINT_ MOUSE_ RELATIVE_ MODE_ CENTER - A variable controlling whether relative mouse mode constrains the mouse to the center of the window.
- SDL_
HINT_ MOUSE_ RELATIVE_ SPEED_ SCALE - A variable setting the scale for mouse motion, in floating point, when the mouse is in relative mode.
- SDL_
HINT_ MOUSE_ RELATIVE_ SYSTEM_ SCALE - A variable controlling whether the system mouse acceleration curve is used for relative mouse motion.
- SDL_
HINT_ MOUSE_ RELATIVE_ WARP_ MOTION - A variable controlling whether a motion event should be generated for mouse warping in relative mode.
- SDL_
HINT_ MOUSE_ TOUCH_ EVENTS - A variable controlling whether mouse events should generate synthetic touch events.
- SDL_
HINT_ MUTE_ CONSOLE_ KEYBOARD - A variable controlling whether the keyboard should be muted on the console.
- SDL_
HINT_ NORMAL - SDL_
HINT_ NO_ SIGNAL_ HANDLERS - Tell SDL not to catch the SIGINT or SIGTERM signals on POSIX platforms.
- SDL_
HINT_ OPENGL_ ES_ DRIVER - A variable controlling what driver to use for OpenGL ES contexts.
- SDL_
HINT_ OPENGL_ LIBRARY - Specify the OpenGL library to load.
- SDL_
HINT_ OPENVR_ LIBRARY - Mechanism to specify openvr_api library location
- SDL_
HINT_ ORIENTATIONS - A variable controlling which orientations are allowed on iOS/Android.
- SDL_
HINT_ OVERRIDE - SDL_
HINT_ PEN_ MOUSE_ EVENTS - A variable controlling whether pen events should generate synthetic mouse events.
- SDL_
HINT_ PEN_ TOUCH_ EVENTS - A variable controlling whether pen events should generate synthetic touch events.
- SDL_
HINT_ POLL_ SENTINEL - A variable controlling the use of a sentinel event when polling the event queue.
- SDL_
HINT_ PREFERRED_ LOCALES - Override for [
SDL_GetPreferredLocales()]. - SDL_
HINT_ QUIT_ ON_ LAST_ WINDOW_ CLOSE - A variable that decides whether to send [
SDL_EVENT_QUIT] when closing the last window. - SDL_
HINT_ RENDER_ DIREC T3D11_ DEBUG - A variable controlling whether to enable Direct3D 11+’s Debug Layer.
- SDL_
HINT_ RENDER_ DIREC T3D_ THREADSAFE - A variable controlling whether the Direct3D device is initialized for thread-safe operations.
- SDL_
HINT_ RENDER_ DRIVER - A variable specifying which render driver to use.
- SDL_
HINT_ RENDER_ GPU_ DEBUG - A variable controlling whether to create the GPU device in debug mode.
- SDL_
HINT_ RENDER_ GPU_ LOW_ POWER - A variable controlling whether to prefer a low-power GPU on multi-GPU systems.
- SDL_
HINT_ RENDER_ LINE_ METHOD - A variable controlling how the 2D render API renders lines.
- SDL_
HINT_ RENDER_ METAL_ PREFER_ LOW_ POWER_ DEVICE - A variable controlling whether the Metal render driver select low power device over default one.
- SDL_
HINT_ RENDER_ VSYNC - A variable controlling whether updates to the SDL screen surface should be synchronized with the vertical refresh, to avoid tearing.
- SDL_
HINT_ RENDER_ VULKAN_ DEBUG - A variable controlling whether to enable Vulkan Validation Layers.
- SDL_
HINT_ RETURN_ KEY_ HIDES_ IME - A variable to control whether the return key on the soft keyboard should hide the soft keyboard on Android and iOS.
- SDL_
HINT_ ROG_ GAMEPAD_ MICE - A variable containing a list of ROG gamepad capable mice.
- SDL_
HINT_ ROG_ GAMEPAD_ MICE_ EXCLUDED - A variable containing a list of devices that are not ROG gamepad capable mice.
- SDL_
HINT_ RPI_ VIDEO_ LAYER - A variable controlling which Dispmanx layer to use on a Raspberry PI.
- SDL_
HINT_ SCREENSAVER_ INHIBIT_ ACTIVITY_ NAME - Specify an “activity name” for screensaver inhibition.
- SDL_
HINT_ SHUTDOWN_ DBUS_ ON_ QUIT - A variable controlling whether SDL calls dbus_shutdown() on quit.
- SDL_
HINT_ STORAGE_ TITLE_ DRIVER - A variable that specifies a backend to use for title storage.
- SDL_
HINT_ STORAGE_ USER_ DRIVER - A variable that specifies a backend to use for user storage.
- SDL_
HINT_ THREAD_ FORCE_ REALTIME_ TIME_ CRITICAL - Specifies whether [
SDL_THREAD_PRIORITY_TIME_CRITICAL] should be treated as realtime. - SDL_
HINT_ THREAD_ PRIORITY_ POLICY - A string specifying additional information to use with
[
SDL_SetCurrentThreadPriority]. - SDL_
HINT_ TIMER_ RESOLUTION - A variable that controls the timer resolution, in milliseconds.
- SDL_
HINT_ TOUCH_ MOUSE_ EVENTS - A variable controlling whether touch events should generate synthetic mouse events.
- SDL_
HINT_ TRACKPAD_ IS_ TOUCH_ ONLY - A variable controlling whether trackpads should be treated as touch devices.
- SDL_
HINT_ TV_ REMOTE_ AS_ JOYSTICK - A variable controlling whether the Android / tvOS remotes should be listed as joystick devices, instead of sending keyboard events.
- SDL_
HINT_ VIDEO_ ALLOW_ SCREENSAVER - A variable controlling whether the screensaver is enabled.
- SDL_
HINT_ VIDEO_ DISPLAY_ PRIORITY - A comma separated list containing the names of the displays that SDL should sort to the front of the display list.
- SDL_
HINT_ VIDEO_ DOUBLE_ BUFFER - Tell the video driver that we only want a double buffer.
- SDL_
HINT_ VIDEO_ DRIVER - A variable that specifies a video backend to use.
- SDL_
HINT_ VIDEO_ DUMMY_ SAVE_ FRAMES - A variable controlling whether the dummy video driver saves output frames.
- SDL_
HINT_ VIDEO_ EGL_ ALLOW_ GETDISPLAY_ FALLBACK - If eglGetPlatformDisplay fails, fall back to calling eglGetDisplay.
- SDL_
HINT_ VIDEO_ FORCE_ EGL - A variable controlling whether the OpenGL context should be created with EGL.
- SDL_
HINT_ VIDEO_ MAC_ FULLSCREEN_ MENU_ VISIBILITY - A variable that specifies the menu visibility when a window is fullscreen in Spaces on macOS.
- SDL_
HINT_ VIDEO_ MAC_ FULLSCREEN_ SPACES - A variable that specifies the policy for fullscreen Spaces on macOS.
- SDL_
HINT_ VIDEO_ MINIMIZE_ ON_ FOCUS_ LOSS - A variable controlling whether fullscreen windows are minimized when they lose focus.
- SDL_
HINT_ VIDEO_ OFFSCREEN_ SAVE_ FRAMES - A variable controlling whether the offscreen video driver saves output frames.
- SDL_
HINT_ VIDEO_ SYNC_ WINDOW_ OPERATIONS - A variable controlling whether all window operations will block until complete.
- SDL_
HINT_ VIDEO_ WAYLAND_ ALLOW_ LIBDECOR - A variable controlling whether the libdecor Wayland backend is allowed to be used.
- SDL_
HINT_ VIDEO_ WAYLAND_ MODE_ EMULATION - A variable controlling whether video mode emulation is enabled under Wayland.
- SDL_
HINT_ VIDEO_ WAYLAND_ MODE_ SCALING - A variable controlling how modes with a non-native aspect ratio are displayed under Wayland.
- SDL_
HINT_ VIDEO_ WAYLAND_ PREFER_ LIBDECOR - A variable controlling whether the libdecor Wayland backend is preferred over native decorations.
- SDL_
HINT_ VIDEO_ WAYLAND_ SCALE_ TO_ DISPLAY - A variable forcing non-DPI-aware Wayland windows to output at 1:1 scaling.
- SDL_
HINT_ VIDEO_ WIN_ D3DCOMPILER - A variable specifying which shader compiler to preload when using the Chrome ANGLE binaries.
- SDL_
HINT_ VIDEO_ X11_ NET_ WM_ BYPASS_ COMPOSITOR - A variable controlling whether the X11 _NET_WM_BYPASS_COMPOSITOR hint should be used.
- SDL_
HINT_ VIDEO_ X11_ NET_ WM_ PING - A variable controlling whether the X11 _NET_WM_PING protocol should be supported.
- SDL_
HINT_ VIDEO_ X11_ NODIRECTCOLOR - A variable controlling whether SDL uses DirectColor visuals.
- SDL_
HINT_ VIDEO_ X11_ SCALING_ FACTOR - A variable forcing the content scaling factor for X11 displays.
- SDL_
HINT_ VIDEO_ X11_ VISUALID - A variable forcing the visual ID used for X11 display modes.
- SDL_
HINT_ VIDEO_ X11_ WINDOW_ VISUALID - A variable forcing the visual ID chosen for new X11 windows.
- SDL_
HINT_ VIDEO_ X11_ XRANDR - A variable controlling whether the X11 XRandR extension should be used.
- SDL_
HINT_ VITA_ ENABLE_ BACK_ TOUCH - A variable controlling whether touch should be enabled on the back panel of the PlayStation Vita.
- SDL_
HINT_ VITA_ ENABLE_ FRONT_ TOUCH - A variable controlling whether touch should be enabled on the front panel of the PlayStation Vita.
- SDL_
HINT_ VITA_ MODULE_ PATH - A variable controlling the module path on the PlayStation Vita.
- SDL_
HINT_ VITA_ PVR_ INIT - A variable controlling whether to perform PVR initialization on the PlayStation Vita.
- SDL_
HINT_ VITA_ PVR_ OPENGL - A variable controlling whether OpenGL should be used instead of OpenGL ES on the PlayStation Vita.
- SDL_
HINT_ VITA_ RESOLUTION - A variable overriding the resolution reported on the PlayStation Vita.
- SDL_
HINT_ VITA_ TOUCH_ MOUSE_ DEVICE - A variable controlling which touchpad should generate synthetic mouse events.
- SDL_
HINT_ VULKAN_ DISPLAY - A variable overriding the display index used in [
SDL_Vulkan_CreateSurface()] - SDL_
HINT_ VULKAN_ LIBRARY - Specify the Vulkan library to load.
- SDL_
HINT_ WAVE_ CHUNK_ LIMIT - A variable controlling the maximum number of chunks in a WAVE file.
- SDL_
HINT_ WAVE_ FACT_ CHUNK - A variable controlling how the fact chunk affects the loading of a WAVE file.
- SDL_
HINT_ WAVE_ RIFF_ CHUNK_ SIZE - A variable controlling how the size of the RIFF chunk affects the loading of a WAVE file.
- SDL_
HINT_ WAVE_ TRUNCATION - A variable controlling how a truncated WAVE file is handled.
- SDL_
HINT_ WINDOWS_ CLOSE_ ON_ ALT_ F4 - A variable controlling whether SDL generates window-close events for Alt+F4 on Windows.
- SDL_
HINT_ WINDOWS_ ENABLE_ MENU_ MNEMONICS - A variable controlling whether menus can be opened with their keyboard shortcut (Alt+mnemonic).
- SDL_
HINT_ WINDOWS_ ENABLE_ MESSAGELOOP - A variable controlling whether the windows message loop is processed by SDL.
- SDL_
HINT_ WINDOWS_ ERASE_ BACKGROUND_ MODE - A variable controlling whether SDL will clear the window contents when the WM_ERASEBKGND message is received.
- SDL_
HINT_ WINDOWS_ FORCE_ SEMAPHORE_ KERNEL - A variable controlling whether SDL uses Kernel Semaphores on Windows.
- SDL_
HINT_ WINDOWS_ GAMEINPUT - A variable controlling whether GameInput is used for raw keyboard and mouse on Windows.
- SDL_
HINT_ WINDOWS_ INTRESOURCE_ ICON - A variable to specify custom icon resource id from RC file on Windows platform.
- SDL_
HINT_ WINDOWS_ INTRESOURCE_ ICON_ SMALL - A variable to specify custom icon resource id from RC file on Windows platform.
- SDL_
HINT_ WINDOWS_ RAW_ KEYBOARD - A variable controlling whether raw keyboard events are used on Windows.
- SDL_
HINT_ WINDOWS_ USE_ D3D9EX - A variable controlling whether SDL uses the D3D9Ex API introduced in Windows Vista, instead of normal D3D9.
- SDL_
HINT_ WINDOW_ ACTIVATE_ WHEN_ RAISED - A variable controlling whether the window is activated when the
[
SDL_RaiseWindow] function is called. - SDL_
HINT_ WINDOW_ ACTIVATE_ WHEN_ SHOWN - A variable controlling whether the window is activated when the
[
SDL_ShowWindow] function is called. - SDL_
HINT_ WINDOW_ ALLOW_ TOPMOST - If set to “0” then never set the top-most flag on an SDL Window even if the application requests it.
- SDL_
HINT_ WINDOW_ FRAME_ USABLE_ WHILE_ CURSOR_ HIDDEN - A variable controlling whether the window frame and title bar are interactive when the cursor is hidden.
- SDL_
HINT_ X11_ FORCE_ OVERRIDE_ REDIRECT - A variable controlling whether X11 windows are marked as override-redirect.
- SDL_
HINT_ X11_ WINDOW_ TYPE - A variable specifying the type of an X11 window.
- SDL_
HINT_ X11_ XCB_ LIBRARY - Specify the XCB library to load for the X11 driver.
- SDL_
HINT_ XINPUT_ ENABLED - A variable controlling whether XInput should be used for controller handling.
Functions§
- SDL_
AddHint ⚠Callback - Add a function to watch a particular hint.
- SDL_
GetHint ⚠ - Get the value of a hint.
- SDL_
GetHint ⚠Boolean - Get the boolean value of a hint variable.
- SDL_
Remove ⚠Hint Callback - Remove a function watching a particular hint.
- SDL_
Reset ⚠Hint - Reset a hint to the default value.
- SDL_
Reset ⚠Hints - Reset all hints to the default values.
- SDL_
SetHint ⚠ - Set a hint with normal priority.
- SDL_
SetHint ⚠With Priority - Set a hint with a specific priority.
Type Aliases§
- SDL_
Hint Callback - A callback used to send notifications of hint value changes.