—

              
package SDL2::hints 0.01 {
    use SDL2::Utils;
    use experimental 'signatures';
    #
    use SDL2::stdinc;
    #
    define SDL_Hint => [
        [ SDL_HINT_ACCELEROMETER_AS_JOYSTICK   => 'SDL_ACCELEROMETER_AS_JOYSTICK' ],
        [ SDL_HINT_ALLOW_ALT_TAB_WHILE_GRABBED => 'SDL_ALLOW_ALT_TAB_WHILE_GRABBED' ],
        [ SDL_HINT_ALLOW_TOPMOST               => 'SDL_ALLOW_TOPMOST' ],
        [   SDL_HINT_ANDROID_APK_EXPANSION_MAIN_FILE_VERSION =>
                'SDL_ANDROID_APK_EXPANSION_MAIN_FILE_VERSION'
        ],
        [   SDL_HINT_ANDROID_APK_EXPANSION_PATCH_FILE_VERSION =>
                'SDL_ANDROID_APK_EXPANSION_PATCH_FILE_VERSION'
        ],
        [ SDL_HINT_ANDROID_BLOCK_ON_PAUSE            => 'SDL_ANDROID_BLOCK_ON_PAUSE' ],
        [ SDL_HINT_ANDROID_BLOCK_ON_PAUSE_PAUSEAUDIO => 'SDL_ANDROID_BLOCK_ON_PAUSE_PAUSEAUDIO' ],
        [ SDL_HINT_ANDROID_SEPARATE_MOUSE_AND_TOUCH  => 'SDL_ANDROID_SEPARATE_MOUSE_AND_TOUCH' ],
        [ SDL_HINT_ANDROID_TRAP_BACK_BUTTON          => 'SDL_ANDROID_TRAP_BACK_BUTTON' ],
        [ SDL_HINT_APPLE_TV_CONTROLLER_UI_EVENTS     => 'SDL_APPLE_TV_CONTROLLER_UI_EVENTS' ],
        [ SDL_HINT_APPLE_TV_REMOTE_ALLOW_ROTATION    => 'SDL_APPLE_TV_REMOTE_ALLOW_ROTATION' ],
        [ SDL_HINT_AUDIO_CATEGORY                    => 'SDL_AUDIO_CATEGORY' ],
        [ SDL_HINT_AUDIO_DEVICE_APP_NAME             => 'SDL_AUDIO_DEVICE_APP_NAME' ],
        [ SDL_HINT_AUDIO_DEVICE_STREAM_NAME          => 'SDL_AUDIO_DEVICE_STREAM_NAME' ],
        [ SDL_HINT_AUDIO_DEVICE_STREAM_ROLE          => 'SDL_AUDIO_DEVICE_STREAM_ROLE' ],
        [ SDL_HINT_AUDIO_RESAMPLING_MODE             => 'SDL_AUDIO_RESAMPLING_MODE' ],
        [ SDL_HINT_AUTO_UPDATE_JOYSTICKS             => 'SDL_AUTO_UPDATE_JOYSTICKS' ],
        [ SDL_HINT_AUTO_UPDATE_SENSORS               => 'SDL_AUTO_UPDATE_SENSORS' ],
        [ SDL_HINT_BMP_SAVE_LEGACY_FORMAT            => 'SDL_BMP_SAVE_LEGACY_FORMAT' ],
        [ SDL_HINT_DISPLAY_USABLE_BOUNDS             => 'SDL_DISPLAY_USABLE_BOUNDS' ],
        [ SDL_HINT_EMSCRIPTEN_ASYNCIFY               => 'SDL_EMSCRIPTEN_ASYNCIFY' ],
        [ SDL_HINT_EMSCRIPTEN_KEYBOARD_ELEMENT       => 'SDL_EMSCRIPTEN_KEYBOARD_ELEMENT' ],
        [ SDL_HINT_ENABLE_STEAM_CONTROLLERS          => 'SDL_ENABLE_STEAM_CONTROLLERS' ],
        [ SDL_HINT_EVENT_LOGGING                     => 'SDL_EVENT_LOGGING' ],
        [ SDL_HINT_FRAMEBUFFER_ACCELERATION          => 'SDL_FRAMEBUFFER_ACCELERATION' ],
        [ SDL_HINT_GAMECONTROLLERCONFIG              => 'SDL_GAMECONTROLLERCONFIG' ],
        [ SDL_HINT_GAMECONTROLLERCONFIG_FILE         => 'SDL_GAMECONTROLLERCONFIG_FILE' ],
        [ SDL_HINT_GAMECONTROLLERTYPE                => 'SDL_GAMECONTROLLERTYPE' ],
        [ SDL_HINT_GAMECONTROLLER_IGNORE_DEVICES     => 'SDL_GAMECONTROLLER_IGNORE_DEVICES' ],
        [   SDL_HINT_GAMECONTROLLER_IGNORE_DEVICES_EXCEPT =>
                'SDL_GAMECONTROLLER_IGNORE_DEVICES_EXCEPT'
        ],
        [ SDL_HINT_GAMECONTROLLER_USE_BUTTON_LABELS   => 'SDL_GAMECONTROLLER_USE_BUTTON_LABELS' ],
        [ SDL_HINT_GRAB_KEYBOARD                      => 'SDL_GRAB_KEYBOARD' ],
        [ SDL_HINT_IDLE_TIMER_DISABLED                => 'SDL_IDLE_TIMER_DISABLED' ],
        [ SDL_HINT_IME_INTERNAL_EDITING               => 'SDL_IME_INTERNAL_EDITING' ],
        [ SDL_HINT_IOS_HIDE_HOME_INDICATOR            => 'SDL_IOS_HIDE_HOME_INDICATOR' ],
        [ SDL_HINT_JOYSTICK_ALLOW_BACKGROUND_EVENTS   => 'SDL_JOYSTICK_ALLOW_BACKGROUND_EVENTS' ],
        [ SDL_HINT_JOYSTICK_HIDAPI                    => 'SDL_JOYSTICK_HIDAPI' ],
        [ SDL_HINT_JOYSTICK_HIDAPI_CORRELATE_XINPUT   => 'SDL_JOYSTICK_HIDAPI_CORRELATE_XINPUT' ],
        [ SDL_HINT_JOYSTICK_HIDAPI_GAMECUBE           => 'SDL_JOYSTICK_HIDAPI_GAMECUBE' ],
        [ SDL_HINT_JOYSTICK_HIDAPI_JOY_CONS           => 'SDL_JOYSTICK_HIDAPI_JOY_CONS' ],
        [ SDL_HINT_JOYSTICK_HIDAPI_PS4                => 'SDL_JOYSTICK_HIDAPI_PS4' ],
        [ SDL_HINT_JOYSTICK_HIDAPI_PS4_RUMBLE         => 'SDL_JOYSTICK_HIDAPI_PS4_RUMBLE' ],
        [ SDL_HINT_JOYSTICK_HIDAPI_PS5                => 'SDL_JOYSTICK_HIDAPI_PS5' ],
        [ SDL_HINT_JOYSTICK_HIDAPI_PS5_PLAYER_LED     => 'SDL_JOYSTICK_HIDAPI_PS5_PLAYER_LED' ],
        [ SDL_HINT_JOYSTICK_HIDAPI_PS5_RUMBLE         => 'SDL_JOYSTICK_HIDAPI_PS5_RUMBLE' ],
        [ SDL_HINT_JOYSTICK_HIDAPI_STADIA             => 'SDL_JOYSTICK_HIDAPI_STADIA' ],
        [ SDL_HINT_JOYSTICK_HIDAPI_STEAM              => 'SDL_JOYSTICK_HIDAPI_STEAM' ],
        [ SDL_HINT_JOYSTICK_HIDAPI_SWITCH             => 'SDL_JOYSTICK_HIDAPI_SWITCH' ],
        [ SDL_HINT_JOYSTICK_HIDAPI_SWITCH_HOME_LED    => 'SDL_JOYSTICK_HIDAPI_SWITCH_HOME_LED' ],
        [ SDL_HINT_JOYSTICK_HIDAPI_XBOX               => 'SDL_JOYSTICK_HIDAPI_XBOX' ],
        [ SDL_HINT_JOYSTICK_RAWINPUT                  => 'SDL_JOYSTICK_RAWINPUT' ],
        [ SDL_HINT_JOYSTICK_THREAD                    => 'SDL_JOYSTICK_THREAD' ],
        [ SDL_HINT_KMSDRM_REQUIRE_DRM_MASTER          => 'SDL_KMSDRM_REQUIRE_DRM_MASTER' ],
        [ SDL_HINT_LINUX_JOYSTICK_DEADZONES           => 'SDL_LINUX_JOYSTICK_DEADZONES' ],
        [ SDL_HINT_MAC_BACKGROUND_APP                 => 'SDL_MAC_BACKGROUND_APP' ],
        [ SDL_HINT_MAC_CTRL_CLICK_EMULATE_RIGHT_CLICK => 'SDL_MAC_CTRL_CLICK_EMULATE_RIGHT_CLICK' ],
        [ SDL_HINT_MOUSE_DOUBLE_CLICK_RADIUS          => 'SDL_MOUSE_DOUBLE_CLICK_RADIUS' ],
        [ SDL_HINT_MOUSE_DOUBLE_CLICK_TIME            => 'SDL_MOUSE_DOUBLE_CLICK_TIME' ],
        [ SDL_HINT_MOUSE_FOCUS_CLICKTHROUGH           => 'SDL_MOUSE_FOCUS_CLICKTHROUGH' ],
        [ SDL_HINT_MOUSE_NORMAL_SPEED_SCALE           => 'SDL_MOUSE_NORMAL_SPEED_SCALE' ],
        [ SDL_HINT_MOUSE_RELATIVE_MODE_WARP           => 'SDL_MOUSE_RELATIVE_MODE_WARP' ],
        [ SDL_HINT_MOUSE_RELATIVE_SCALING             => 'SDL_MOUSE_RELATIVE_SCALING' ],
        [ SDL_HINT_MOUSE_RELATIVE_SPEED_SCALE         => 'SDL_MOUSE_RELATIVE_SPEED_SCALE' ],
        [ SDL_HINT_MOUSE_TOUCH_EVENTS                 => 'SDL_MOUSE_TOUCH_EVENTS' ],
        [ SDL_HINT_NO_SIGNAL_HANDLERS                 => 'SDL_NO_SIGNAL_HANDLERS' ],
        [ SDL_HINT_OPENGL_ES_DRIVER                   => 'SDL_OPENGL_ES_DRIVER' ],
        [ SDL_HINT_ORIENTATIONS                       => 'SDL_ORIENTATIONS' ],
        [ SDL_HINT_PREFERRED_LOCALES                  => 'SDL_PREFERRED_LOCALES' ],
        [ SDL_HINT_QTWAYLAND_CONTENT_ORIENTATION      => 'SDL_QTWAYLAND_CONTENT_ORIENTATION' ],
        [ SDL_HINT_QTWAYLAND_WINDOW_FLAGS             => 'SDL_QTWAYLAND_WINDOW_FLAGS' ],
        [ SDL_HINT_RENDER_BATCHING                    => 'SDL_RENDER_BATCHING' ],
        [ SDL_HINT_RENDER_DIRECT3D11_DEBUG            => 'SDL_RENDER_DIRECT3D11_DEBUG' ],
        [ SDL_HINT_RENDER_DIRECT3D_THREADSAFE         => 'SDL_RENDER_DIRECT3D_THREADSAFE' ],
        [ SDL_HINT_RENDER_DRIVER                      => 'SDL_RENDER_DRIVER' ],
        [ SDL_HINT_RENDER_LOGICAL_SIZE_MODE           => 'SDL_RENDER_LOGICAL_SIZE_MODE' ],
        [ SDL_HINT_RENDER_OPENGL_SHADERS              => 'SDL_RENDER_OPENGL_SHADERS' ],
        [ SDL_HINT_RENDER_SCALE_QUALITY               => 'SDL_RENDER_SCALE_QUALITY' ],
        [ SDL_HINT_RENDER_VSYNC                       => 'SDL_RENDER_VSYNC' ],
        [ SDL_HINT_RETURN_KEY_HIDES_IME               => 'SDL_RETURN_KEY_HIDES_IME' ],
        [ SDL_HINT_RPI_VIDEO_LAYER                    => 'SDL_RPI_VIDEO_LAYER' ],
        [   SDL_HINT_THREAD_FORCE_REALTIME_TIME_CRITICAL =>
                'SDL_THREAD_FORCE_REALTIME_TIME_CRITICAL'
        ],
        [ SDL_HINT_THREAD_PRIORITY_POLICY             => 'SDL_THREAD_PRIORITY_POLICY' ],
        [ SDL_HINT_THREAD_STACK_SIZE                  => 'SDL_THREAD_STACK_SIZE' ],
        [ SDL_HINT_TIMER_RESOLUTION                   => 'SDL_TIMER_RESOLUTION' ],
        [ SDL_HINT_TOUCH_MOUSE_EVENTS                 => 'SDL_TOUCH_MOUSE_EVENTS' ],
        [ SDL_HINT_TV_REMOTE_AS_JOYSTICK              => 'SDL_TV_REMOTE_AS_JOYSTICK' ],
        [ SDL_HINT_VIDEO_ALLOW_SCREENSAVER            => 'SDL_VIDEO_ALLOW_SCREENSAVER' ],
        [ SDL_HINT_VIDEO_DOUBLE_BUFFER                => 'SDL_VIDEO_DOUBLE_BUFFER' ],
        [ SDL_HINT_VIDEO_EXTERNAL_CONTEXT             => 'SDL_VIDEO_EXTERNAL_CONTEXT' ],
        [ SDL_HINT_VIDEO_HIGHDPI_DISABLED             => 'SDL_VIDEO_HIGHDPI_DISABLED' ],
        [ SDL_HINT_VIDEO_MAC_FULLSCREEN_SPACES        => 'SDL_VIDEO_MAC_FULLSCREEN_SPACES' ],
        [ SDL_HINT_VIDEO_MINIMIZE_ON_FOCUS_LOSS       => 'SDL_VIDEO_MINIMIZE_ON_FOCUS_LOSS' ],
        [ SDL_HINT_VIDEO_WINDOW_SHARE_PIXEL_FORMAT    => 'SDL_VIDEO_WINDOW_SHARE_PIXEL_FORMAT' ],
        [ SDL_HINT_VIDEO_WIN_D3DCOMPILE               => 'SDL_VIDEO_WIN_D3DCOMPILE' ],
        [ SDL_HINT_VIDEO_WIN_D3DCOMPILER              => 'SDL_VIDEO_WIN_D3DCOMPILER' ],
        [ SDL_HINT_VIDEO_X11_FORCE_EGL                => 'SDL_VIDEO_X11_FORCE_EGL' ],
        [ SDL_HINT_VIDEO_X11_NET_WM_BYPASS_COMPOSITOR => 'SDL_VIDEO_X11_NET_WM_BYPASS_COMPOSITOR' ],
        [ SDL_HINT_VIDEO_X11_NET_WM_PING              => 'SDL_VIDEO_X11_NET_WM_PING' ],
        [ SDL_HINT_VIDEO_X11_WINDOW_VISUALID          => 'SDL_VIDEO_X11_WINDOW_VISUALID' ],
        [ SDL_HINT_VIDEO_X11_XINERAMA                 => 'SDL_VIDEO_X11_XINERAMA' ],
        [ SDL_HINT_VIDEO_X11_XRANDR                   => 'SDL_VIDEO_X11_XRANDR' ],
        [ SDL_HINT_VIDEO_X11_XVIDMODE                 => 'SDL_VIDEO_X11_XVIDMODE' ],
        [ SDL_HINT_WAVE_FACT_CHUNK                    => 'SDL_WAVE_FACT_CHUNK' ],
        [ SDL_HINT_WAVE_RIFF_CHUNK_SIZE               => 'SDL_WAVE_RIFF_CHUNK_SIZE' ],
        [ SDL_HINT_WAVE_TRUNCATION                    => 'SDL_WAVE_TRUNCATION' ],
        [ SDL_HINT_WINDOWS_DISABLE_THREAD_NAMING      => 'SDL_WINDOWS_DISABLE_THREAD_NAMING' ],
        [ SDL_HINT_WINDOWS_ENABLE_MESSAGELOOP         => 'SDL_WINDOWS_ENABLE_MESSAGELOOP' ],
        [   SDL_HINT_WINDOWS_FORCE_MUTEX_CRITICAL_SECTIONS =>
                'SDL_WINDOWS_FORCE_MUTEX_CRITICAL_SECTIONS'
        ],
        [ SDL_HINT_WINDOWS_FORCE_SEMAPHORE_KERNEL => 'SDL_WINDOWS_FORCE_SEMAPHORE_KERNEL' ],
        [ SDL_HINT_WINDOWS_INTRESOURCE_ICON       => 'SDL_WINDOWS_INTRESOURCE_ICON' ],
        [ SDL_HINT_WINDOWS_INTRESOURCE_ICON_SMALL => 'SDL_WINDOWS_INTRESOURCE_ICON_SMALL' ],
        [ SDL_HINT_WINDOWS_NO_CLOSE_ON_ALT_F4     => 'SDL_WINDOWS_NO_CLOSE_ON_ALT_F4' ],
        [ SDL_HINT_WINDOWS_USE_D3D9EX             => 'SDL_WINDOWS_USE_D3D9EX' ],
        [   SDL_HINT_WINDOW_FRAME_USABLE_WHILE_CURSOR_HIDDEN =>
                'SDL_WINDOW_FRAME_USABLE_WHILE_CURSOR_HIDDEN'
        ],
        [ SDL_HINT_WINRT_HANDLE_BACK_BUTTON        => 'SDL_WINRT_HANDLE_BACK_BUTTON' ],
        [ SDL_HINT_WINRT_PRIVACY_POLICY_LABEL      => 'SDL_WINRT_PRIVACY_POLICY_LABEL' ],
        [ SDL_HINT_WINRT_PRIVACY_POLICY_URL        => 'SDL_WINRT_PRIVACY_POLICY_URL' ],
        [ SDL_HINT_XINPUT_ENABLED                  => 'SDL_XINPUT_ENABLED' ],
        [ SDL_HINT_XINPUT_USE_OLD_JOYSTICK_MAPPING => 'SDL_XINPUT_USE_OLD_JOYSTICK_MAPPING' ]
    ];
    enum SDL_HintPriority => [qw[SDL_HINT_DEFAULT SDL_HINT_NORMAL SDL_HINT_OVERRIDE]];
    ffi->type( '(opaque,string,string,string)->void' => 'SDL_HintCallback' );
    attach hints => {
        SDL_SetHintWithPriority => [ [ 'string', 'string', 'int' ] => 'SDL_bool' ],
        SDL_SetHint             => [ [ 'string', 'string' ]        => 'SDL_bool' ],
        SDL_GetHint             => [ ['string']                    => 'string' ],
        SDL_GetHintBoolean      => [ [ 'string', 'SDL_bool' ]      => 'SDL_bool' ],
        SDL_AddHintCallback     => [
            [ 'string', 'SDL_HintCallback', 'opaque' ] =>
                sub ( $xsub, $name, $callback, $userdata ) {    # Fake void pointer
                my $cb = FFI::Platypus::Closure->new(
                    sub ( $ptr, @etc ) { $callback->( $userdata, @etc ) } );
                $cb->sticky;
                $xsub->( $name, $cb, $userdata );
                return $cb;
            }
        ],
        SDL_DelHintCallback => [
            [ 'string', 'SDL_HintCallback', 'opaque' ] =>
                sub ( $xsub, $name, $callback, $userdata ) {    # Fake void pointer
                my $cb = $callback;
                $cb->unstick;
                $xsub->( $name, $cb, $userdata );
                return $cb;
            }
        ],
        SDL_ClearHints => [ [] ],
    };
HideShow 2231 lines of Pod
=encoding utf-8
=head1 NAME
SDL2::hints - SDL Configuration Variables
=head1 SYNOPSIS
    use SDL2 qw[:hints];
=head1 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.
=head1 Functions
Functions listed here may be imported by name or with the C<:hints> tag.
=head2 C<SDL_SetHintWithPriority( ... )>
Set a hint with a specific priority.
        SDL_SetHintWithPriority( SDL_EVENT_LOGGING, 2, SDL_HINT_OVERRIDE );
The priority controls the behavior when setting a hint that already has a
value. Hints will replace existing hints of their priority and lower.
Environment variables are considered to have override priority.
Expected parameters include:
=over
=item C<name>
the hint to set
=item C<value>
the value of the hint variable
=item C<priority>
the priority level for the hint
=back
Returns a true if the hint was set, untrue otherwise.
=head2 C<SDL_SetHint( ... )>
Set a hint with normal priority.
        SDL_SetHint( SDL_HINT_XINPUT_ENABLED, 1 );
Hints will not be set if there is an existing override hint or environment
variable that takes precedence. You can use SDL_SetHintWithPriority( ) to set
the hint with override priority instead.
Expected parameters:
=over
=item C<name>
the hint to set
=item C<value>
the value of the hint variable
=back
Returns a true value if the hint was set, untrue otherwise.
=head2 C<SDL_GetHint( ... )>
Get the value of a hint.
        SDL_GetHint( SDL_HINT_XINPUT_ENABLED );
Expected parameters:
=over
=item C<name>
the hint to query
=back
Returns the string value of a hint or an undefined value if the hint isn't set.
=head2 C<SDL_GetHintBoolean( ... )>
Get the boolean value of a hint variable.
        SDL_GetHintBoolean( SDL_HINT_XINPUT_ENABLED, 0);
Expected parameters:
=over
=item C<name>
the name of the hint to get the boolean value from
=item C<default_value>
the value to return if the hint does not exist
=back
Returns the boolean value of a hint or the provided default value if the hint
does not exist.
=head2 C<SDL_AddHintCallback( ... )>
Add a function to watch a particular hint.
        my $cb = SDL_AddHintCallback(
                SDL_HINT_XINPUT_ENABLED,
                sub {
                        my ($userdata, $name, $oldvalue, $newvalue) = @_;
                        ...;
                },
                { time => time( ), clicks => 3 }
        );
Expected parameters:
=over
=item C<name>
the hint to watch
=item C<callback>
a code reference that will be called when the hint value changes
=item C<userdata>
a pointer to pass to the callback function
=back
Returns a pointer to a L<FFI::Platypus::Closure> which you may pass to L<<
C<SDL_DelHintCallback( ... )>|/C<SDL_DelHintCallback( ... )> >>.
=head2 C<SDL_DelHintCallback( ... )>
Remove a callback watching a particular hint.
        SDL_AddHintCallback(
                SDL_HINT_XINPUT_ENABLED,
                $cb,
                { time => time( ), clicks => 3 }
        );
Expected parameters:
=over
=item C<name>
the hint to watch
=item C<callback>
L<FFI::Platypus::Closure> object returned by L<< C<SDL_AddHintCallback( ...
)>|/C<SDL_AddHintCallback( ... )> >>
=item C<userdata>
a pointer to pass to the callback function
=back
=head2 C<SDL_ClearHints( )>
Clear all hints.
        SDL_ClearHints( );
This function is automatically called during C<SDL_Quit( )>.
=head1 Defined Variables and Enumerations
Variables may be imported by name or with the C<:hints> tag.
=head2 C<SDL_HintPriority>
An enumeration of hint priorities. May be imported with the C<:hintPriority>
tag.
=over
=item C<SDL_HINT_DEFAULT> - low priority, used for default values
=item C<SDL_HINT_NORMAL> - medium priority
=item C<SDL_HINT_OVERRIDE> - high priority
=back
=head2 C<SDL_Hint>
The following enum values can be passed to Configuration Variables related
functions. They may be imported with the C<:hints> tag.
=over
=item C<SDL_HINT_ACCELEROMETER_AS_JOYSTICK>
A hint that specifies whether the Android / iOS built-in accelerometer should
be listed as a joystick device, rather than listing actual joysticks only.
Values:
    0   list only real joysticks and accept input from them
    1   list real joysticks along with the accelorometer as if it were a 3 axis joystick (the default)
Example:
    # This disables the use of gyroscopes as axis device
    SDL_SetHint(SDL_HINT_ACCELEROMETER_AS_JOYSTICK, "0");
=item C<SDL_HINT_ANDROID_APK_EXPANSION_MAIN_FILE_VERSION>
A hint that specifies the Android APK expansion main file version.
Values:
    X   the Android APK expansion main file version (should be a string number like "1", "2" etc.)
This hint must be set together with the hint
C<SDL_HINT_ANDROID_APK_EXPANSION_PATCH_FILE_VERSION>.
If both hints were set then C<SDL_RWFromFile( )> will look into expansion files
after a given relative path was not found in the internal storage and assets.
By default this hint is not set and the APK expansion files are not searched.
=item C<SDL_HINT_ANDROID_APK_EXPANSION_PATCH_FILE_VERSION>
A hint that specifies the Android APK expansion patch file version.
Values:
    X   the Android APK expansion patch file version (should be a string number like "1", "2" etc.)
This hint must be set together with the hint
C<SDL_HINT_ANDROID_APK_EXPANSION_MAIN_FILE_VERSION>.
If both hints were set then C<SDL_RWFromFile( )> will look into expansion files
after a given relative path was not found in the internal storage and assets.
By default this hint is not set and the APK expansion files are not searched.
=item C<SDL_HINT_ANDROID_SEPARATE_MOUSE_AND_TOUCH>
A hint that specifies a variable to control whether mouse and touch events are
to be treated together or separately.
Values:
    0   mouse events will be handled as touch events and touch will raise fake mouse events (default)
    1   mouse events will be handled separately from pure touch events
By default mouse events will be handled as touch events and touch will raise
fake mouse events.
The value of this hint is used at runtime, so it can be changed at any time.
=item C<SDL_HINT_APPLE_TV_CONTROLLER_UI_EVENTS>
A hint that specifies whether controllers used with the Apple TV generate UI
events.
Values:
    0   controller input does not gnerate UI events (default)
    1   controller input generates UI events
When UI events are generated by controller input, the app will be backgrounded
when the Apple TV remote's menu button is pressed, and when the pause or B
buttons on gamepads are pressed.
More information about properly making use of controllers for the Apple TV can
be found here:
https://developer.apple.com/tvos/human-interface-guidelines/remote-and-controllers/
=item C<SDL_HINT_APPLE_TV_REMOTE_ALLOW_ROTATION>
A hint that specifies whether the Apple TV remote's joystick axes will
automatically match the rotation of the remote.
Values:
    0   remote orientation does not affect joystick axes (default)
    1   joystick axes are based on the orientation of the remote
=item C<SDL_HINT_BMP_SAVE_LEGACY_FORMAT>
A hint that specifies whether SDL should not use version 4 of the bitmap header
when saving BMPs.
Values:
    0   version 4 of the bitmap header will be used when saving BMPs (default)
    1   version 4 of the bitmap header will not be used when saving BMPs
The bitmap header version 4 is required for proper alpha channel support and
SDL will use it when required. Should this not be desired, this hint can force
the use of the 40 byte header version which is supported everywhere.
If the hint is not set then surfaces with a colorkey or an alpha channel are
saved to a 32-bit BMP file with an alpha mask. SDL will use the bitmap header
version 4 and set the alpha mask accordingly. This is the default behavior
since SDL 2.0.5.
If the hint is set then surfaces with a colorkey or an alpha channel are saved
to a 32-bit BMP file without an alpha mask. The alpha channel data will be in
the file, but applications are going to ignore it. This was the default
behavior before SDL 2.0.5.
=item C<SDL_HINT_EMSCRIPTEN_ASYNCIFY>
A hint that specifies if SDL should give back control to the browser
automatically when running with asyncify.
Values:
    0   disable emscripten_sleep calls (if you give back browser control manually or use asyncify for other purposes)
    1   enable emscripten_sleep calls (default)
This hint only applies to the Emscripten platform.
=item C<SDL_HINT_EMSCRIPTEN_KEYBOARD_ELEMENT>
A hint that specifies a value to override the binding element for keyboard
inputs for Emscripten builds.
Values:
    #window     the JavaScript window object (default)
    #document   the JavaScript document object
    #screen     the JavaScript window.screen object
    #canvas     the default WebGL canvas element
Any other string without a leading # sign applies to the element on the page
with that ID.
This hint only applies to the Emscripten platform.
=item C<SDL_HINT_FRAMEBUFFER_ACCELERATION>
A hint that specifies how 3D acceleration is used with L<SDL_GetWindowSurface(
... )|SDL2/SDL_GetWindowSurface( ... )>.
Values:
    0   disable 3D acceleration
    1   enable 3D acceleration, using the default renderer
    X   enable 3D acceleration, using X where X is one of the valid rendering drivers. (e.g. "direct3d", "opengl", etc.)
By default SDL tries to make a best guess whether to use acceleration or not on
each platform.
SDL can try to accelerate the screen surface returned by
L<SDL_GetWindowSurface( ... )|SDL2/SDL_GetWindowSurface( ... )> by using
streaming textures with a 3D rendering engine. This variable controls whether
and how this is done.
=item C<SDL_HINT_GAMECONTROLLERCONFIG>
A variable that lets you provide a file with extra gamecontroller db entries.
This hint must be set before calling C<SDL_Init(SDL_INIT_GAMECONTROLLER)>.
You can update mappings after the system is initialized with
C<SDL_GameControllerMappingForGUID( )> and C<SDL_GameControllerAddMapping( )>.
=item C<SDL_HINT_GRAB_KEYBOARD>
A variable setting the double click time, in milliseconds.
=item C<SDL_HINT_IDLE_TIMER_DISABLED>
A hint that specifies a variable controlling whether the idle timer is disabled
on iOS.
Values:
    0   enable idle timer (default)
    1   disable idle timer
When an iOS application does not receive touches for some time, the screen is
dimmed automatically. For games where the accelerometer is the only input this
is problematic. This functionality can be disabled by setting this hint.
As of SDL 2.0.4, C<SDL_EnableScreenSaver( )> and C<SDL_DisableScreenSaver( )>
accomplish the same thing on iOS. They should be preferred over this hint.
=item C<SDL_HINT_IME_INTERNAL_EDITING>
A variable to control whether we trap the Android back button to handle it
manually. This is necessary for the right mouse button to work on some Android
devices, or to be able to trap the back button for use in your code reliably.
If set to true, the back button will show up as an C<SDL_KEYDOWN> /
C<SDL_KEYUP> pair with a keycode of C<SDL_SCANCODE_AC_BACK>.
The variable can be set to the following values:
    0   Back button will be handled as usual for system. (default)
    1   Back button will be trapped, allowing you to handle the key press
        manually. (This will also let right mouse click work on systems
        where the right mouse button functions as back.)
The value of this hint is used at runtime, so it can be changed at any time.
=item C<SDL_HINT_JOYSTICK_ALLOW_BACKGROUND_EVENTS>
A variable controlling whether the HIDAPI joystick drivers should be used.
This variable can be set to the following values:
    0   HIDAPI drivers are not used
    1   HIDAPI drivers are used (default)
This variable is the default for all drivers, but can be overridden by the
hints for specific drivers below.
=item C<SDL_HINT_MAC_BACKGROUND_APP>
A hint that specifies if the SDL app should not be forced to become a
foreground process on Mac OS X.
Values:
    0   force the SDL app to become a foreground process (default)
    1   do not force the SDL app to become a foreground process
This hint only applies to Mac OSX.
=item C<SDL_HINT_MAC_CTRL_CLICK_EMULATE_RIGHT_CLICK>
A hint that specifies whether ctrl+click should generate a right-click event on
Mac.
Values:
    0   disable emulating right click (default)
    1   enable emulating right click
=item C<SDL_HINT_MOUSE_FOCUS_CLICKTHROUGH>
A hint that specifies if mouse click events are sent when clicking to focus an
SDL window.
Values:
    0   no mouse click events are sent when clicking to focus (default)
    1   mouse click events are sent when clicking to focus
=item C<SDL_HINT_MOUSE_RELATIVE_MODE_WARP>
A hint that specifies whether relative mouse mode is implemented using mouse
warping.
Values:
    0   relative mouse mode uses the raw input (default)
    1   relative mouse mode uses mouse warping
=item C<SDL_HINT_NO_SIGNAL_HANDLERS>
A hint that specifies not to catch the C<SIGINT> or C<SIGTERM> signals.
Values:
    0   SDL will install a SIGINT and SIGTERM handler, and when it
        catches a signal, convert it into an SDL_QUIT event
    1   SDL will not install a signal handler at all
=item C<SDL_HINT_ORIENTATIONS>
A variable controlling which orientations are allowed on iOS/Android.
In some circumstances it is necessary to be able to explicitly control which UI
orientations are allowed.
This variable is a space delimited list of the following values:
=over
=item C<LandscapeLeft>
=item C<LandscapeRight>
=item C<Portrait>
=item C<PortraitUpsideDown>
=back
=item C<SDL_HINT_RENDER_DIRECT3D11_DEBUG>
A variable controlling whether to enable Direct3D 11+'s Debug Layer.
This variable does not have any effect on the Direct3D 9 based renderer.
This variable can be set to the following values:
    0   Disable Debug Layer use (default)
    1   Enable Debug Layer use
=item C<SDL_HINT_RENDER_DIRECT3D_THREADSAFE>
A variable controlling whether the Direct3D device is initialized for
thread-safe operations.
This variable can be set to the following values:
    0   Thread-safety is not enabled (faster; default)
    1   Thread-safety is enabled
=item C<SDL_HINT_RENDER_DRIVER>
A variable specifying which render driver to use.
If the application doesn't pick a specific renderer to use, this variable
specifies the name of the preferred renderer. If the preferred renderer can't
be initialized, the normal default renderer is used.
This variable is case insensitive and can be set to the following values:
=over
=item C<direct3d>
=item C<opengl>
=item C<opengles2>
=item C<opengles>
=item C<metal>
=item C<software>
=back
The default varies by platform, but it's the first one in the list that is
available on the current platform.
=item C<SDL_HINT_RENDER_OPENGL_SHADERS>
A variable controlling whether the OpenGL render driver uses shaders if they
are available.
This variable can be set to the following values:
    0   Disable shaders
    1   Enable shaders (default)
=item C<SDL_HINT_RENDER_SCALE_QUALITY>
A variable controlling the scaling quality
This variable can be set to the following values:     0 or nearest    Nearest
pixel sampling (default)     1 or linear     Linear filtering (supported by
OpenGL and Direct3D)     2 or best       Currently this is the same as linear
=item C<SDL_HINT_RENDER_VSYNC>
A variable controlling whether updates to the SDL screen surface should be
synchronized with the vertical refresh, to avoid tearing.
This variable can be set to the following values:
    0   Disable vsync
    1   Enable vsync
By default SDL does not sync screen surface updates with vertical refresh.
=item C<SDL_HINT_RPI_VIDEO_LAYER>
Tell SDL which Dispmanx layer to use on a Raspberry PI
Also known as Z-order. The variable can take a negative or positive value.
The default is C<10000>.
=item C<SDL_HINT_THREAD_STACK_SIZE>
A string specifying SDL's threads stack size in bytes or C<0> for the backend's
default size
Use this hint in case you need to set SDL's threads stack size to other than
the default. This is specially useful if you build SDL against a non glibc libc
library (such as musl) which provides a relatively small default thread stack
size (a few kilobytes versus the default 8MB glibc uses). Support for this hint
is currently available only in the pthread, Windows, and PSP backend.
Instead of this hint, in 2.0.9 and later, you can use
C<SDL_CreateThreadWithStackSize( )>. This hint only works with the classic
C<SDL_CreateThread( )>.
=item C<SDL_HINT_TIMER_RESOLUTION>
A variable that controls the timer resolution, in milliseconds.
he higher resolution the timer, the more frequently the CPU services timer
interrupts, and the more precise delays are, but this takes up power and CPU
time.  This hint is only used on Windows.
See this blog post for more information:
L<http://randomascii.wordpress.com/2013/07/08/windows-timer-resolution-megawatts-wasted/>
If this variable is set to C<0>, the system timer resolution is not set.
The default value is C<1>. This hint may be set at any time.
=item C<SDL_HINT_VIDEO_ALLOW_SCREENSAVER>
A variable controlling whether the screensaver is enabled.
This variable can be set to the following values:
    0   Disable screensaver
    1   Enable screensaver
By default SDL will disable the screensaver.
=item C<SDL_HINT_VIDEO_HIGHDPI_DISABLED>
If set to C<1>, then do not allow high-DPI windows. ("Retina" on Mac and iOS)
=item C<SDL_HINT_VIDEO_MAC_FULLSCREEN_SPACES>
A variable that dictates policy for fullscreen Spaces on Mac OS X.
This hint only applies to Mac OS X.
The variable can be set to the following values:
    0   Disable Spaces support (FULLSCREEN_DESKTOP won't use them and
        SDL_WINDOW_RESIZABLE windows won't offer the "fullscreen"
        button on their titlebars).
    1   Enable Spaces support (FULLSCREEN_DESKTOP will use them and
        SDL_WINDOW_RESIZABLE windows will offer the "fullscreen"
        button on their titlebars).
The default value is C<1>. Spaces are disabled regardless of this hint if the
OS isn't at least Mac OS X Lion (10.7). This hint must be set before any
windows are created.
=item C<SDL_HINT_VIDEO_MINIMIZE_ON_FOCUS_LOSS>
Minimize your L<SDL2::Window> if it loses key focus when in fullscreen mode.
Defaults to false.
Warning: Before SDL 2.0.14, this defaulted to true! In 2.0.14, we're seeing if
"true" causes more problems than it solves in modern times.
=item C<SDL_HINT_VIDEO_WIN_D3DCOMPILER>
A variable specifying which shader compiler to preload when using the Chrome
ANGLE binaries
SDL has EGL and OpenGL ES2 support on Windows via the ANGLE project. It can use
two different sets of binaries, those compiled by the user from source or those
provided by the Chrome browser. In the later case, these binaries require that
SDL loads a DLL providing the shader compiler.
This variable can be set to the following values:
=over
=item C<d3dcompiler_46.dll>
default, best for Vista or later.
=item C<d3dcompiler_43.dll>
for XP support.
=item C<none>
do not load any library, useful if you compiled ANGLE from source and included
the compiler in your binaries.
=back
=item C<SDL_HINT_VIDEO_WINDOW_SHARE_PIXEL_FORMAT>
A variable that is the address of another C<SDL_Window*> (as a hex string
formatted with C<%p>).
If this hint is set before C<SDL_CreateWindowFrom( )> and the C<SDL_Window*> it
is set to has C<SDL_WINDOW_OPENGL> set (and running on WGL only, currently),
then two things will occur on the newly created L<SDL2::Window>:
=over
=item 1. Its pixel format will be set to the same pixel format as this L<SDL2::Window>. This is needed for example when sharing an OpenGL context across multiple windows.
=item 2. The flag C<SDL_WINDOW_OPENGL> will be set on the new window so it can be used for OpenGL rendering.
=back
This variable can be set to the address (as a string C<%p>) of the
C<SDL_Window*> that new windows created with C<SDL_CreateWindowFrom( ... )>
should share a pixel format with.
=item C<SDL_HINT_VIDEO_X11_NET_WM_PING>
A variable controlling whether the X11 _NET_WM_PING protocol should be
supported.
This variable can be set to the following values:
    0   Disable _NET_WM_PING
    1   Enable _NET_WM_PING
By default SDL will use _NET_WM_PING, but for applications that know they will
not always be able to respond to ping requests in a timely manner they can turn
it off to avoid the window manager thinking the app is hung. The hint is
checked in CreateWindow.
=item C<SDL_HINT_VIDEO_X11_XINERAMA>
A variable controlling whether the X11 Xinerama extension should be used.
This variable can be set to the following values:
    0   Disable Xinerama
    1   Enable Xinerama
By default SDL will use Xinerama if it is available.
=item C<SDL_HINT_VIDEO_X11_XRANDR>
A variable controlling whether the X11 XRandR extension should be used.
This variable can be set to the following values:
    0   Disable XRandR
    1   Enable XRandR
By default SDL will not use XRandR because of window manager issues.
=item C<SDL_HINT_VIDEO_X11_XVIDMODE>
A variable controlling whether the X11 VidMode extension should be used.
This variable can be set to the following values:
    0   Disable XVidMode
    1   Enable XVidMode
By default SDL will use XVidMode if it is available.
=item C<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.
This variable can be set to the following values:
    0   The window frame is not interactive when the cursor is hidden (no move, resize, etc)
    1   The window frame is interactive when the cursor is hidden
By default SDL will allow interaction with the window frame when the cursor is
hidden.
=item C<SDL_HINT_WINDOWS_DISABLE_THREAD_NAMING>
Tell SDL not to name threads on Windows with the 0x406D1388 Exception. The
0x406D1388 Exception is a trick used to inform Visual Studio of a thread's
name, but it tends to cause problems with other debuggers, and the .NET
runtime. Note that SDL 2.0.6 and later will still use the (safer)
SetThreadDescription API, introduced in the Windows 10 Creators Update, if
available.
The variable can be set to the following values:
    0   SDL will raise the 0x406D1388 Exception to name threads.
        This is the default behavior of SDL <= 2.0.4.
    1   SDL will not raise this exception, and threads will be unnamed. (default)
        This is necessary with .NET languages or debuggers that aren't Visual Studio.
=item C<SDL_HINT_WINDOWS_INTRESOURCE_ICON>
A variable to specify custom icon resource id from RC file on Windows platform.
=item C<SDL_HINT_WINDOWS_INTRESOURCE_ICON_SMALL>
A variable to specify custom icon resource id from RC file on Windows platform.
=item C<SDL_HINT_WINDOWS_ENABLE_MESSAGELOOP>
A variable controlling whether the windows message loop is processed by SDL .
This variable can be set to the following values:
    0   The window message loop is not run
    1   The window message loop is processed in SDL_PumpEvents( )
By default SDL will process the windows message loop.
=item C<SDL_HINT_WINDOWS_NO_CLOSE_ON_ALT_F4>
Tell SDL not to generate window-close events for Alt+F4 on Windows.
The variable can be set to the following values:
    0   SDL will generate a window-close event when it sees Alt+F4.
    1   SDL will only do normal key handling for Alt+F4.
=item C<SDL_HINT_WINRT_HANDLE_BACK_BUTTON>
Allows back-button-press events on Windows Phone to be marked as handled.
Windows Phone devices typically feature a Back button.  When pressed, the OS
will emit back-button-press events, which apps are expected to handle in an
appropriate manner.  If apps do not explicitly mark these events as 'Handled',
then the OS will invoke its default behavior for unhandled back-button-press
events, which on Windows Phone 8 and 8.1 is to terminate the app (and attempt
to switch to the previous app, or to the device's home screen).
Setting the C<SDL_HINT_WINRT_HANDLE_BACK_BUTTON> hint to "1" will cause SDL to
mark back-button-press events as Handled, if and when one is sent to the app.
Internally, Windows Phone sends back button events as parameters to special
back-button-press callback functions.  Apps that need to respond to
back-button-press events are expected to register one or more callback
functions for such, shortly after being launched (during the app's
initialization phase).  After the back button is pressed, the OS will invoke
these callbacks.  If the app's callback(s) do not explicitly mark the event as
handled by the time they return, or if the app never registers one of these
callback, the OS will consider the event un-handled, and it will apply its
default back button behavior (terminate the app).
SDL registers its own back-button-press callback with the Windows Phone OS.
This callback will emit a pair of SDL key-press events (C<SDL_KEYDOWN> and
C<SDL_KEYUP>), each with a scancode of SDL_SCANCODE_AC_BACK, after which it
will check the contents of the hint, C<SDL_HINT_WINRT_HANDLE_BACK_BUTTON>. If
the hint's value is set to C<1>, the back button event's Handled property will
get set to a C<true> value. If the hint's value is set to something else, or if
it is unset, SDL will leave the event's Handled property alone. (By default,
the OS sets this property to 'false', to note.)
SDL apps can either set C<SDL_HINT_WINRT_HANDLE_BACK_BUTTON> well before a back
button is pressed, or can set it in direct-response to a back button being
pressed.
In order to get notified when a back button is pressed, SDL apps should
register a callback function with C<SDL_AddEventWatch( )>, and have it listen
for C<SDL_KEYDOWN> events that have a scancode of C<SDL_SCANCODE_AC_BACK>.
(Alternatively, C<SDL_KEYUP> events can be listened-for. Listening for either
event type is suitable.)  Any value of C<SDL_HINT_WINRT_HANDLE_BACK_BUTTON> set
by such a callback, will be applied to the OS' current back-button-press event.
More details on back button behavior in Windows Phone apps can be found at the
following page, on Microsoft's developer site:
L<http://msdn.microsoft.com/en-us/library/windowsphone/develop/jj247550(v=vs.105).aspx>
=item C<SDL_HINT_WINRT_PRIVACY_POLICY_LABEL>
Label text for a WinRT app's privacy policy link.
Network-enabled WinRT apps must include a privacy policy. On Windows 8, 8.1,
and RT, Microsoft mandates that this policy be available via the Windows
Settings charm. SDL provides code to add a link there, with its label text
being set via the optional hint, C<SDL_HINT_WINRT_PRIVACY_POLICY_LABEL>.
Please note that a privacy policy's contents are not set via this hint.  A
separate hint, C<SDL_HINT_WINRT_PRIVACY_POLICY_URL>, is used to link to the
actual text of the policy.
The contents of this hint should be encoded as a UTF8 string.
The default value is "Privacy Policy". This hint should only be set during app
initialization, preferably before any calls to C<SDL_Init( ... )>.
For additional information on linking to a privacy policy, see the
documentation for C<SDL_HINT_WINRT_PRIVACY_POLICY_URL>.
=item C<SDL_HINT_WINRT_PRIVACY_POLICY_URL>
A URL to a WinRT app's privacy policy.
All network-enabled WinRT apps must make a privacy policy available to its
users.  On Windows 8, 8.1, and RT, Microsoft mandates that this policy be be
available in the Windows Settings charm, as accessed from within the app. SDL
provides code to add a URL-based link there, which can point to the app's
privacy policy.
To setup a URL to an app's privacy policy, set
C<SDL_HINT_WINRT_PRIVACY_POLICY_URL> before calling any C<SDL_Init( ... )>
functions.  The contents of the hint should be a valid URL. For example,
L<http://www.example.com>.
The default value is an empty string (C<>), which will prevent SDL from adding
a privacy policy link to the Settings charm. This hint should only be set
during app init.
The label text of an app's "Privacy Policy" link may be customized via another
hint, C<SDL_HINT_WINRT_PRIVACY_POLICY_LABEL>.
Please note that on Windows Phone, Microsoft does not provide standard UI for
displaying a privacy policy link, and as such,
SDL_HINT_WINRT_PRIVACY_POLICY_URL will not get used on that platform.
Network-enabled phone apps should display their privacy policy through some
other, in-app means.
=item C<SDL_HINT_XINPUT_ENABLED>
A variable that lets you disable the detection and use of Xinput gamepad
devices
The variable can be set to the following values:
    0   Disable XInput detection (only uses direct input)
    1   Enable XInput detection (default)
=item C<SDL_HINT_XINPUT_USE_OLD_JOYSTICK_MAPPING>
A variable that causes SDL to use the old axis and button mapping for XInput
devices.
This hint is for backwards compatibility only and will be removed in SDL 2.1
The default value is C<0>.  This hint must be set before C<SDL_Init( ... )>
=item C<SDL_HINT_QTWAYLAND_WINDOW_FLAGS>
Flags to set on QtWayland windows to integrate with the native window manager.
On QtWayland platforms, this hint controls the flags to set on the windows. For
example, on Sailfish OS, C<OverridesSystemGestures> disables swipe gestures.
This variable is a space-separated list of the following values (empty = no
flags):
=over
=item C<OverridesSystemGestures>
=item C<StaysOnTop>
=item C<BypassWindowManager>
=back
=item C<SDL_HINT_QTWAYLAND_CONTENT_ORIENTATION>
A variable describing the content orientation on QtWayland-based platforms.
On QtWayland platforms, windows are rotated client-side to allow for custom
transitions. In order to correctly position overlays (e.g. volume bar) and
gestures (e.g. events view, close/minimize gestures), the system needs to know
in which orientation the application is currently drawing its contents.
This does not cause the window to be rotated or resized, the application needs
to take care of drawing the content in the right orientation (the framebuffer
is always in portrait mode).
This variable can be one of the following values:
=over
=item C<primary> (default)
=item C<portrait>
=item C<landscape>
=item C<inverted-portrait>
=item C<inverted-landscape>
=back
=item C<SDL_HINT_RENDER_LOGICAL_SIZE_MODE>
A variable controlling the scaling policy for C<SDL_RenderSetLogicalSize>.
This variable can be set to the following values:
=over
=item C<0> or C<letterbox>
Uses letterbox/sidebars to fit the entire rendering on screen.
=item C<1> or C<overscan>
Will zoom the rendering so it fills the entire screen, allowing edges to be
drawn offscreen.
=back
By default letterbox is used.
=item C<SDL_HINT_VIDEO_EXTERNAL_CONTEXT>
A variable controlling whether the graphics context is externally managed.
This variable can be set to the following values:
    0   SDL will manage graphics contexts that are attached to windows.
    1   Disable graphics context management on windows.
By default SDL will manage OpenGL contexts in certain situations. For example,
on Android the context will be automatically saved and restored when pausing
the application. Additionally, some platforms will assume usage of OpenGL if
Vulkan isn't used. Setting this to C<1> will prevent this behavior, which is
desirable when the application manages the graphics context, such as an
externally managed OpenGL context or attaching a Vulkan surface to the window.
=item <SDL_HINT_VIDEO_X11_WINDOW_VISUALID>
A variable forcing the visual ID chosen for new X11 windows.
=item C<SDL_HINT_VIDEO_X11_NET_WM_BYPASS_COMPOSITOR>
A variable controlling whether the X11 _NET_WM_BYPASS_COMPOSITOR hint should be
used.
This variable can be set to the following values:
    0   Disable _NET_WM_BYPASS_COMPOSITOR
    1   Enable _NET_WM_BYPASS_COMPOSITOR
By default SDL will use _NET_WM_BYPASS_COMPOSITOR.
=item C<SDL_HINT_VIDEO_X11_FORCE_EGL>
A variable controlling whether X11 should use GLX or EGL by default
This variable can be set to the following values:
    0   Use GLX
    1   Use EGL
By default SDL will use GLX when both are present.
=item C<SDL_HINT_MOUSE_DOUBLE_CLICK_TIME>
A variable setting the double click time, in milliseconds.
=item C<SDL_HINT_MOUSE_DOUBLE_CLICK_RADIUS>
A variable setting the double click radius, in pixels.
=item C<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.
=item C<SDL_HINT_MOUSE_RELATIVE_SPEED_SCALE>
A variable setting the scale for mouse motion, in floating point, when the
mouse is in relative mode.
=item C<SDL_HINT_MOUSE_RELATIVE_SCALING>
A variable controlling whether relative mouse motion is affected by renderer
scaling
This variable can be set to the following values:
    0   Relative motion is unaffected by DPI or renderer's logical size
    1   Relative motion is scaled according to DPI scaling and logical size
By default relative mouse deltas are affected by DPI and renderer scaling.
=item C<SDL_HINT_TOUCH_MOUSE_EVENTS>
A variable controlling whether touch events should generate synthetic mouse
events
This variable can be set to the following values:
    0   Touch events will not generate mouse events
    1   Touch events will generate mouse events
By default SDL will generate mouse events for touch events.
=item C<SDL_HINT_MOUSE_TOUCH_EVENTS>
A variable controlling whether mouse events should generate synthetic touch
events
This variable can be set to the following values:
    0   Mouse events will not generate touch events (default for desktop platforms)
    1   Mouse events will generate touch events (default for mobile platforms, such as Android and iOS)
=item C<SDL_HINT_IOS_HIDE_HOME_INDICATOR>
A variable controlling whether the home indicator bar on iPhone X should be
hidden.
This variable can be set to the following values:
    0   The indicator bar is not hidden (default for windowed applications)
    1   The indicator bar is hidden and is shown when the screen is touched (useful for movie playback applications)
    2   The indicator bar is dim and the first swipe makes it visible and the second swipe performs the "home" action (default for fullscreen applications)
=item C<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.
This variable can be set to the following values:
    0   Remotes send enter/escape/arrow key events
    1   Remotes are available as 2 axis, 2 button joysticks (the default).
=item C<SDL_HINT_GAMECONTROLLERTYPE>
A variable that overrides the automatic controller type detection
The variable should be comma separated entries, in the form: VID/PID=type
The VID and PID should be hexadecimal with exactly 4 digits, e.g. C<0x00fd>
The type should be one of:
=over
=item C<Xbox360>
=item C<XboxOne>
=item C<PS3>
=item C<PS4>
=item C<PS5>
=item C<SwitchPro>
This hint affects what driver is used, and must be set before calling
C<SDL_Init(SDL_INIT_GAMECONTROLLER)>.
=item C<SDL_HINT_GAMECONTROLLERCONFIG_FILE>
A variable that lets you provide a file with extra gamecontroller db entries.
The file should contain lines of gamecontroller config data, see
SDL_gamecontroller.h
This hint must be set before calling C<SDL_Init(SDL_INIT_GAMECONTROLLER)>
You can update mappings after the system is initialized with
C<SDL_GameControllerMappingForGUID( )> and C<SDL_GameControllerAddMapping( )>.
=item C<SDL_HINT_GAMECONTROLLER_IGNORE_DEVICES>
A variable containing a list of devices to skip when scanning for game
controllers.
The format of the string is a comma separated list of USB VID/PID pairs in
hexadecimal form, e.g.
    0xAAAA/0xBBBB,0xCCCC/0xDDDD
The variable can also take the form of @file, in which case the named file will
be loaded and interpreted as the value of the variable.
=item C<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.
The format of the string is a comma separated list of USB VID/PID pairs in
hexadecimal form, e.g.
    0xAAAA/0xBBBB,0xCCCC/0xDDDD
The variable can also take the form of @file, in which case the named file will
be loaded and interpreted as the value of the variable.
=item C<SDL_HINT_GAMECONTROLLER_USE_BUTTON_LABELS>
If set, game controller face buttons report their values according to their
labels instead of their positional layout.
For example, on Nintendo Switch controllers, normally you'd get:
        (Y)
    (X)     (B)
        (A)
but if this hint is set, you'll get:
        (X)
    (Y)     (A)
        (B)
The variable can be set to the following values:
    0   Report the face buttons by position, as though they were on an Xbox controller.
    1   Report the face buttons by label instead of position
The default value is C<1>. This hint may be set at any time.
=item C<SDL_HINT_JOYSTICK_HIDAPI>
A variable controlling whether the HIDAPI joystick drivers should be used.
This variable can be set to the following values:
    0   HIDAPI drivers are not used
    1   HIDAPI drivers are used (the default)
This variable is the default for all drivers, but can be overridden by the
hints for specific drivers below.
=item C<SDL_HINT_JOYSTICK_HIDAPI_PS4>
A variable controlling whether the HIDAPI driver for PS4 controllers should be
used.
This variable can be set to the following values:
    0   HIDAPI driver is not used
    1   HIDAPI driver is used
The default is the value of C<SDL_HINT_JOYSTICK_HIDAPI>
=item C<SDL_HINT_JOYSTICK_HIDAPI_PS4_RUMBLE>
A variable controlling whether extended input reports should be used for PS4
controllers when using the HIDAPI driver.
This variable can be set to the following values:
    0   extended reports are not enabled (default)
    1   extended reports
Extended input reports allow rumble on Bluetooth PS4 controllers, but break
DirectInput handling for applications that don't use SDL.
Once extended reports are enabled, they can not be disabled without power
cycling the controller.
For compatibility with applications written for versions of SDL prior to the
introduction of PS5 controller support, this value will also control the state
of extended reports on PS5 controllers when the
C<SDL_HINT_JOYSTICK_HIDAPI_PS5_RUMBLE> hint is not explicitly set.
=item C<SDL_HINT_JOYSTICK_HIDAPI_PS5>
A variable controlling whether the HIDAPI driver for PS5 controllers should be
used.
This variable can be set to the following values:
    0   HIDAPI driver is not used
    1   HIDAPI driver is used
The default is the value of C<SDL_HINT_JOYSTICK_HIDAPI>.
=item C<SDL_HINT_JOYSTICK_HIDAPI_PS5_RUMBLE>
A variable controlling whether extended input reports should be used for PS5
controllers when using the HIDAPI driver.
This variable can be set to the following values:
    0   extended reports are not enabled (default)
    1   extended reports
Extended input reports allow rumble on Bluetooth PS5 controllers, but break
DirectInput handling for applications that don't use SDL.
Once extended reports are enabled, they can not be disabled without power
cycling the controller.
For compatibility with applications written for versions of SDL prior to the
introduction of PS5 controller support, this value defaults to the value of
C<SDL_HINT_JOYSTICK_HIDAPI_PS4_RUMBLE>.
=item C<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.
This variable can be set to the following values:
    0   player LEDs are not enabled
    1   player LEDs are enabled (default)
=item C<SDL_HINT_JOYSTICK_HIDAPI_STADIA>
A variable controlling whether the HIDAPI driver for Google Stadia controllers
should be used.
This variable can be set to the following values:
    0   HIDAPI driver is not used
    1   HIDAPI driver is used
The default is the value of C<SDL_HINT_JOYSTICK_HIDAPI>.
=item C<SDL_HINT_JOYSTICK_HIDAPI_STEAM>
A variable controlling whether the HIDAPI driver for Steam Controllers should
be used.
This variable can be set to the following values:
    0   HIDAPI driver is not used
    1   HIDAPI driver is used
The default is the value of C<SDL_HINT_JOYSTICK_HIDAPI>.
=item C<SDL_HINT_JOYSTICK_HIDAPI_SWITCH>
A variable controlling whether the HIDAPI driver for Nintendo Switch
controllers should be used.
This variable can be set to the following values:
    0   HIDAPI driver is not used
    1   HIDAPI driver is used
The default is the value of C<SDL_HINT_JOYSTICK_HIDAPI>.
=item C<SDL_HINT_JOYSTICK_HIDAPI_SWITCH_HOME_LED>
A variable controlling whether the Home button LED should be turned on when a
Nintendo Switch controller is opened
This variable can be set to the following values:
    0   home button LED is left off
    1   home button LED is turned on (default)
=item C<SDL_HINT_JOYSTICK_HIDAPI_JOY_CONS>
A variable controlling whether Switch Joy-Cons should be treated the same as
Switch Pro Controllers when using the HIDAPI driver.
This variable can be set to the following values:
    0   basic Joy-Con support with no analog input (default)
    1   Joy-Cons treated as half full Pro Controllers with analog inputs and sensors
This does not combine Joy-Cons into a single controller. That's up to the user.
=item C<SDL_HINT_JOYSTICK_HIDAPI_XBOX>
A variable controlling whether the HIDAPI driver for XBox controllers should be
used.
This variable can be set to the following values:
    0   HIDAPI driver is not used
    1   HIDAPI driver is used
The default is C<0> on Windows, otherwise the value of
C<SDL_HINT_JOYSTICK_HIDAPI>.
=item C<SDL_HINT_JOYSTICK_HIDAPI_CORRELATE_XINPUT>
A variable controlling whether the HIDAPI driver for XBox controllers on
Windows should pull correlated data from XInput.
This variable can be set to the following values:
    0   HIDAPI Xbox driver will only use HIDAPI data
    1   HIDAPI Xbox driver will also pull data from XInput, providing better trigger axes, guide button
        presses, and rumble support
The default is C<1>.  This hint applies to any joysticks opened after setting
the hint.
=item C<SDL_HINT_JOYSTICK_HIDAPI_GAMECUBE>
A variable controlling whether the HIDAPI driver for Nintendo GameCube
controllers should be used.
This variable can be set to the following values:
    0   HIDAPI driver is not used
    1   HIDAPI driver is used
The default is the value of C<SDL_HINT_JOYSTICK_HIDAPI>.
=item C<SDL_HINT_ENABLE_STEAM_CONTROLLERS>
A variable that controls whether Steam Controllers should be exposed using the
SDL joystick and game controller APIs
The variable can be set to the following values:
    0   Do not scan for Steam Controllers
    1   Scan for Steam Controllers (default)
The default value is C<1>.  This hint must be set before initializing the
joystick subsystem.
=item C<SDL_HINT_JOYSTICK_RAWINPUT>
A variable controlling whether the RAWINPUT joystick drivers should be used for
better handling XInput-capable devices.
This variable can be set to the following values:
    0   RAWINPUT drivers are not used
    1   RAWINPUT drivers are used (default)
=item C<SDL_HINT_JOYSTICK_THREAD>
A variable controlling whether a separate thread should be used for handling
joystick detection and raw input messages on Windows
This variable can be set to the following values:
    0   A separate thread is not used (default)
    1   A separate thread is used for handling raw input messages
=item C<SDL_HINT_LINUX_JOYSTICK_DEADZONES>
A variable controlling whether joysticks on Linux adhere to their HID-defined
deadzones or return unfiltered values.
This variable can be set to the following values:
    0   Return unfiltered joystick axis values (default)
    1   Return axis values with deadzones taken into account
=item C<SDL_HINT_ALLOW_TOPMOST>
If set to C<0> then never set the top most bit on a SDL Window, even if the
video mode expects it. This is a debugging aid for developers and not expected
to be used by end users. The default is C<1>.
This variable can be set to the following values:
    0   don't allow topmost
    1   allow topmost (default)
=item C<SDL_HINT_THREAD_PRIORITY_POLICY>
A string specifying additional information to use with
C<SDL_SetThreadPriority>.
By default C<SDL_SetThreadPriority> will make appropriate system changes in
order to apply a thread priority. For example on systems using pthreads the
scheduler policy is changed automatically to a policy that works well with a
given priority. Code which has specific requirements can override SDL's default
behavior with this hint.
pthread hint values are C<current>, C<other>, C<fifo> and C<rr>. Currently no
other platform hint values are defined but may be in the future.
Note:
On Linux, the kernel may send C<SIGKILL> to realtime tasks which exceed the
distro configured execution budget for rtkit. This budget can be queried
through C<RLIMIT_RTTIME> after calling C<SDL_SetThreadPriority( )>.
=item C<SDL_HINT_THREAD_FORCE_REALTIME_TIME_CRITICAL>
Specifies whether C<SDL_THREAD_PRIORITY_TIME_CRITICAL> should be treated as
realtime.
On some platforms, like Linux, a realtime priority thread may be subject to
restrictions that require special handling by the application. This hint exists
to let SDL know that the app is prepared to handle said restrictions.
On Linux, SDL will apply the following configuration to any thread that becomes
realtime:
=over
=item * The SCHED_RESET_ON_FORK bit will be set on the scheduling policy,
=item * An RLIMIT_RTTIME budget will be configured to the rtkit specified limit.
Exceeding this limit will result in the kernel sending C<SIGKILL> to the app,
Refer to the man pages for more information.
=back
This variable can be set to the following values:
    0   default platform specific behaviour
    1   Force SDL_THREAD_PRIORITY_TIME_CRITICAL to a realtime scheduling policy
=item C<SDL_HINT_VIDEO_WINDOW_SHARE_PIXEL_FORMAT>
A variable that is the address of another SDL_Window* (as a hex string
formatted with C<%p>).
If this hint is set before C<SDL_CreateWindowFrom( )> and the C<SDL_Window*> it
is set to has C<SDL_WINDOW_OPENGL> set (and running on WGL only, currently),
then two things will occur on the newly created L<SDL2::Window>:
=over
=item 1. Its pixel format will be set to the same pixel format as this L<SDL2::Window>. This is needed for example when sharing an OpenGL context across multiple windows.
=item 2. The flag C<SDL_WINDOW_OPENGL> will be set on the new window so it can be used for OpenGL rendering.
This variable can be set to the following values:
=over
=item The address (as a string C<%p>) of the L<SDL2::Window> that new windows created with C<SDL_CreateWindowFrom( ... )> should share a pixel format with
=back
=item C<SDL_HINT_ANDROID_TRAP_BACK_BUTTON>
A variable to control whether we trap the Android back button to handle it
manually. This is necessary for the right mouse button to work on some Android
devices, or to be able to trap the back button for use in your code reliably.
If set to true, the back button will show up as an SDL_KEYDOWN / SDL_KEYUP pair
with a keycode of C<SDL_SCANCODE_AC_BACK>.
The variable can be set to the following values:
=over
=item C<0>
Back button will be handled as usual for system. (default)
=item C<1>
Back button will be trapped, allowing you to handle the key press manually.
(This will also let right mouse click work on systems where the right mouse
button functions as back.)
=back
The value of this hint is used at runtime, so it can be changed at any time.
=back
=item C<SDL_HINT_ANDROID_BLOCK_ON_PAUSE>
A variable to control whether the event loop will block itself when the app is
paused.
The variable can be set to the following values:
=over
=item C<0>
Non blocking.
=item C<1>
Blocking. (default)
=back
The value should be set before SDL is initialized.
=back
=item C<SDL_HINT_ANDROID_BLOCK_ON_PAUSE_PAUSEAUDIO>
A variable to control whether SDL will pause audio in background (Requires
C<SDL_ANDROID_BLOCK_ON_PAUSE> as "Non blocking")
The variable can be set to the following values:
=over
=item C<0>
Non paused.
=item C<1>
Paused. (default)
=back
The value should be set before SDL is initialized.
=item C<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.
The variable can be set to the following values:
=over
=item C<0>
The return key will be handled as a key event. This is the behaviour of SDL <=
2.0.3. (default)
=item C<1>
The return key will hide the keyboard.
=back
The value of this hint is used at runtime, so it can be changed at any time.
=item C<SDL_HINT_WINDOWS_FORCE_MUTEX_CRITICAL_SECTIONS>
Force SDL to use Critical Sections for mutexes on Windows. On Windows 7 and
newer, Slim Reader/Writer Locks are available. They offer better performance,
allocate no kernel resources and use less memory. SDL will fall back to
Critical Sections on older OS versions or if forced to by this hint.
This also affects Condition Variables. When SRW mutexes are used, SDL will use
Windows Condition Variables as well. Else, a generic SDL_cond implementation
will be used that works with all mutexes.
This variable can be set to the following values:
=over
=item C<0>
Use SRW Locks when available. If not, fall back to Critical Sections. (default)
=item C<1>
Force the use of Critical Sections in all cases.
=back
=item C<SDL_HINT_WINDOWS_FORCE_SEMAPHORE_KERNEL>
Force SDL to use Kernel Semaphores on Windows. Kernel Semaphores are
inter-process and require a context switch on every interaction. On Windows 8
and newer, the WaitOnAddress API is available. Using that and atomics to
implement semaphores increases performance. SDL will fall back to Kernel
Objects on older OS versions or if forced to by this hint.
This variable can be set to the following values:
=over
=item C<0>
Use Atomics and WaitOnAddress API when available. If not, fall back to Kernel
Objects. (default)
=item C<1>
Force the use of Kernel Objects in all cases.
=back
=item C<SDL_HINT_WINDOWS_USE_D3D9EX>
Use the D3D9Ex API introduced in Windows Vista, instead of normal D3D9.
Direct3D 9Ex contains changes to state management that can eliminate device
loss errors during scenarios like Alt+Tab or UAC prompts. D3D9Ex may require
some changes to your application to cope with the new behavior, so this is
disabled by default.
This hint must be set before initializing the video subsystem.
For more information on Direct3D 9Ex, see:
=over
=item L<https://docs.microsoft.com/en-us/windows/win32/direct3darticles/graphics-apis-in-windows-vista#direct3d-9ex>
=item L<https://docs.microsoft.com/en-us/windows/win32/direct3darticles/direct3d-9ex-improvements>
=back
This variable can be set to the following values:
=over
=item C<0>
Use the original Direct3D 9 API (default)
=item C<1>
Use the Direct3D 9Ex API on Vista and later (and fall back if D3D9Ex is
unavailable)
=back
=item C<SDL_HINT_VIDEO_DOUBLE_BUFFER>
Tell the video driver that we only want a double buffer.
By default, most lowlevel 2D APIs will use a triple buffer scheme that wastes
no CPU time on waiting for vsync after issuing a flip, but introduces a frame
of latency. On the other hand, using a double buffer scheme instead is
recommended for cases where low latency is an important factor because we save
a whole frame of latency. We do so by waiting for vsync immediately after
issuing a flip, usually just after eglSwapBuffers call in the backend's
*_SwapWindow function.
Since it's driver-specific, it's only supported where possible and implemented.
Currently supported the following drivers:
=over
=item KMSDRM (kmsdrm)
=item Raspberry Pi (raspberrypi)
=back
=item C<SDL_HINT_KMSDRM_REQUIRE_DRM_MASTER>
Determines whether SDL enforces that DRM master is required in order to
initialize the KMSDRM video backend.
The DRM subsystem has a concept of a "DRM master" which is a DRM client that
has the ability to set planes, set cursor, etc. When SDL is DRM master, it can
draw to the screen using the SDL rendering APIs. Without DRM master, SDL is
still able to process input and query attributes of attached displays, but it
cannot change display state or draw to the screen directly.
In some cases, it can be useful to have the KMSDRM backend even if it cannot be
used for rendering. An app may want to use SDL for input processing while using
another rendering API (such as an MMAL overlay on Raspberry Pi) or using its
own code to render to DRM overlays that SDL doesn't support.
This hint must be set before initializing the video subsystem.
This variable can be set to the following values:
=over
=item C<0>
SDL will allow usage of the KMSDRM backend without DRM master
=item C<1>
SDL Will require DRM master to use the KMSDRM backend (default)
=back
=item C<SDL_HINT_OPENGL_ES_DRIVER>
A variable controlling what driver to use for OpenGL ES contexts.
On some platforms, currently Windows and X11, OpenGL drivers may support
creating contexts with an OpenGL ES profile. By default SDL uses these
profiles, when available, otherwise it attempts to load an OpenGL ES library,
e.g. that provided by the ANGLE project. This variable controls whether SDL
follows this default behaviour or will always load an OpenGL ES library.
Circumstances where this is useful include
=over
=item Testing an app with a particular OpenGL ES implementation, e.g ANGLE, or emulator, e.g. those from ARM, Imagination or Qualcomm.
=item Resolving OpenGL ES function addresses at link time by linking with the OpenGL ES library instead of querying them at run time with C<SDL_GL_GetProcAddress( )>.
=back
Caution: for an application to work with the default behaviour across different
OpenGL drivers it must query the OpenGL ES function addresses at run time using
C<SDL_GL_GetProcAddress( )>.
This variable is ignored on most platforms because OpenGL ES is native or not
supported.
This variable can be set to the following values:
=over
=item C<0>
Use ES profile of OpenGL, if available. (Default when not set.)
=item C<1>
Load OpenGL ES library using the default library names.
=back
=item C<SDL_HINT_AUDIO_RESAMPLING_MODE>
A variable controlling speed/quality tradeoff of audio resampling.
If available, SDL can use libsamplerate ( http://www.mega-nerd.com/SRC/ ) to
handle audio resampling. There are different resampling modes available that
produce different levels of quality, using more CPU.
If this hint isn't specified to a valid setting, or libsamplerate isn't
available, SDL will use the default, internal resampling algorithm.
Note that this is currently only applicable to resampling audio that is being
written to a device for playback or audio being read from a device for capture.
SDL_AudioCVT always uses the default resampler (although this might change for
SDL 2.1).
This hint is currently only checked at audio subsystem initialization.
This variable can be set to the following values:
=over
=item C<0> or C<default>
Use SDL's internal resampling (Default when not set - low quality, fast)
=item C<1> or C<fast>
Use fast, slightly higher quality resampling, if available
=item C<2> or C<medium>
Use medium quality resampling, if available
=item C<3> or C<best>
Use high quality resampling, if available
=back
=item C<SDL_HINT_AUDIO_CATEGORY>
A variable controlling the audio category on iOS and Mac OS X.
This variable can be set to the following values:
=over
=item C<ambient>
Use the AVAudioSessionCategoryAmbient audio category, will be muted by the
phone mute switch (default)
=item C<playback>
Use the AVAudioSessionCategoryPlayback category
=back
For more information, see Apple's documentation:
L<https://developer.apple.com/library/content/documentation/Audio/Conceptual/AudioSessionProgrammingGuide/AudioSessionCategoriesandModes/AudioSessionCategoriesandModes.html>
=item C<SDL_HINT_RENDER_BATCHING>
A variable controlling whether the 2D render API is compatible or efficient.
This variable can be set to the following values:
=over
=item C<0>
Don't use batching to make rendering more efficient.
=item C<1>
Use batching, but might cause problems if app makes its own direct OpenGL
calls.
=back
Up to SDL 2.0.9, the render API would draw immediately when requested. Now it
batches up draw requests and sends them all to the GPU only when forced to
(during SDL_RenderPresent, when changing render targets, by updating a texture
that the batch needs, etc). This is significantly more efficient, but it can
cause problems for apps that expect to render on top of the render API's
output. As such, SDL will disable batching if a specific render backend is
requested (since this might indicate that the app is planning to use the
underlying graphics API directly). This hint can be used to explicitly request
batching in this instance. It is a contract that you will either never use the
underlying graphics API directly, or if you do, you will call
C<SDL_RenderFlush( )> before you do so any current batch goes to the GPU before
your work begins. Not following this contract will result in undefined
behavior.
=item C<SDL_HINT_AUTO_UPDATE_JOYSTICKS>
A variable controlling whether SDL updates joystick state when getting input
events
This variable can be set to the following values:
=over
=item C<0>
You'll call C<SDL_JoystickUpdate( )> manually
=item C<1>
SDL will automatically call C<SDL_JoystickUpdate( )> (default)
=back
This hint can be toggled on and off at runtime.
=item C<SDL_HINT_AUTO_UPDATE_SENSORS>
A variable controlling whether SDL updates sensor state when getting input
events
This variable can be set to the following values:
=over
=item C<0>
You'll call C<SDL_SensorUpdate ( )> manually
=item C<1>
SDL will automatically call C<SDL_SensorUpdate( )> (default)
=back
This hint can be toggled on and off at runtime.
=item C<SDL_HINT_EVENT_LOGGING>
A variable controlling whether SDL logs all events pushed onto its internal
queue.
This variable can be set to the following values:
=over
=item C<0>
Don't log any events (default)
=item C<1>
Log all events except mouse and finger motion, which are pretty spammy.
=item C<2>
Log all events.
=back
This is generally meant to be used to debug SDL itself, but can be useful for
application developers that need better visibility into what is going on in the
event queue. Logged events are sent through C<SDL_Log( )>, which means by
default they appear on stdout on most platforms or maybe C<OutputDebugString(
)> on Windows, and can be funneled by the app with C<SDL_LogSetOutputFunction(
)>, etc.
This hint can be toggled on and off at runtime, if you only need to log events
for a small subset of program execution.
=item C<SDL_HINT_WAVE_RIFF_CHUNK_SIZE>
Controls how the size of the RIFF chunk affects the loading of a WAVE file.
The size of the RIFF chunk (which includes all the sub-chunks of the WAVE file)
is not always reliable. In case the size is wrong, it's possible to just ignore
it and step through the chunks until a fixed limit is reached.
Note that files that have trailing data unrelated to the WAVE file or corrupt
files may slow down the loading process without a reliable boundary. By
default, SDL stops after 10000 chunks to prevent wasting time. Use the
environment variable SDL_WAVE_CHUNK_LIMIT to adjust this value.
This variable can be set to the following values:
=over
=item C<force>
Always use the RIFF chunk size as a boundary for the chunk search
=item C<ignorezero>
Like "force", but a zero size searches up to 4 GiB (default)
=item C<ignore>
Ignore the RIFF chunk size and always search up to 4 GiB
=item C<maximum>
Search for chunks until the end of file (not recommended)
=back
=item C<SDL_HINT_WAVE_TRUNCATION>
Controls how a truncated WAVE file is handled.
A WAVE file is considered truncated if any of the chunks are incomplete or the
data chunk size is not a multiple of the block size. By default, SDL decodes
until the first incomplete block, as most applications seem to do.
This variable can be set to the following values:
=over
=item C<verystrict>
Raise an error if the file is truncated
=item C<strict>
Like "verystrict", but the size of the RIFF chunk is ignored
=item C<dropframe>
Decode until the first incomplete sample frame
=item C<dropblock>
Decode until the first incomplete block (default)
=back
=item C<SDL_HINT_WAVE_FACT_CHUNK>
Controls how the fact chunk affects the loading of a WAVE file.
The fact chunk stores information about the number of samples of a WAVE file.
The Standards Update from Microsoft notes that this value can be used to
'determine the length of the data in seconds'. This is especially useful for
compressed formats (for which this is a mandatory chunk) if they produce
multiple sample frames per block and truncating the block is not allowed. The
fact chunk can exactly specify how many sample frames there should be in this
case.
Unfortunately, most application seem to ignore the fact chunk and so SDL
ignores it by default as well.
This variable can be set to the following values:
=over
=item C<truncate>
Use the number of samples to truncate the wave data if the fact chunk is
present and valid
=item C<strict>
Like "truncate", but raise an error if the fact chunk is invalid, not present
for non-PCM formats, or if the data chunk doesn't have that many samples
=item C<ignorezero>
Like "truncate", but ignore fact chunk if the number of samples is zero
=item C<ignore>
Ignore fact chunk entirely (default)
=back
=item C<SDL_HINT_DISPLAY_USABLE_BOUNDS>
Override for C<SDL_GetDisplayUsableBounds( )>
If set, this hint will override the expected results for
C<SDL_GetDisplayUsableBounds( )> for display index 0. Generally you don't want
to do this, but this allows an embedded system to request that some of the
screen be reserved for other uses when paired with a well-behaved application.
The contents of this hint must be 4 comma-separated integers, the first is the
bounds x, then y, width and height, in that order.
=item C<SDL_HINT_AUDIO_DEVICE_APP_NAME>
Specify an application name for an audio device.
Some audio backends (such as PulseAudio) allow you to describe your audio
stream. Among other things, this description might show up in a system control
panel that lets the user adjust the volume on specific audio streams instead of
using one giant master volume slider.
This hints lets you transmit that information to the OS. The contents of this
hint are used while opening an audio device. You should use a string that
describes your program ("My Game 2: The Revenge")
Setting this to "" or leaving it unset will have SDL use a reasonable default:
probably the application's name or "SDL Application" if SDL doesn't have any
better information.
On targets where this is not supported, this hint does nothing.
=item C<SDL_HINT_AUDIO_DEVICE_STREAM_NAME>
Specify an application name for an audio device.
Some audio backends (such as PulseAudio) allow you to describe your audio
stream. Among other things, this description might show up in a system control
panel that lets the user adjust the volume on specific audio streams instead of
using one giant master volume slider.
This hints lets you transmit that information to the OS. The contents of this
hint are used while opening an audio device. You should use a string that
describes your what your program is playing ("audio stream" is probably
sufficient in many cases, but this could be useful for something like "team
chat" if you have a headset playing VoIP audio separately).
Setting this to "" or leaving it unset will have SDL use a reasonable default:
"audio stream" or something similar.
On targets where this is not supported, this hint does nothing.
=item C<SDL_HINT_AUDIO_DEVICE_STREAM_ROLE>
Specify an application role for an audio device.
Some audio backends (such as Pipewire) allow you to describe the role of your
audio stream. Among other things, this description might show up in a system
control panel or software for displaying and manipulating media
playback/capture graphs.
This hints lets you transmit that information to the OS. The contents of this
hint are used while opening an audio device. You should use a string that
describes your what your program is playing (Game, Music, Movie, etc...).
Setting this to "" or leaving it unset will have SDL use a reasonable default:
"Game" or something similar.
On targets where this is not supported, this hint does nothing.
=item C<SDL_HINT_ALLOW_ALT_TAB_WHILE_GRABBED>
Specify the behavior of Alt+Tab while the keyboard is grabbed.
By default, SDL emulates Alt+Tab functionality while the keyboard is grabbed
and your window is full-screen. This prevents the user from getting stuck in
your application if you've enabled keyboard grab.
The variable can be set to the following values:
=over
=item C<0>
SDL will not handle Alt+Tab. Your application is responsible for handling
Alt+Tab while the keyboard is grabbed.
=item C<1>
SDL will minimize your window when Alt+Tab is pressed (default)
=back
=item C<SDL_HINT_PREFERRED_LOCALES>
Override for SDL_GetPreferredLocales( )
If set, this will be favored over anything the OS might report for the user's
preferred locales. Changing this hint at runtime will not generate a
SDL_LOCALECHANGED event (but if you can change the hint, you can push your own
event, if you want).
The format of this hint is a comma-separated list of language and locale,
combined with an underscore, as is a common format: "en_GB". Locale is
optional: "en". So you might have a list like this: "en_GB,jp,es_PT"
=back
=head2 C<SDL_HintCallback>
Type definition of the hint callback function.
Parameters to expect:
=over
=item C<userdata> - what was passed as C<userdata> to L<< C<SDL_AddHintCallback( ... )>|/C<SDL_AddHintCallback( ... )> >>
=item C<name> - what was passed as C<name> to L<< C<SDL_AddHintCallback( ... )>|C<SDL_AddHintCallback( ... )> >>
=item C<oldValue> - the previous hint value
=item C<newValue> - the new value hint is to be set to
=back
=head1 LICENSE
Copyright (C) Sanko Robinson.
This library is free software; you can redistribute it and/or modify it under
the terms found in the Artistic License 2. Other copyrights, terms, and
conditions may apply to data transmitted through this module.
=head1 AUTHOR
Sanko Robinson E<lt>sanko@cpan.orgE<gt>
=begin stopwords
iOS bitmap gamepads gamecontroller keycode bitmap libc glibc non OpenGL
ctrl+click screensaver pthread fullscreen XRandR scancode XInput iPhone tvOS
WinRT XBox deadzones pthreads pthread realtime distro XInput-capable rtkit
mutexes vsync lowlevel eglSwapBuffers kmsdrm raspberrypi libsamplerate
AVAudioSessionCategoryAmbient AVAudioSessionCategoryPlayback GiB spammy
verystrict VoIP jp gamepad framebuffer resampler XVidMode letterbox unhandled
asyncify musl
=end stopwords
=cut
};
1;