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

RAWINPUTDEVICE

構造体
サイズx64: 16 バイト / x86: 12 バイト

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

フィールド

フィールドサイズx64x86説明
usUsagePageWORD2+0+0Raw Input デバイスのトップレベル コレクションUsage page です。指定できる値の詳細については、Windows でサポートされている HID クライアントを参照してください。
usUsageWORD2+2+2Raw Input デバイスのトップレベル コレクションUsage ID です。指定できる値の詳細については、Windows でサポートされている HID クライアントを参照してください。
dwFlagsRAWINPUTDEVICE_FLAGS4+4+4

usUsagePageusUsage で提供される情報をどのように解釈するかを指定するモード フラグです。0 (既定値) または以下のいずれかの値を指定できます。既定では、オペレーティング システムは、登録されたアプリケーションがウィンドウ フォーカスを持っている間、指定されたトップレベル コレクション (TLC) を持つデバイスからの Raw Input をそのアプリケーションに送信します。

意味
RIDEV_REMOVE
0x00000001
設定すると、トップレベル コレクションを包含リストから削除します。これは、そのトップレベル コレクションに一致するデバイスからの読み取りを停止するようオペレーティング システムに指示します。
RIDEV_EXCLUDE
0x00000010
設定すると、Usage page 全体を読み取る際に除外するトップレベル コレクションを指定します。このフラグは、Usage page が既に RIDEV_PAGEONLY で指定されている TLC にのみ影響します。
RIDEV_PAGEONLY
0x00000020
設定すると、トップレベル コレクションが指定した usUsagePage に属するすべてのデバイスを指定します。usUsage は 0 でなければならないことに注意してください。特定のトップレベル コレクションを除外するには、RIDEV_EXCLUDE を使用します。
RIDEV_NOLEGACY
0x00000030
設定すると、usUsagePage または usUsage で指定されたデバイスがレガシー メッセージを生成しないようにします。これはマウスとキーボードにのみ適用されます。「解説」を参照してください。
RIDEV_INPUTSINK
0x00000100
設定すると、呼び出し元がフォアグラウンドにない場合でも入力を受け取れるようになります。hwndTarget を指定する必要があることに注意してください。
RIDEV_CAPTUREMOUSE
0x00000200
設定すると、マウス ボタンのクリックによって他のウィンドウがアクティブ化されなくなります。RIDEV_CAPTUREMOUSE は、マウス デバイスに対して RIDEV_NOLEGACY が指定されている場合にのみ指定できます。
RIDEV_NOHOTKEYS
0x00000200
設定すると、アプリケーション定義のキーボード デバイスのホットキーは処理されません。ただし、ALT+TAB や CTRL+ALT+DEL などのシステム ホットキーは引き続き処理されます。既定では、すべてのキーボード ホットキーが処理されます。RIDEV_NOHOTKEYS は、RIDEV_NOLEGACY が指定されておらず hwndTargetNULL の場合でも指定できます。
RIDEV_APPKEYS
0x00000400
設定すると、アプリケーション コマンド キーが処理されます。RIDEV_APPKEYS は、キーボード デバイスに対して RIDEV_NOLEGACY が指定されている場合にのみ指定できます。
RIDEV_EXINPUTSINK
0x00001000
設定すると、フォアグラウンドのアプリケーションが入力を処理しない場合に限り、呼び出し元がバックグラウンドで入力を受け取れるようになります。つまり、フォアグラウンドのアプリケーションが Raw Input に登録されていない場合、登録されているバックグラウンドのアプリケーションが入力を受け取ります。
Windows XP: このフラグは Windows Vista 以降でサポートされます。
RIDEV_DEVNOTIFY
0x00002000
設定すると、デバイスの接続および取り外しに関する WM_INPUT_DEVICE_CHANGE 通知を呼び出し元が受け取れるようになります。
Windows XP: このフラグは Windows Vista 以降でサポートされます。
hwndTargetHWND8/4+8+8ターゲット ウィンドウへのハンドル。NULL の場合、Raw Input イベントはキーボード フォーカスに従うため、フォーカスを持つアプリケーション ウィンドウだけがイベントを受け取ります。

公式ドキュメント

Raw Input デバイスの情報を定義します。

解説(Remarks)

マウスまたはキーボードに対して RIDEV_NOLEGACY が設定されている場合、システムはそのデバイスに関するレガシー メッセージをアプリケーションに対して生成しません。たとえば、マウスの TLC に RIDEV_NOLEGACY が設定されていると、WM_LBUTTONDOWN および関連するレガシー マウス メッセージは生成されません。同様に、キーボードの TLC に RIDEV_NOLEGACY が設定されていると、WM_KEYDOWN および関連するレガシー キーボード メッセージは生成されません。

RIDEV_REMOVE が設定され、かつ hwndTarget メンバーが NULL に設定されていない場合、RegisterRawInputDevices 関数は失敗します。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での定義

#include <windows.h>

// RAWINPUTDEVICE  (x64 16 / x86 12 バイト)
typedef struct RAWINPUTDEVICE {
    WORD usUsagePage;
    WORD usUsage;
    RAWINPUTDEVICE_FLAGS dwFlags;
    HWND hwndTarget;
} RAWINPUTDEVICE;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct RAWINPUTDEVICE
{
    public ushort usUsagePage;
    public ushort usUsage;
    public uint dwFlags;
    public IntPtr hwndTarget;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure RAWINPUTDEVICE
    Public usUsagePage As UShort
    Public usUsage As UShort
    Public dwFlags As UInteger
    Public hwndTarget As IntPtr
End Structure
import ctypes
from ctypes import wintypes

class RAWINPUTDEVICE(ctypes.Structure):
    _fields_ = [
        ("usUsagePage", ctypes.c_ushort),
        ("usUsage", ctypes.c_ushort),
        ("dwFlags", wintypes.DWORD),
        ("hwndTarget", ctypes.c_void_p),
    ]
#[repr(C)]
pub struct RAWINPUTDEVICE {
    pub usUsagePage: u16,
    pub usUsage: u16,
    pub dwFlags: u32,
    pub hwndTarget: *mut core::ffi::c_void,
}
import "golang.org/x/sys/windows"

type RAWINPUTDEVICE struct {
	usUsagePage uint16
	usUsage uint16
	dwFlags uint32
	hwndTarget uintptr
}
type
  RAWINPUTDEVICE = record
    usUsagePage: Word;
    usUsage: Word;
    dwFlags: DWORD;
    hwndTarget: Pointer;
  end;
const RAWINPUTDEVICE = extern struct {
    usUsagePage: u16,
    usUsage: u16,
    dwFlags: u32,
    hwndTarget: ?*anyopaque,
};
type
  RAWINPUTDEVICE {.bycopy.} = object
    usUsagePage: uint16
    usUsage: uint16
    dwFlags: uint32
    hwndTarget: pointer
struct RAWINPUTDEVICE
{
    ushort usUsagePage;
    ushort usUsage;
    uint dwFlags;
    void* hwndTarget;
}

HSP用 定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; RAWINPUTDEVICE サイズ: 12 バイト(x86)
dim st, 3    ; 4byte整数×3(構造体サイズ 12 / 4 切り上げ)
; usUsagePage : WORD (+0, 2byte)  wpoke st,0,値  /  値 = wpeek(st,0)
; usUsage : WORD (+2, 2byte)  wpoke st,2,値  /  値 = wpeek(st,2)
; dwFlags : RAWINPUTDEVICE_FLAGS (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; hwndTarget : HWND (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; RAWINPUTDEVICE サイズ: 16 バイト(x64)
dim st, 4    ; 4byte整数×4(構造体サイズ 16 / 4 切り上げ)
; usUsagePage : WORD (+0, 2byte)  wpoke st,0,値  /  値 = wpeek(st,0)
; usUsage : WORD (+2, 2byte)  wpoke st,2,値  /  値 = wpeek(st,2)
; dwFlags : RAWINPUTDEVICE_FLAGS (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; hwndTarget : HWND (+8, 8byte)  qpoke st,8,値 / qpeek(st,8)  ※IronHSPのみ。3.7/3.8は lpoke st,8,下位 : lpoke st,12,上位
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global RAWINPUTDEVICE
    #field short usUsagePage
    #field short usUsage
    #field int dwFlags
    #field intptr hwndTarget
#endstruct

stdim st, RAWINPUTDEVICE        ; NSTRUCT 変数を確保
st->usUsagePage = 100
mes "usUsagePage=" + st->usUsagePage