GameInputFocusPolicy

Enumerates focus policies for an input device.

Syntax

enum GameInputFocusPolicy
{
    GameInputDefaultFocusPolicy             = 0x00000000,
    GameInputExclusiveForegroundInput       = 0x00000002,
    GameInputExclusiveForegroundGuideButton = 0x00000008,
    GameInputExclusiveForegroundShareButton = 0x00000020,
    GameInputEnableBackgroundInput          = 0x00000040,
    GameInputEnableBackgroundGuideButton    = 0x00000080,
    GameInputEnableBackgroundShareButton    = 0x00000100
};

Constants

Constant	Description
GameInputDefaultFocusPolicy	Ensures that input and system buttons is only sent to the process when it is in focus.
GameInputExclusiveForegroundInput	Prevents other processes using GameInput from seeing the input it receives. This restriction is in effect only when the game is in focus and does not apply to system buttons.
GameInputExclusiveForegroundGuideButton	Prevents other processes using GameInput from seeing Guide button presses it receives. This restriction is in effect only when the game is in focus.
GameInputExclusiveForegroundShareButton	Prevents other processes using GameInput from seeing Share button presses it receives. This restriction is in effect only when the game is in focus.
GameInputEnableBackgroundInput	Ensures that input is always sent to the game, even when it is not in focus. This does not include the system buttons, which require using their respective focus policy flags.
GameInputEnableBackgroundGuideButton	Ensures that Guide button events are sent to the game even when not in focus. Guide button presses will still not be sent to the application when the in focus process exclusive access.
GameInputEnableBackgroundShareButton	Ensures that Share button events are sent to the game even when not in focus. Share button presses will still not be sent to the application when the in focus process exclusive access.

Remarks

This enumeration is used by the IGameInput::SetFocusPolicy method. Call SetFocusPolicy to specify whether input is sent to a game when it is not in focus. By default, GameInput will not provide background input. Values may be combined. If the game processes the Guide or Share buttons, setting the GameInputExclusiveForegroundGuideButton or GameInputExclusiveForegroundShareButton flags respectively can help ensure background overlay applications do not also handle them. For example, this can prevent unwanted overlay menus or screenshots from popping up over a game that intends to use the buttons itself.

Many users use overlay applications that use the Guide button for menus and the Share button for screenshots. Consider whether your game has a need to override that functionality to avoid user confusion.

Focus policy only applies on Windows. The Guide and Share button values of GameInputFocusPolicy were added in the Windows SDK 10.0.26031 Preview GameInput.h and will be added to a future release of the GDK. For more information, see GameInput fundamentals.

Requirements

Header: GameInput.h Supported platforms: Windows, XBOX One family consoles and XBOX Series consoles

Version History

Version	Changes
v2	Removed `DisableBackgroundInput` (0x1) and `DisableBackgroundShareButton` (0x10). Added `EnableBackgroundGuideButton` (0x80) and `EnableBackgroundShareButton` (0x100).
v0	Introduced.

Appendix: Previous versions

v0

enum GameInputFocusPolicy
{
    GameInputDefaultFocusPolicy             = 0x00000000,
    GameInputDisableBackgroundInput         = 0x00000001,
    GameInputExclusiveForegroundInput       = 0x00000002,
    GameInputExclusiveForegroundGuideButton = 0x00000008,
    GameInputDisableBackgroundShareButton   = 0x00000010,
    GameInputExclusiveForegroundShareButton = 0x00000020,
    GameInputEnableBackgroundInput          = 0x00000040,
};

Note the DisableBackgroundInput (0x1) and DisableBackgroundShareButton (0x10) flags which were removed in v2. GameInput applications default no background input, so these flags were redundant. The EnableBackgroundGuideButton (0x80) and EnableBackgroundShareButton (0x100) flags were added in v2 to allow applications to register their intent to receive input in the background.

(all) API references

Error codes

Audio API reference

Chat API reference

Developer kit only API reference

Graphics API reference

Input API reference

Lighting API reference

Networking API reference

XBOX PC remote iteration API reference

System API reference

Tools API reference

Windows device portal REST API reference

XBOX services API reference

MicrosoftGame.config reference

GameInputFocusPolicy

GameInputFocusPolicy

Syntax

Constants

Remarks

Requirements

See also

Version History

Appendix: Previous versions

v0

​GameInputFocusPolicy

​Syntax

​Constants

​Remarks

​Requirements

​See also

​Version History

​Appendix: Previous versions

​v0

GameInputFocusPolicy

Syntax

Constants

Remarks

Requirements

See also

Version History

Appendix: Previous versions

v0