Get the state of the mouse

summary

Gets the current state of the mouse. The operation of each button, the position of the mouse, and the amount of rotation of the wheel are displayed.

Operating environment

Prerequisites

Operating environment

How to work with the sample

substance

To get the mouse button press state or mouse position, use the "Mouse.GetState" method. These states are stored in a MouseState structure.

// マウスの状態を取得
this.mouseState = Mouse.GetState();

Mouse.GetState method

Get the position of the mouse, the state of button presses, and so on.

In this sample, the mouse state is displayed in the Draw method, so MouseState is declared as a field.

/// <summary>
/// マウスの状態を記憶
/// </summary>
private MouseState mouseState = Mouse.GetState();

button

You can determine whether a mouse button is pressed by comparing it to the "ButtonState" enumeration. To check if it is pressed, you can compare it with "ButtonState.Pressed", and to check if it is released, you can check with "ButtonState.Released".

// マウスの左ボタン
if (this.mouseState.LeftButton == ButtonState.Pressed)
{
    stateMessage = "Pressed";
}
else
{
    stateMessage = "Released";
}

The following mouse buttons can be used.

• LeftButton
• MiddleButton
• RightButton
• XButton1
• XButton2

location

The position of the mouse can be obtained with "MouseState.X" and "MouseState.Y". This value will be the value with the origin (0,0) at the top left of the screen, and the lower right will be the more positive it is, and the lower left it will be the more negative it will be.

// マウスの位置
this.spriteBatch.DrawString(this.font,
    "Position : " + this.mouseState.X + ", " + this.mouseState.Y,
    new Vector2(40.0f, 150.0f), Color.White);

wheel

The amount of scrolling of the mouse wheel can be obtained with "MouseState.ScrollWheelValue". The scrolling amount is not the amount of rotation at that time, but is added or subtracted from the previous value.

// ホイールの回転量
this.spriteBatch.DrawString(this.font,
    "ScrollWheelValue : " + this.mouseState.ScrollWheelValue,
    new Vector2(40.0f, 175.0f), Color.White);

You can write mouse-related programs on Xbox 360, but you can't use the mouse itself, so you won't be able to get a good value. On Windows Phone, only the LeftButton can be used instead of single-touch.

All Codes

using System;
using System.Collections.Generic;
using System.Linq;
using Microsoft.Xna.Framework;
using Microsoft.Xna.Framework.Audio;
using Microsoft.Xna.Framework.Content;
using Microsoft.Xna.Framework.GamerServices;
using Microsoft.Xna.Framework.Graphics;
using Microsoft.Xna.Framework.Input;
using Microsoft.Xna.Framework.Media;
#if WINDOWS_PHONE
using Microsoft.Xna.Framework.Input.Touch;
#endif

namespace GetMouseState
{
    /// <summary>
    /// ゲームメインクラス
    /// </summary>
    public class GameMain : Microsoft.Xna.Framework.Game
    {
        /// <summary>
        /// グラフィックデバイス管理クラス
        /// </summary>
        private GraphicsDeviceManager graphics = null;

        /// <summary>
        /// スプライトのバッチ化クラス
        /// </summary>
        private SpriteBatch spriteBatch = null;

        /// <summary>
        /// スプライトでテキストを描画するためのフォント
        /// </summary>
        private SpriteFont font = null;

        /// <summary>
        /// マウスの状態を記憶
        /// </summary>
        private MouseState mouseState = Mouse.GetState();


        /// <summary>
        /// GameMain コンストラクタ
        /// </summary>
        public GameMain()
        {
            // グラフィックデバイス管理クラスの作成
            this.graphics = new GraphicsDeviceManager(this);

            // ゲームコンテンツのルートディレクトリを設定
            this.Content.RootDirectory = "Content";

#if WINDOWS_PHONE
            // Windows Phone のデフォルトのフレームレートは 30 FPS
            this.TargetElapsedTime = TimeSpan.FromTicks(333333);

            // バックバッファサイズの設定
            this.graphics.PreferredBackBufferWidth = 480;
            this.graphics.PreferredBackBufferHeight = 800;

            // フルスクリーン表示
            this.graphics.IsFullScreen = true;
#endif

            // ウインドウ上でマウスのポインタを表示するようにする
            this.IsMouseVisible = true;
        }

        /// <summary>
        /// ゲームが始まる前の初期化処理を行うメソッド
        /// グラフィック以外のデータの読み込み、コンポーネントの初期化を行う
        /// </summary>
        protected override void Initialize()
        {
            // TODO: ここに初期化ロジックを書いてください

            // コンポーネントの初期化などを行います
            base.Initialize();
        }

        /// <summary>
        /// ゲームが始まるときに一回だけ呼ばれ
        /// すべてのゲームコンテンツを読み込みます
        /// </summary>
        protected override void LoadContent()
        {
            // テクスチャーを描画するためのスプライトバッチクラスを作成します
            this.spriteBatch = new SpriteBatch(this.GraphicsDevice);

            // フォントをコンテンツパイプラインから読み込む
            this.font = this.Content.Load<SpriteFont>("Font");
        }

        /// <summary>
        /// ゲームが終了するときに一回だけ呼ばれ
        /// すべてのゲームコンテンツをアンロードします
        /// </summary>
        protected override void UnloadContent()
        {
            // TODO: ContentManager で管理されていないコンテンツを
            //       ここでアンロードしてください
        }

        /// <summary>
        /// 描画以外のデータ更新等の処理を行うメソッド
        /// 主に入力処理、衝突判定などの物理計算、オーディオの再生など
        /// </summary>
        /// <param name="gameTime">このメソッドが呼ばれたときのゲーム時間</param>
        protected override void Update(GameTime gameTime)
        {
            // Xbox 360 コントローラ、Windows Phone の BACK ボタンを押したときに
            // ゲームを終了させます
            if (GamePad.GetState(PlayerIndex.One).Buttons.Back == ButtonState.Pressed)
            {
                this.Exit();
            }

            // マウスの状態を取得
            this.mouseState = Mouse.GetState();

            // 登録された GameComponent を更新する
            base.Update(gameTime);
        }

        /// <summary>
        /// 描画処理を行うメソッド
        /// </summary>
        /// <param name="gameTime">このメソッドが呼ばれたときのゲーム時間</param>
        protected override void Draw(GameTime gameTime)
        {
            // 画面を指定した色でクリアします
            this.GraphicsDevice.Clear(Color.CornflowerBlue);

            // スプライトの描画準備
            this.spriteBatch.Begin();

            string stateMessage;

            // マウスの左ボタン
            if (this.mouseState.LeftButton == ButtonState.Pressed)
            {
                stateMessage = "Pressed";
            }
            else
            {
                stateMessage = "Released";
            }
            this.spriteBatch.DrawString(this.font, "LeftButton : " + stateMessage,
                new Vector2(40.0f, 25.0f), Color.White);

            // マウスの右ボタン
            if (this.mouseState.RightButton == ButtonState.Pressed)
            {
                stateMessage = "Pressed";
            }
            else
            {
                stateMessage = "Released";
            }
            this.spriteBatch.DrawString(this.font, "RightButton : " + stateMessage,
                new Vector2(40.0f, 50.0f), Color.White);

            // マウスの中ボタン
            if (this.mouseState.MiddleButton == ButtonState.Pressed)
            {
                stateMessage = "Pressed";
            }
            else
            {
                stateMessage = "Released";
            }
            this.spriteBatch.DrawString(this.font, "MiddleButton : " + stateMessage,
                new Vector2(40.0f, 75.0f), Color.White);

            // マウスのXボタン1
            if (this.mouseState.XButton1 == ButtonState.Pressed)
            {
                stateMessage = "Pressed";
            }
            else
            {
                stateMessage = "Released";
            }
            this.spriteBatch.DrawString(this.font, "XButton1 : " + stateMessage,
                new Vector2(40.0f, 100.0f), Color.White);

            // マウスのXボタン2
            if (this.mouseState.XButton2 == ButtonState.Pressed)
            {
                stateMessage = "Pressed";
            }
            else
            {
                stateMessage = "Released";
            }
            this.spriteBatch.DrawString(this.font, "XButton2 : " + stateMessage,
                new Vector2(40.0f, 125.0f), Color.White);

            // マウスの位置
            this.spriteBatch.DrawString(this.font,
                "Position : " + this.mouseState.X + ", " + this.mouseState.Y,
                new Vector2(40.0f, 150.0f), Color.White);

            // ホイールの回転量
            this.spriteBatch.DrawString(this.font,
                "ScrollWheelValue : " + this.mouseState.ScrollWheelValue,
                new Vector2(40.0f, 175.0f), Color.White);

            // スプライトの一括描画
            this.spriteBatch.End();

            // 登録された DrawableGameComponent を描画する
            base.Draw(gameTime);
        }
    }
}