目次 - SDL 3.0 API(機能別) - ジョイスティック - SDL_GetJoystickPowerInfo

SDL_GetJoystickPowerInfo

ジョイスティックのバッテリー状態を得る

ヘッダ

SDL3/SDL_joystick.h

構文

SDL_PowerState SDL_GetJoystickPowerInfo(SDL_Joystick *joystick, int *percent);

引数

SDL_Joystick *joystick問い合わせるジョイスティック
int *percentバッテリーの残%の代入先へのポインタ. 0から100の間の間で, NULLとして無視することもできる. バッテリー残量が得られない, またはバッテリーが存在しない場合は-1が代入される

戻り値

(SDL_PowerState) 現在のバッテリー状態を戻す. 失敗のときSDL_POWERSTATE_ERRORを戻す. SDL_GetError()を呼んで詳細を知ることができる.

詳細

バッテリー状態を絶対的な真実ととらえてはならない. バッテリー(特に衰えたバッテリー)は不安定で, 報告された値はハードウェアの報告を元にした推定量でしかない. 古くなったバッテリーは報告よりも早く電力を失ったり, 20%ほど残っていると報告されても完全に失われているなどということは珍しいことではない.

スレッドセーフ

この関数はどのスレッドからも安全に呼べる.

バージョン

SDL 3.2.0以降

SDL Wikiへのリンク

SDL_GetJoystickPowerInfo - SDL Wiki