GameBar GameBar GameBar GameBar Class

Definition

Provides notifications and information about the visibility and input redirection state of Game bar.

public : static class GameBarpublic static class GameBarPublic Static Class GameBar// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10586.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v2)

Remarks

The events and properties of are class static. Objects are not instantiated for this class.

Properties

IsInputRedirected IsInputRedirected IsInputRedirected IsInputRedirected

Indicates whether input is currently redirected to Game bar.

After the user invokes Game bar, input may be redirected to Game bar while the player interacts with it. Games that are no longer receiving input will typically want to pause gameplay or present an idle state. While paused or idle, a best practice is to continue rendering the current frame or scene, so that the recording is smooth and seamless if the player begins recording or is already recording. Multiplayer games might choose to continue gameplay rather than to pause.

To be notified of changes to , handle the IsInputRedirectedChanged event.

public : static PlatForm::Boolean IsInputRedirected { get; }public static bool IsInputRedirected { get; }Public Static ReadOnly Property IsInputRedirected As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

true if input is currently redirected to Game bar; false otherwise.

See Also

Visible Visible Visible Visible

Indicates whether Game bar is currently visible.

Use the property to determine the visibility state of Game bar. Games can choose to pause gameplay or present an idle state when Game bar is visible and being drawn over the game. While paused or idle, a best practice is to continue rendering the current frame or scene, so that the recording is smooth and seamless if the player begins recording or is already recording. Multiplayer games might choose to continue gameplay rather than to pause.

To be notified of changes to , handle the VisibilityChanged event.

public : static PlatForm::Boolean Visible { get; }public static bool Visible { get; }Public Static ReadOnly Property Visible As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

true if Game bar is currently visible; false otherwise.

See Also

Events

IsInputRedirectedChanged IsInputRedirectedChanged IsInputRedirectedChanged IsInputRedirectedChanged

Occurs when input is redirected to Game bar or input is restored to the game.

After the user invokes Game bar, input may be redirected to Game bar while the player interacts with it. Games that are no longer receiving input will typically want to pause gameplay or present an idle state. While paused or idle, a best practice is to continue rendering the current frame or scene, so that the recording is smooth and seamless if the player begins recording or is already recording. Multiplayer games might choose to continue gameplay rather than to pause.

Tip

This event can be raised on background (non-UI) threads. You may need to post an event to the UI thread to perform UI actions.

Use IsInputRedirected to determine whether input is currently redirected to Game bar.

public : static event EventHandler IsInputRedirectedChanged<object>public static event EventHandler IsInputRedirectedChanged<object>Public Static Event IsInputRedirectedChanged<object>// You can use this event in JavaScript.
See Also

VisibilityChanged VisibilityChanged VisibilityChanged VisibilityChanged

Occurs when Game bar is shown or dismissed.

Use the event to monitor the visibility state of Game bar. Games can choose to pause gameplay or present an idle state when Game bar is visible and being drawn over the game. While paused or idle, a best practice is to continue rendering the current frame or scene, so that the recording is smooth and seamless if the player begins recording or is already recording. Multiplayer games might choose to continue gameplay rather than to pause.

Tip

This event can be raised on background (non-UI) threads. You may need to post an event to the UI thread to perform UI actions.

Use Visible to determine whether Game bar is currently visible.

public : static event EventHandler VisibilityChanged<object>public static event EventHandler VisibilityChanged<object>Public Static Event VisibilityChanged<object>// You can use this event in JavaScript.
See Also