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

XInputGetState

関数
指定したXboxコントローラーの現在の入力状態を取得する。
DLLxinput1_4.dll呼出規約winapi

シグネチャ

// xinput1_4.dll
#include <windows.h>

DWORD XInputGetState(
    DWORD dwUserIndex,
    XINPUT_STATE* pState
);

パラメーター

名前方向説明
dwUserIndexDWORDin対象コントローラーのインデックス(0〜3)を指定する。
pStateXINPUT_STATE*outボタン・スティック等の現在状態を受け取るXINPUT_STATE構造体へのポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

// xinput1_4.dll
#include <windows.h>

DWORD XInputGetState(
    DWORD dwUserIndex,
    XINPUT_STATE* pState
);
[DllImport("xinput1_4.dll", ExactSpelling = true)]
static extern uint XInputGetState(
    uint dwUserIndex,   // DWORD
    IntPtr pState   // XINPUT_STATE* out
);
<DllImport("xinput1_4.dll", ExactSpelling:=True)>
Public Shared Function XInputGetState(
    dwUserIndex As UInteger,   ' DWORD
    pState As IntPtr   ' XINPUT_STATE* out
) As UInteger
End Function
' dwUserIndex : DWORD
' pState : XINPUT_STATE* out
Declare PtrSafe Function XInputGetState Lib "xinput1_4" ( _
    ByVal dwUserIndex As Long, _
    ByVal pState As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

XInputGetState = ctypes.windll.xinput1_4.XInputGetState
XInputGetState.restype = wintypes.DWORD
XInputGetState.argtypes = [
    wintypes.DWORD,  # dwUserIndex : DWORD
    ctypes.c_void_p,  # pState : XINPUT_STATE* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('xinput1_4.dll')
XInputGetState = Fiddle::Function.new(
  lib['XInputGetState'],
  [
    -Fiddle::TYPE_INT,  # dwUserIndex : DWORD
    Fiddle::TYPE_VOIDP,  # pState : XINPUT_STATE* out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "xinput1_4")]
extern "system" {
    fn XInputGetState(
        dwUserIndex: u32,  // DWORD
        pState: *mut XINPUT_STATE  // XINPUT_STATE* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("xinput1_4.dll")]
public static extern uint XInputGetState(uint dwUserIndex, IntPtr pState);
"@
$api = Add-Type -MemberDefinition $sig -Name 'xinput1_4_XInputGetState' -Namespace Win32 -PassThru
# $api::XInputGetState(dwUserIndex, pState)
#uselib "xinput1_4.dll"
#func global XInputGetState "XInputGetState" sptr, sptr
; XInputGetState dwUserIndex, varptr(pState)   ; 戻り値は stat
; dwUserIndex : DWORD -> "sptr"
; pState : XINPUT_STATE* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "xinput1_4.dll"
#cfunc global XInputGetState "XInputGetState" int, var
; res = XInputGetState(dwUserIndex, pState)
; dwUserIndex : DWORD -> "int"
; pState : XINPUT_STATE* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD XInputGetState(DWORD dwUserIndex, XINPUT_STATE* pState)
#uselib "xinput1_4.dll"
#cfunc global XInputGetState "XInputGetState" int, var
; res = XInputGetState(dwUserIndex, pState)
; dwUserIndex : DWORD -> "int"
; pState : XINPUT_STATE* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	xinput1_4 = windows.NewLazySystemDLL("xinput1_4.dll")
	procXInputGetState = xinput1_4.NewProc("XInputGetState")
)

// dwUserIndex (DWORD), pState (XINPUT_STATE* out)
r1, _, err := procXInputGetState.Call(
	uintptr(dwUserIndex),
	uintptr(pState),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function XInputGetState(
  dwUserIndex: DWORD;   // DWORD
  pState: Pointer   // XINPUT_STATE* out
): DWORD; stdcall;
  external 'xinput1_4.dll' name 'XInputGetState';
result := DllCall("xinput1_4\XInputGetState"
    , "UInt", dwUserIndex   ; DWORD
    , "Ptr", pState   ; XINPUT_STATE* out
    , "UInt")   ; return: DWORD
●XInputGetState(dwUserIndex, pState) = DLL("xinput1_4.dll", "dword XInputGetState(dword, void*)")
# 呼び出し: XInputGetState(dwUserIndex, pState)
# dwUserIndex : DWORD -> "dword"
# pState : XINPUT_STATE* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "xinput1_4" fn XInputGetState(
    dwUserIndex: u32, // DWORD
    pState: [*c]XINPUT_STATE // XINPUT_STATE* out
) callconv(std.os.windows.WINAPI) u32;
proc XInputGetState(
    dwUserIndex: uint32,  # DWORD
    pState: ptr XINPUT_STATE  # XINPUT_STATE* out
): uint32 {.importc: "XInputGetState", stdcall, dynlib: "xinput1_4.dll".}
pragma(lib, "xinput1_4");
extern(Windows)
uint XInputGetState(
    uint dwUserIndex,   // DWORD
    XINPUT_STATE* pState   // XINPUT_STATE* out
);
ccall((:XInputGetState, "xinput1_4.dll"), stdcall, UInt32,
      (UInt32, Ptr{XINPUT_STATE}),
      dwUserIndex, pState)
# dwUserIndex : DWORD -> UInt32
# pState : XINPUT_STATE* out -> Ptr{XINPUT_STATE}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t XInputGetState(
    uint32_t dwUserIndex,
    void* pState);
]]
local xinput1_4 = ffi.load("xinput1_4")
-- xinput1_4.XInputGetState(dwUserIndex, pState)
-- dwUserIndex : DWORD
-- pState : XINPUT_STATE* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('xinput1_4.dll');
const XInputGetState = lib.func('__stdcall', 'XInputGetState', 'uint32_t', ['uint32_t', 'void *']);
// XInputGetState(dwUserIndex, pState)
// dwUserIndex : DWORD -> 'uint32_t'
// pState : XINPUT_STATE* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("xinput1_4.dll", {
  XInputGetState: { parameters: ["u32", "pointer"], result: "u32" },
});
// lib.symbols.XInputGetState(dwUserIndex, pState)
// dwUserIndex : DWORD -> "u32"
// pState : XINPUT_STATE* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t XInputGetState(
    uint32_t dwUserIndex,
    void* pState);
C, "xinput1_4.dll");
// $ffi->XInputGetState(dwUserIndex, pState);
// dwUserIndex : DWORD
// pState : XINPUT_STATE* out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Xinput1_4 extends StdCallLibrary {
    Xinput1_4 INSTANCE = Native.load("xinput1_4", Xinput1_4.class);
    int XInputGetState(
        int dwUserIndex,   // DWORD
        Pointer pState   // XINPUT_STATE* out
    );
}
@[Link("xinput1_4")]
lib Libxinput1_4
  fun XInputGetState = XInputGetState(
    dwUserIndex : UInt32,   # DWORD
    pState : XINPUT_STATE*   # XINPUT_STATE* out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef XInputGetStateNative = Uint32 Function(Uint32, Pointer<Void>);
typedef XInputGetStateDart = int Function(int, Pointer<Void>);
final XInputGetState = DynamicLibrary.open('xinput1_4.dll')
    .lookupFunction<XInputGetStateNative, XInputGetStateDart>('XInputGetState');
// dwUserIndex : DWORD -> Uint32
// pState : XINPUT_STATE* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function XInputGetState(
  dwUserIndex: DWORD;   // DWORD
  pState: Pointer   // XINPUT_STATE* out
): DWORD; stdcall;
  external 'xinput1_4.dll' name 'XInputGetState';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "XInputGetState"
  c_XInputGetState :: Word32 -> Ptr () -> IO Word32
-- dwUserIndex : DWORD -> Word32
-- pState : XINPUT_STATE* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let xinputgetstate =
  foreign "XInputGetState"
    (uint32_t @-> (ptr void) @-> returning uint32_t)
(* dwUserIndex : DWORD -> uint32_t *)
(* pState : XINPUT_STATE* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library xinput1_4 (t "xinput1_4.dll"))
(cffi:use-foreign-library xinput1_4)

(cffi:defcfun ("XInputGetState" xinput-get-state :convention :stdcall) :uint32
  (dw-user-index :uint32)   ; DWORD
  (p-state :pointer))   ; XINPUT_STATE* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $XInputGetState = Win32::API::More->new('xinput1_4',
    'DWORD XInputGetState(DWORD dwUserIndex, LPVOID pState)');
# my $ret = $XInputGetState->Call($dwUserIndex, $pState);
# dwUserIndex : DWORD -> DWORD
# pState : XINPUT_STATE* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型