GamePadState.IsButtonDown Method

  • Article

Determines whether specified input device buttons are pressed in this GamePadState.

Namespace: Microsoft.Xna.Framework.Input
Assembly: Microsoft.Xna.Framework (in microsoft.xna.framework.dll)

Syntax

public bool IsButtonDown (
         Buttons button
)

Parameters

  • button
    Buttons to query. Specify a single button, or combine multiple buttons using a bitwise OR operation.

Return Value

true if all specified buttons are pressed; false otherwise.

Remarks

For digital buttons (such as A, START, and right bumper) the return value indicates whether the button is pressed.

For analog inputs (triggers and thumbsticks), the return value indicates whether the input exceeds dead zone values. For example, a trigger will not be reported as pressed until it is pulled about 12% of its full range. IsButtonDown always uses the default dead zone processing mode, GamePadDeadZone.IndependentAxes.

If multiple buttons are specified (by combining them using the bitwise OR operator), then all must be pressed (or exceed dead zone values) in order for IsButtonDown to return true.

See Also

Reference

GamePadState Structure
GamePadState Members
Microsoft.Xna.Framework.Input Namespace
GamePadState.IsButtonDown Method
GamePad.GetState Method
GamePadDeadZone

Platforms

Xbox 360, Windows XP SP2, Windows Vista, Zune