PIXScopedEvent 関数
Xbox パフォーマンス インベスティゲーター (PIX) のタイミング キャプチャ機能に表示される CPU アクティビティのタイミング キャプチャに対するユーザー定義イベントを作成します。
構文
void PIXScopedEvent(
UINT64 color,
_In_ PCSTR formatString,
...
)
パラメーター
color
型: UINT64
タイムライン チャートで使用するイベントの色。 事前に定義された色を使用するには PIX_COLOR 定数、カラー インデックスを使用するには PIX_COLOR_INDEX 定数、カスタム カラーの色を使用するには ARGB 形式の DWORD 値を指定します。 ARGB 形式の DWORD 値が指定されている場合は、その値のアルファ チャネルを 0xff に設定する必要があります。
formatString _In_
型: PCWSTR
Unicode の NULL 終端文字列へのポインターとして、イベントを記述するために使用する名前。 文字列では、sprintf 形式と同様に、任意の数の省略可能な書式設定のプレースホルダーを指定することもあります。 このメソッドでは、最大 16 のプレースホルダーをサポートします。
型: ...
formatString にプレースホルダーが指定される場合は、対応する数の値をこのパラメーターに指定する必要があります。 このパラメーターで指定される値の型は、対応するプレースホルダーによって識別される型によって異なります。
戻り値
型: void
ありません。
解説
この関数は、PIX のタイミング キャプチャ機能に表示される CPU アクティビティのタイミング キャプチャに対するユーザー定義イベントを作成します。
PIXScopedEvent で作成されたイベントは、API の呼び出しが行われたスコープが終了したときに自動的に終了します。そのため、イベントの開始と終了の対応付けは自動的に行われます。
PIXScopedEvent 関数は、実行時に文字列を書式設定するのではなく、書式文字列と書式パラメーターを保存します。 その後、PIX でキャプチャ ファイルを読み取るときに書式設定が行われます。 パフォーマンスを最適化するには、PIXScopedEvent で 8 バイトにアラインされた文字列、または 16 バイトにアラインされた文字列 (推奨) を使用します。
%p 書式指定子を使用して char\* または wchar_t\* をポインターとして書式設定するには、ポインターを PIXScopedEvent に渡すときに、ポインターを void\* に、あるいは整数型または浮動小数点数型にキャストします。
PIXScopedEvent の呼び出しでは、レコード データを保存するために 512 バイト以上の領域が保証されます。このサイズには、書式文字列およびすべての変数の全サイズおよびアライメントが含まれます。 一般に、PIX イベントは、ゲームの主要コンポーネント、システム、またはコンテンツにアライメントする短い高パフォーマンスのマーカー向けです。
要件
ヘッダー: pix3.h
ライブラリ: pixevt.lib
サポートされているプラットフォーム: Xbox One ファミリー本体、Xbox Series 本体