メインコンテンツへスキップ
デバイス上の汎用コントローラー ボタンのラベルを取得します。

構文

パラメーター

labelArrayCount   _In_
型: uint32_t
labelArray の要素数。すべてのコントローラー ボタンのラベルを取得するには、GetControllerButtonCount から返された値を渡します。 labelArray   _Out_writes_to_opt_(labelArrayCount, return)
型: GameInputLabel*
コントローラー ボタンごとに 1 つのラベルを受け取る配列へのポインター。nullptr を指定できます。その場合、何も書き込まれず、メソッドは 0 を返します。

戻り値

型: uint32_t labelArray に書き込まれた要素の数。これは labelArrayCount とデバイス上のコントローラー ボタンのラベル数のうち小さい方の値です。labelArray が nullptr の場合、またはデバイスにコントローラー ボタンのラベルがない場合は 0 です。

解説

各要素は、対応するボタンに印字されている表示 (デバイスが報告する場合) を識別する GameInputLabel 値です。 GetControllerButtonCount を呼び出してコントローラー ボタンのラベル数を取得し、そのサイズの配列を割り当ててから、GetControllerButtonLabels を呼び出して配列にデータを格納します。labelArrayCount がコントローラー ボタンのラベル数より小さい場合は、先頭から labelArrayCount 個の要素のみが書き込まれます。デバイスが接続されている間、デバイスのコントローラー ボタンのラベルは変化しないため、一度クエリを実行して結果をキャッシュできます。 ラベル配列の要素 i は、このデバイスからの読み取りについて IGameInputReading::GetControllerButtonState から返される配列のインデックス i にあるボタンを表します。 次の例は、デバイスのコントローラー ボタンのラベルを取得する方法を示しています。
GameInput v3 以前では、この情報は IGameInputDevice::GetDeviceInfo から返される GameInputDeviceInfo 構造体の controllerInfo メンバーが参照する GameInputControllerInfo 構造体の controllerButtonLabels メンバーから取得できました。

要件

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

関連項目

GameInput の概要
GetControllerButtonCount
GameInputLabel
IGameInputReading::GetControllerButtonState
IGameInputDevice

バージョン履歴

最終更新日 2026年11月6日