Win32 API 日本語リファレンス
ホームUI.Input › RAWMOUSE

RAWMOUSE

構造体
サイズx64: 32 バイト / x86: 24 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールドサイズx64x86説明
usFlagsMOUSE_STATE2+0+0

マウスの状態です。このメンバーには、以下の値の任意の妥当な組み合わせを指定できます。

意味
MOUSE_MOVE_RELATIVE
0x00
マウスの移動データは、直前のマウス位置からの相対値です。マウスの移動の詳細については、後述の「解説」セクションを参照してください。
MOUSE_MOVE_ABSOLUTE
0x01
マウスの移動データは絶対位置に基づきます。マウスの移動の詳細については、後述の「解説」セクションを参照してください。
MOUSE_VIRTUAL_DESKTOP
0x02
マウス座標は仮想デスクトップにマップされます(マルチモニターシステムの場合)。マウスの移動の詳細については、後述の「解説」セクションを参照してください。
MOUSE_ATTRIBUTES_CHANGED
0x04
マウスの属性が変更されました。アプリケーションはマウスの属性を照会する必要があります。
MOUSE_MOVE_NOCOALESCE
0x08
このマウス移動イベントは結合(コアレス)されていません。マウス移動イベントは既定で結合されることがあります。
Windows XP/2000: この値はサポートされていません。
Anonymous_Anonymous_e__Union8/4+8+4ボタン状態を保持する無名共用体である。
ulRawButtonsDWORD4+16+8マウスボタンの生の状態です。Win32 サブシステムはこのメンバーを使用しません。
lLastXINT4+20+12X 方向の移動量です。usFlags の値に応じて、符号付きの相対移動または絶対移動になります。
lLastYINT4+24+16Y 方向の移動量です。usFlags の値に応じて、符号付きの相対移動または絶対移動になります。
ulExtraInformationDWORD4+28+20イベントに関するデバイス固有の追加情報です。詳細については、ペン入力をマウスおよびタッチと区別するを参照してください。

共用体: _Anonymous_e__Union x64 8B / x86 4B

フィールドサイズx64x86説明
ulButtonsDWORD4+0+0予約済みです。
Anonymous_Anonymous_e__Struct8/4+0+0ボタン状態を保持する無名共用体である。

公式ドキュメント

マウスの状態に関する情報を格納します。

解説(Remarks)

MOUSE_MOVE_RELATIVE または MOUSE_MOVE_ABSOLUTE によってマウスが移動したことが示されている場合、lLastXlLastY はその移動に関する情報を指定します。この情報は、相対または絶対の整数値として指定されます。

MOUSE_MOVE_RELATIVE が指定されている場合、lLastXlLastY は直前のマウスイベント(最後に報告された位置)からの相対的な移動量を指定します。正の値はマウスが右(または下)へ移動したことを意味し、負の値はマウスが左(または上)へ移動したことを意味します。

MOUSE_MOVE_ABSOLUTE が指定されている場合、lLastXlLastY には 0 ~ 65,535 の範囲に正規化された絶対座標が格納されます。座標 (0,0) は表示面の左上隅に対応し、座標 (65535,65535) は右下隅に対応します。マルチモニターシステムでは、座標はプライマリモニターにマップされます。

MOUSE_MOVE_ABSOLUTE に加えて MOUSE_VIRTUAL_DESKTOP が指定されている場合、座標は仮想デスクトップ全体にマップされます。

case WM_INPUT:
{
    UINT dwSize = sizeof(RAWINPUT);
    static BYTE lpb[sizeof(RAWINPUT)];

    GetRawInputData((HRAWINPUT)lParam, RID_INPUT, lpb, &dwSize, sizeof(RAWINPUTHEADER));

    RAWINPUT* raw = (RAWINPUT*)lpb;

    if (raw->header.dwType == RIM_TYPEMOUSE)
    {
        RAWMOUSE& mouse = raw->data.mouse;

        if (mouse.usFlags & MOUSE_MOVE_ABSOLUTE)
        {
            RECT rect;
            if (mouse.usFlags & MOUSE_VIRTUAL_DESKTOP)
            {
                rect.left = GetSystemMetrics(SM_XVIRTUALSCREEN);
                rect.top = GetSystemMetrics(SM_YVIRTUALSCREEN);
                rect.right = GetSystemMetrics(SM_CXVIRTUALSCREEN);
                rect.bottom = GetSystemMetrics(SM_CYVIRTUALSCREEN);
            }
            else
            {
                rect.left = 0;
                rect.top = 0;
                rect.right = GetSystemMetrics(SM_CXSCREEN);
                rect.bottom = GetSystemMetrics(SM_CYSCREEN);
            }

            int absoluteX = MulDiv(mouse.lLastX, rect.right, USHRT_MAX) + rect.left;
            int absoluteY = MulDiv(mouse.lLastY, rect.bottom, USHRT_MAX) + rect.top;
            ...
        }
        else if (mouse.lLastX != 0 || mouse.lLastY != 0)
        {
            int relativeX = mouse.lLastX;
            int relativeY = mouse.lLastY;
            ...
        }
        ...
    }

    return 0;
}

従来の WM_MOUSEMOVE ウィンドウメッセージとは異なり、Raw Input のマウスイベントは、コントロールパネルのマウスのプロパティシートで設定されたマウス速度の影響を受けません。詳細については、マウス入力の概要を参照してください。

usButtonFlagsRI_MOUSE_WHEEL または RI_MOUSE_HWHEEL によってマウスホイールが回転したことが示されている場合、usButtonData にはホイールの回転量を指定する符号付き short 値が格納されます。

ホイールの回転量は、120 に設定されている WHEEL_DELTA の倍数になります。これはアクションを実行するためのしきい値であり、デルタごとに 1 回のアクション(たとえば 1 単位分のスクロール)を行うべきです。

デルタが 120 に設定されているのは、Microsoft や他のベンダーが、より高分解能のホイール(ノッチのない自由回転式ホイール)を作成し、1 回転あたりより多くのメッセージを、各メッセージにはより小さい値を入れて送信できるようにするためです。この機能を使用するには、受信したデルタ値を WHEEL_DELTA に達するまで加算する(これにより 1 デルタ分の回転に対して同じ応答が得られます)か、より頻繁なメッセージに応じて行の一部をスクロールします。また、独自のスクロール粒度を選択し、それに達するまでデルタを蓄積することもできます。

アプリケーションは、SystemParametersInfo API に SPI_GETWHEELSCROLLLINES または SPI_GETWHEELSCROLLCHARS パラメーターを指定して、現在のユーザー設定のスクロール行数やスクロール文字数を取得することもできます。

このようなホイール処理コードの例を次に示します。

RAWMOUSE& mouse = raw->data.mouse;

if ((mouse.usButtonFlags & RI_MOUSE_WHEEL) || (mouse.usButtonFlags & RI_MOUSE_HWHEEL))
{
    short wheelDelta = (short)mouse.usButtonData;
    float scrollDelta = (float)wheelDelta / WHEEL_DELTA;

    if (mouse.usButtonFlags & RI_MOUSE_HWHEEL) // Horizontal
    {
        unsigned long scrollChars = 1; // 1 is the default
        SystemParametersInfo(SPI_GETWHEELSCROLLCHARS, 0, &scrollChars, 0);
        scrollDelta *= scrollChars;
        ...
    }
    else // Vertical
    {
        unsigned long scrollLines = 3; // 3 is the default
        SystemParametersInfo(SPI_GETWHEELSCROLLLINES, 0, &scrollLines, 0);
        if (scrollLines != WHEEL_PAGESCROLL)
            scrollDelta *= scrollLines;
        ...
    }
}
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での定義

#include <windows.h>

// RAWMOUSE  (x64 32 / x86 24 バイト)
typedef struct RAWMOUSE {
    MOUSE_STATE usFlags;
    _Anonymous_e__Union Anonymous;
    DWORD ulRawButtons;
    INT lLastX;
    INT lLastY;
    DWORD ulExtraInformation;
} RAWMOUSE;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct RAWMOUSE
{
    public ushort usFlags;
    public _Anonymous_e__Union Anonymous;
    public uint ulRawButtons;
    public int lLastX;
    public int lLastY;
    public uint ulExtraInformation;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure RAWMOUSE
    Public usFlags As UShort
    Public Anonymous As _Anonymous_e__Union
    Public ulRawButtons As UInteger
    Public lLastX As Integer
    Public lLastY As Integer
    Public ulExtraInformation As UInteger
End Structure
import ctypes
from ctypes import wintypes

class RAWMOUSE(ctypes.Structure):
    _fields_ = [
        ("usFlags", ctypes.c_ushort),
        ("Anonymous", _Anonymous_e__Union),
        ("ulRawButtons", wintypes.DWORD),
        ("lLastX", ctypes.c_int),
        ("lLastY", ctypes.c_int),
        ("ulExtraInformation", wintypes.DWORD),
    ]
#[repr(C)]
pub struct RAWMOUSE {
    pub usFlags: u16,
    pub Anonymous: _Anonymous_e__Union,
    pub ulRawButtons: u32,
    pub lLastX: i32,
    pub lLastY: i32,
    pub ulExtraInformation: u32,
}
import "golang.org/x/sys/windows"

type RAWMOUSE struct {
	usFlags uint16
	Anonymous _Anonymous_e__Union
	ulRawButtons uint32
	lLastX int32
	lLastY int32
	ulExtraInformation uint32
}
type
  RAWMOUSE = record
    usFlags: Word;
    Anonymous: _Anonymous_e__Union;
    ulRawButtons: DWORD;
    lLastX: Integer;
    lLastY: Integer;
    ulExtraInformation: DWORD;
  end;
const RAWMOUSE = extern struct {
    usFlags: u16,
    Anonymous: _Anonymous_e__Union,
    ulRawButtons: u32,
    lLastX: i32,
    lLastY: i32,
    ulExtraInformation: u32,
};
type
  RAWMOUSE {.bycopy.} = object
    usFlags: uint16
    Anonymous: _Anonymous_e__Union
    ulRawButtons: uint32
    lLastX: int32
    lLastY: int32
    ulExtraInformation: uint32
struct RAWMOUSE
{
    ushort usFlags;
    _Anonymous_e__Union Anonymous;
    uint ulRawButtons;
    int lLastX;
    int lLastY;
    uint ulExtraInformation;
}

HSP用 定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; RAWMOUSE サイズ: 24 バイト(x86)
dim st, 6    ; 4byte整数×6(構造体サイズ 24 / 4 切り上げ)
; usFlags : MOUSE_STATE (+0, 2byte)  wpoke st,0,値  /  値 = wpeek(st,0)
; Anonymous : _Anonymous_e__Union (+4, 4byte)  varptr(st)+4 を基点に操作(4byte:入れ子/配列)
; ulRawButtons : DWORD (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; lLastX : INT (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; lLastY : INT (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; ulExtraInformation : DWORD (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; RAWMOUSE サイズ: 32 バイト(x64)
dim st, 8    ; 4byte整数×8(構造体サイズ 32 / 4 切り上げ)
; usFlags : MOUSE_STATE (+0, 2byte)  wpoke st,0,値  /  値 = wpeek(st,0)
; Anonymous : _Anonymous_e__Union (+8, 8byte)  varptr(st)+8 を基点に操作(8byte:入れ子/配列)
; ulRawButtons : DWORD (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; lLastX : INT (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; lLastY : INT (+24, 4byte)  st.6 = 値  /  値 = st.6   (lpoke/lpeek も可)
; ulExtraInformation : DWORD (+28, 4byte)  st.7 = 値  /  値 = st.7   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global RAWMOUSE
    #field short usFlags
    #field byte Anonymous 8
    #field int ulRawButtons
    #field int lLastX
    #field int lLastY
    #field int ulExtraInformation
#endstruct

stdim st, RAWMOUSE        ; NSTRUCT 変数を確保
st->usFlags = 100
mes "usFlags=" + st->usFlags
; ※union フィールドは byte 列で確保(NSTRUCT は union 非対応)。必要に応じ手動でアクセス。