IGameInputDevice::GetArcadeStickInfo

ボタンやスティック方向のラベルなど、デバイスのアーケードスティックのプロパティを取得します。

構文

bool GetArcadeStickInfo(
    GameInputArcadeStickInfo* info
);

パラメーター

info _Out_
型: GameInputArcadeStickInfo* デバイスのアーケードスティックのプロパティを受け取る GameInputArcadeStickInfo 構造体へのポインター。デバイスがアーケードスティック入力をサポートしていない場合、構造体のすべてのメンバーは 0 に設定されます。

戻り値

型: bool デバイスがアーケードスティック入力をサポートしていて、info にデータが格納された場合は true。それ以外の場合は false。

解説

GetArcadeStickInfo メソッドは、デバイスのアーケードスティックのプロパティを、呼び出し元が用意した構造体にコピーします。GetSupportedInput から返される値に GameInputKindArcadeStick が含まれている場合、そのデバイスはアーケードスティック入力をサポートしています。デバイスがアーケードスティック入力をサポートしていない場合、GetArcadeStickInfo は info を 0 で初期化し、false を返します。ラベルメンバーは、対応するコントロールに印字されている表示を GameInputLabel 値として記述するため、UI に一致するプロンプトを表示できます。extraButtonCount メンバーと extraAxisCount メンバーは、標準のアーケードスティックマッピングを超えてデバイスが備えているコントローラーのボタンと軸の数を報告します。読み取りのコントローラー状態内でそれらの位置を特定するには、GetExtraButtonIndexes と GetExtraAxisIndexes を使用します。アーケードスティックの状態は、IGameInputReading::GetArcadeStickState を使用して読み取りから取得します。このメソッドによって返されるプロパティはデバイスの有効期間中は固定されているため、一度 (たとえば、デバイスの接続時に) クエリを実行して結果をキャッシュできます。次の例は、デバイスのアーケードスティックのプロパティをクエリする方法を示しています。

GameInputArcadeStickInfo info;
if (device->GetArcadeStickInfo(&info))
{
    GameInputLabel action1 = info.actionButton1Label;
    // ...
}

GameInput v3 以前では、この情報は IGameInputDevice::GetDeviceInfo から返される GameInputDeviceInfo 構造体の arcadeStickInfo メンバーから取得できました。

要件

ヘッダー: GameInput.h ライブラリ: gameinput.lib サポートされているプラットフォーム: Windows、XBOX One ファミリー本体、XBOX Series 本体

バージョン履歴

バージョン	変更内容
v4	導入されました。

Chat API reference

Developer kit only API reference

Graphics API reference

Input API reference

Lighting API reference

Networking API reference

XBOX PC remote iteration API reference

System API reference

Tools API reference

Windows device portal REST API reference

XBOX services API reference

MicrosoftGame.config reference

Additional pages

Reference

Supplemental pages

構文

パラメーター

戻り値

解説

要件

関連項目

バージョン履歴