多数のユーティリティ機能へのアクセスを許可するインターフェイスです。

メンバー関数

ISteamUtilsのメンバー関数は、グローバルのアクセサ関数SteamUtils()経由で呼び出されます。

BOverlayNeedsPresent

オーバーレイが存在する必要があるかを確認します。 イベントドリブンのレンダーアップデートにのみ必要とされます。

ほとんどのゲームのように、フレームごとにD3D Present APIまたはOGL SwapBuffers APIを呼び出すためのフレームループが常時実行されている場合、このコールは不要です。 しかし、スクリーンをイベントドリブンでのみリフレッシュするゲームの場合、イベントによってオーバーレイが壊れる可能性があります。これは、内部フレームループの駆動にPresent/SwapBuffersコールを使用し、通知があるときやユーザーがオーバーレイを呼び出したときには画面にPresent()オーバーレイを必要とするためです。 You can use this API to ask the overlay if it currently need a present in that case, and then you can check for this periodically (roughly 33hz is desirable) and make sure you refresh the screen with Present or SwapBuffers to allow the overlay to do its work.

戻り値： bool
true となるのはオーバーレイが画面を更新する必要があるときのみで、それ以外はfalseです。

CheckFileSignature

名前	型	説明
szFileName	const char *	.

推奨されていません。

戻り値： SteamAPICall_tはCheckFileSignature_t呼び出し結果と使われます。

GetAPICallFailureReason

名前	型	説明
hSteamAPICall	SteamAPICall_t	失敗を確認するSteam APIコールハンドル。

呼び出し結果の失敗理由の取得に使用します。

この関数の主な用途はデバッグです。 失敗理由は通常、あなたがコントロールできない部分であり、ほとんどの場合重要ではありません。 機能するまでAPIコールを再試行してください。

戻り値： ESteamAPICallFailure
[type]ESteamAPICallFailure[/type]

こちらも参照してください： ISteamUtils::IsAPICallCompleted, ISteamUtils::GetAPICallResult

例：

GetAPICallResult

名前	型	説明
hSteamAPICall	SteamAPICall_t	APIコールのハンドル。
pCallback	void *	提供された事前に割り当てられたメモリに、コールバックを返します。
cubCallback	int	渡されるpCallbackのサイズ。
iCallbackExpected	int	コールバックに関連するk_iCallbackの数。
pbFailed	bool *	APIが失敗となった場合に返します。

完了したAPIコールのコンテンツを取得します。 CallResultラッパーのバックエンドに提供されます。

これを手動で使用することは一般的に推奨されません。

戻り値： bool
true となるのはAPIコールが有効で完了した場合のみで、それ以外はfalseです。

呼び出しが成功するとコールバックをpCallbackにコピーし、失敗するとpbFailedを返します。

こちらも参照してください： ISteamUtils::IsAPICallCompleted, ISteamUtils::GetAPICallFailureReason

GetAppID

現在のプロセスのAppIDを取得します。

戻り値： uint32
AppIdを返します。

GetConnectedUniverse

現在クライアントが接続しているユニバースを取得します。 （Valveのみ使用。）

戻り値： EUniverse
[type]EUniverse[/type]

GetCSERIPPort

名前	型	説明
unIP	uint32 *	クライアントが接続しているIPを返します。
usPort	uint16 *	クライアントが接続しているポートを返します。

Valve向けの報告サーバーのIPを取得します。現在はSource Engineゲームのみで使用されています。

戻り値： bool
ユーザーが現在接続されていればtrueを返し、それ以外の場合はfalseを返します。

GetCurrentBatteryPower

コンピューターの現在の電源量を取得します。

戻り値： uint8
現在の電源の範囲[0から100の間]%。 ユーザーがAC電源を使用している場合には255を返します。

GetEnteredGamepadTextInput

名前	型	説明
pchText	char *	テキスト入力文字列をコピーする事前に割り当てられたバッファー。
cchText	uint32	pchTextバッファーのサイズ。

Big Pictureオーバレイからのゲームパッドテキスト入力を取得します。

これはGamepadTextInputDismissed_t.m_bSubmittedがtrueである場合にのみ、GamepadTextInputDismissed_tコールバック内で呼び出される必要があります。

テキスト入力をUTF-8で提供します。

戻り値： bool
true となるのは受け取るテキストがありcchTextのサイズがGamepadTextInputDismissed_t.m_unSubmittedTextと同じ場合のみで、それ以外はfalseです。

こちらも参照してください： ISteamUtils::ShowGamepadTextInput, ISteamUtils::GetEnteredGamepadTextLength

例：

GetEnteredGamepadTextLength

Big Pictureオーバレイからのゲームパッドテキスト入力の長さを取得します。

これはGamepadTextInputDismissed_t.m_bSubmittedがtrueである場合にのみ、GamepadTextInputDismissed_tコールバック内で呼び出される必要があります。

戻り値： uint32


こちらも参照してください： ISteamUtils::ShowGamepadTextInput, ISteamUtils::GetEnteredGamepadTextInput

例：

GetImageRGBA

名前	型	説明
iImage	int	取得されるイメージへのハンドル。
pubDest	uint8 *	使用されるバッファー。
nDestBufferSize	int	pubDestバッファーの合計サイズ。

イメージハンドルからの画像バイト数を取得します。

これを呼び出す前にISteamUtils::GetImageSizeを世帯出してイメージのサイズを取得して、適切なサイズのバッファ―を作成できるようにしておきます。 そして、バッファーに幅と高さを次のように割り当てます：width * height * 4 イメージはRGBAフォーマットで提供されます。 このコールは圧縮タイプ（JPG、PNG、TGA）から変換するためコストがかかり、返されたバッファーの内部キャッシュを提供することはありませんので、これを呼び出すのはイメージごとに一度にとどめ、結果をキャッシュすることが推奨されます。 この関数はSteamアバターと実績画像、およびゲームの途中で変更が想定されていないものにのみ、使用されます。

戻り値： bool
true となるのはイメージハンドルが有効でバッファーが入力されており成功した場合で、それ以外はfalseです。

こちらも参照してください： ISteamFriends::GetSmallFriendAvatar、ISteamFriends::GetMediumFriendAvatar、ISteamFriends::GetLargeFriendAvatar、ISteamUserStats::GetAchievementIcon

例：

GetImageSize

名前	型	説明
iImage	int	サイズを取得するイメージハンドル。
pnWidth	uint32 *	イメージの幅を返します。
pnHeight	uint32 *	イメージの高さを返します。

Steamイメージハンドルのサイズを取得します。

未加工のイメージデータを入力するための適切なサイズのバッファーを作成するには、ISteamUtils::GetImageRGBAを呼び出す前に必ず、これを呼び出す必要があります。

戻り値： bool
true となるのはイメージハンドルが有効でサイズが入力されており成功した場合で、それ以外はfalseです。

こちらも参照してください： ISteamFriends::GetSmallFriendAvatar、ISteamFriends::GetMediumFriendAvatar、ISteamFriends::GetLargeFriendAvatar、ISteamUserStats::GetAchievementIcon

GetIPCCallCount

この関数が最後に呼び出されて以降、作成されたプロセス間通信コールの数を返します。

パフォーマンスデバッグに使用され、フレームごとにゲームがプロセス間通信コールを何回作成するかが分かります。
すべてのプロセス間通信コールは、最低でも単一スレッドのコンテキストスイッチですが、そうでない場合にはその頻度をレート制限するプロセスの必要があります。

戻り値： uint32

GetIPCountry

クライアントが実行している国を、 ISO 3166-1-alpha-2 形式の2桁の国コードで返します。
例 ："US"や"UK"

これはロケーションへのIPデータベース経由で検索されます。

戻り値： const char *

GetSecondsSinceAppActive

アプリケーションがアクティブになってからの時間を秒数で返します。

戻り値： uint32

GetSecondsSinceComputerActive

ユーザーが最後にマウスを動かしてからの時間を秒数で返します。

戻り値： uint32

GetServerRealTime

Steamサーバー時間をUnixエポック形式で返します。 （1970年1月1日UTCからの時間を秒単位で）

戻り値： uint32

GetSteamUILanguage

Steamクライアントが実行している言語を返します。

これは特別なケースでのみ使用されるべきなので、代わりに ISteamApps::GetCurrentGameLanguageを使用してください。

言語の完全なリストはサポート言語を参照してください。

戻り値： const char *


こちらも参照してください： ISteamApps::GetCurrentGameLanguage、ISteamApps::GetAvailableGameLanguages

IsAPICallCompleted

名前	型	説明
hSteamAPICall	SteamAPICall_t	確認するAPI呼び出しハンドル。
pbFailed	bool *	そのAPI呼び出しが失敗した（true）か、またはそうでない（false）かを返します。

API呼び出しが完了したかを確認します。 CallResultラッパーのバックエンドに提供します。

一般的に、これの使用は推奨されません。

戻り値： bool
true となるのは、API呼び出しが有効で完了した場合のみで、それ以外はfalseです。

こちらも参照してください： ISteamUtils::GetAPICallResult、ISteamUtils::GetAPICallFailureReason

IsOverlayEnabled

Steamオーバレイが実行中で、ユーザーがアクセスできることを確認します。

オーバーレイプロセスを開始してゲームプロセスにフックするためには数秒間かかります。そのため、この関数はオーバーレイがロードしている間の最初の呼び出しにはfalseを返します。

戻り値： bool

IsSteamChinaLauncher

現在のランチャーがSteam Chinaランチャーかどうかを返します。 Steamを実行中にコマンドライン-dev -steamchinaを加えることで、クライアントをSteam Chinaランチャーとして起動できます。

InitFilterText

テキストフィルタリングを初期化し、ゲームが実行されている言語の辞書を読み込みます。

ユーザーは、Steamアカウント設定から、テキストフィルターの動作をカスタマイズできます。

戻り値： bool
true は初期化が成功した場合、falseはゲームの言語でフィルタリングが利用できない場合です。後者の場合ISteamUtils::FilterText()がパススルーとして機能します。

こちらも参照してください： ISteamUtils::FilterText

FilterText

名前	型	説明
eContext	ETextFilteringContext	入力文字列内のコンテンツのタイプ
sourceSteamID	CSteamID	入力文字列のソースであるSteam ID（例えば、名前のあるプレイヤー、またはチャットテキストを発言したプレイヤー）
pchInputText	const char*	フィルタリングする必要のある入力文字列、ASCIIまたはUTF-8が可能。
pchOutFilteredText	char*	フィルタリングが実行されていない場合でも、出力が配置される場所
nByteSizeOutFilteredText	uint32	pchOutFilteredTextのサイズ（バイト単位）は、少なくともstrlen(pchInputText)+1である必要があります。

入力されたメッセージをフィルタリングし、フィルタリングされた結果をpchOutFilteredTextに配置します。 法的に必要なフィルタリングは常に適用されます。 コンテキストとユーザー設定に基づいて、追加のフィルタリングが実行される場合があります。

戻り値： int
フィルタリングされた文字数（バイト数ではない）を返します。

こちらも参照してください： ISteamUtils::InitFilterText

IsSteamInBigPictureMode

SteamとSteamオーバーレイがBig Pictureモードで実行されていることを確認します。

Big Pictureオーバーレイを有効にするには、Steamクライアントからゲームを起動する必要があります。
開発中にゲームを非Steamゲームとして開発者のライブラリに追加して、この機能をテストすることができます。

戻り値： bool
true はBig Pictureオーバーレイが利用可能なとき、それ以外はfalse。
ゲームのアプリケーションタイプが「game」でない場合は必ずfalseを返します。

IsSteamRunningInVR

SteamがVRモードで実行されているかを確認します。

戻り値： bool
true はSteam自体がVRモードで実行中の場合、それ例外はfalse。

IsVRHeadsetStreamingEnabled

HMDビューがSteam Remote Playを介してストリーミングされているかどうかを確認します。

戻り値： bool
true はVRが有効化され、かつHMDビューが現在ストリーミングされている場合、それ以外はfalse。

こちらも参照してください： ISteamUtils::SetVRHeadsetStreamingEnabled

IsSteamRunningOnSteamDeck

SteamがSteam Deckデバイス上で実行されているか確認します。

戻り値： bool
true は、Steam自体がSteam Deckデバイス上で実行中の場合、それ以外はfalse。

SetOverlayNotificationInset

名前	型	説明
nHorizontalInset	int	隅からのピクセル単位での水平（左右）の距離。
nVerticalInset	int	隅からのピクセル単位での垂直（上下）の距離。

ISteamUtils::SetOverlayNotificationPositionで指定された隅からのオーバレイ通知のインセットを設定します。

(0, 0)値は、位置を隅にリセットします。

この位置はゲームごとで、各起動時にリセットされます。

SetOverlayNotificationPosition

名前	型	説明
eNotificationPosition	ENotificationPosition

Steamオーバーレイ通知ポップアップをどの隅に表示するかを設定します。

ISteamUtils::SetOverlayNotificationInsetを使用して、指定した隅からの距離を設定できます。

この位置はゲームごとで、各起動時にリセットされます。

SetVRHeadsetStreamingEnabled

名前	型	説明
bEnabled	bool	VR HMDストリーミングをオン（true）またはオフ（false）にします。

HMDコンテンツがSteam Remote Playを介してストリーミングされるかを設定します。

有効な場合、HMDヘッドセット内のシーンがストリーミングされ、リモート入力が許可されなくなります。 それ以外の場合は無効となり、代わりにアプリケーションウィンドウがストリーミングされ、リモート入力は許可されます。 "VRHeadsetStreaming" "0"がゲームの拡張appinfoに設定されていない限り、VRゲームでのデフォルトは有効です。

これは、非対称のマルチプレイヤーゲームプレイを提供するゲームに役立ちます。

こちらも参照してください： ISteamUtils::IsVRHeadsetStreamingEnabled

SetWarningMessageHook

名前	型	説明
pFunction	SteamAPIWarningMessageHook_t	コールバック関数への関数ポインター。

SteamAPI警告と、コールバック関数内の情報メッセージを受信するための警告メッセージフックを設定します。

関数プロトタイプはSteamAPIWarningMessageHook_t内の定義と合致する必要があります。 これはextern"C"リンケージ、および __cdecl 呼び出し規約を含みます。

'int nSeverity' は重要度で、メッセージが0、警告が1です。 デバッガーを実行中であれば、警告のみが送信されます。 コマンドラインに-debug_steamapiを追加すると、情報メッセージが送信されます。
'const char * pchDebugText' がメッセージのテキストです。
コールバックは、警告またはメッセージを生成したAPI関数が呼び出された直後に発生します。

NULLを渡すとフックが解除されます。

例：

ShowGamepadTextInput

名前	型	説明
eInputMode	EGamepadTextInputMode	使用する入力モード、ノーマルまたはパスワード（隠しテキスト）のどちらかを選択します、
eLineInputMode	EGamepadTextInputLineMode	単一行または複数行入力を使用するかをコントロールします。
pchDescription	const char *	ユーザーに入力ダイアログの目的を知らせるための説明を設定します。
unCharMax	uint32	ユーザーが入力できる最大文字数。
pchExistingText	const char *	ユーザーが編集できる既存のテキストを設定します。

ゲームパッド入力のみをサポートするBig Pictureテキスト入力ダイアログをアクティブにします。

戻り値： bool
true はBig Pictureオーバーレイが実行中の場合、それ以外はfalse。

こちらも参照してください： ISteamUtils::GetEnteredGamepadTextLength、ISteamUtils::GetEnteredGamepadTextInput

ShowFloatingGamepadTextInput

名前	型	説明
eKeyboardMode	EFloatingGamepadTextInputMode	使用するキーボードタイプを選択。
nTextFieldXPosition	int	フローティングキーボードで隠れてはならないテキストフィールドのX座標
nTextFieldYPosition	int	フローティングキーボードで隠れてはならないテキストフィールドのY座標
nTextFieldWidth	int	フローティングキーボードで隠れてはならないテキストフィールドの幅
nTextFieldHeight	int	フローティングキーボードで隠れてはならないテキストフィールドの高さ

ゲームコンテンツ上にフローティングキーボードを開き、OSキーボードキーをゲームに直接送信します。
テキストフィールドの位置は、ゲームウィンドウの原点を基準としてピクセル単位で指定され、テキストフィールドに覆わない位置にフローティングキーボードを配置するために使用されます。

戻り値： bool
true はフローティングキーボードが表示された場合、それ以外はfalse。

こちらも参照してください： ISteamUtils::FloatingGamepadTextInputDismissed_t

StartVRDashboard

SteamにOpenVRダッシュボードを作成してレンダリングするよう求めます。

SetGameLauncherMode

名前	型	説明
bLauncherMode	bool	ランチャーがアクティブかどうか。

コントローラサポートのないゲームランチャー内でこれを呼び出し、Steam入力にコントローラ入力をマウス／キーボード入力に変換させて、ランチャーをナビゲートさせることができます。

コールバック

以下はSteamAPI_RunCallbacksを呼び出すことによって実行されるコールバックです。 これらの多くはISteamUtilsのメンバー関数への応答として直接実行されます。

CheckFileSignature_t

ISteamUtils::CheckFileSignatureの呼び出し結果。

名前	型	説明
m_eCheckFileSignature	ECheckFileSignature	Contains the result of the file signature check. k_ECheckFileSignatureNoSignaturesFoundForThisApp - This app has not been configured on the signing tab of the partner site to enable this function. k_ECheckFileSignatureNoSignaturesFoundForThisFile - This file is not listed on the signing tab for the partner site. k_ECheckFileSignatureFileNotFound - The file does not exist on disk. k_ECheckFileSignatureInvalidSignature - The file exists, and the signing tab has been set for this file, but the file is either not signed or the signature does not match. k_ECheckFileSignatureValidSignature - The file is signed and the signature is valid.

関連する関数： ISteamUtils::CheckFileSignature

GamepadTextInputDismissed_t

Called when the big picture gamepad text input has been closed.

名前	型	説明
m_bSubmitted	bool	trueとなるのはユーザーが入力してテキストを受け入れた場合（テキストの受け取りにはISteamUtils::GetEnteredGamepadTextInputを呼び出します）で、入力がキャンセルされるとfalseとなります。
m_unSubmittedText	uint32	提出されたテキストの長さをバイト単位で含みます。

FloatingGamepadTextInputDismissed_t

Called when the floating keyboard invoked from ISteamUtils::ShowFloatingGamepadTextInput has been closed.

IPCountry_t

Called when the country of the user changed. The country should be updated with ISteamUtils::GetIPCountry.

このコールバックにはフィールドはありません。

LowBatteryPower_t

Called when running on a laptop and less than 10 minutes of battery is left, and then fires then every minute afterwards.

名前	型	説明
m_nMinutesBatteryLeft	uint8	推定される分単位でのバッテリー残量。

SteamAPICallCompleted_t

Called when a SteamAPICall_t has completed (or failed)

名前	型	説明
m_hAsyncCall	SteamAPICall_t	完了したSteam APIコールのハンドル。
m_iCallback	int	完了したコールバックを一意で識別するk_iCallback定数です。
m_cubParam	uint32	完了したコールバックのバイト単位でのサイズ。

AppResumingFromSuspend_t

Sent after the device returns from sleep/suspend mode.

このコールバックにはフィールドはありません。

SteamShutdown_t

Called when Steam wants to shutdown.

このコールバックにはフィールドはありません。

列挙型

These are enums which are defined for use with ISteamUtils.

ECheckFileSignature

The result of a call to ISteamUtils::CheckFileSignature

名前	値	説明
k_ECheckFileSignatureInvalidSignature	0
k_ECheckFileSignatureValidSignature	1
k_ECheckFileSignatureFileNotFound	2
k_ECheckFileSignatureNoSignaturesFoundForThisApp	3
k_ECheckFileSignatureNoSignaturesFoundForThisFile	4

EGamepadTextInputLineMode

Controls number of allowed lines for the Big Picture gamepad text entry

名前	値	説明
k_EGamepadTextInputLineModeSingleLine	0
k_EGamepadTextInputLineModeMultipleLines	1

EGamepadTextInputMode

Input modes for the Big Picture gamepad text entry

名前	値	説明
k_EGamepadTextInputModeNormal	0
k_EGamepadTextInputModePassword	1

EFloatingGamepadTextInputMode

Controls the mode for the floating keyboard

名前	値	説明
k_EFloatingGamepadTextInputModeModeSingleLine	0	Enterはキーボードを閉じます。
k_EFloatingGamepadTextInputModeModeMultipleLines	1	ユーザーは明示的にキーボードを閉じることが必要です。
k_EFloatingGamepadTextInputModeModeEmail	2	キーボードは、Eメールの入力を容易にする特別なモードで表示されます。
k_EFloatingGamepadTextInputModeModeNumeric	3	テンキーが表示されます。

ESteamAPICallFailure

Steam API call failure results returned by ISteamUtils::GetAPICallFailureReason.

名前	値	説明
k_ESteamAPICallFailureNone	-1	失敗なし。
k_ESteamAPICallFailureSteamGone	0	ローカルのSteamプロセスが応答を終了しました、強制的に閉じられたかフリーズ状態です。
k_ESteamAPICallFailureNetworkFailure	1	Steamサーバーへのネットワーク接続が失われたか、すでに切断されました。 SteamServersDisconnected_tコールバックはほぼ同時に送信され、クライアントがSteamサーバーと通信できる時にSteamServersConnected_tコールバックが送信されます。
k_ESteamAPICallFailureInvalidHandle	2	渡されたSteamAPICall_tハンドルがもう存在しません。
k_ESteamAPICallFailureMismatchedCallback	3	このAPIコールにGetAPICallResultが誤ったコールバックタイプで呼び出されました。

定数

These are constants which are defined for use with ISteamUtils.

名前	型	値	説明
STEAMUTILS_INTERFACE_VERSION	const char *	"SteamUtils009"