> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# PIXScopedEvent の概要

> PIXScopedEvent の概要

# PIXScopedEvent の概要

Performance Investigator for XBOX (PIX) の **Timing Capture** 機能で表示するために、CPU アクティビティ、あるいは XBOX の場合は GPU アクティビティの、コンテキスト固有のタイミング キャプチャ用のユーザー定義イベントを作成します。

<a id="syntaxSection" />

## 構文

```cpp theme={null}
void PIXScopedEvent(
         void* context,
         UINT64 color,
         _In_ PCWSTR formatString,
         ...
)
```

<a id="parametersSection" />

### パラメーター

*context*   \
Type: void\*

イベントのコンテキストです。XBOX の場合は、GPU アクティビティのタイミング キャプチャを可能にするため、このパラメーターは `ID3D12GraphicsCommandList*`、`ID3D12GraphicsCommandList*`、および `ID3D12XboxDmaCommandList*` ポインターも受け付けます。

*color*   \
Type: UINT64

タイムライン チャートで使用するイベントの色です。事前定義された色を使用する場合は [PIX\_COLOR](/reference/tools/pix3/functions/pix_color) 定数、色インデックスを使用する場合は [PIX\_COLOR\_INDEX](/reference/tools/pix3/functions/pix_color_index) 定数、あるいはカスタム色を使用する場合は ARGB 形式の DWORD 値を指定します。ARGB 形式の DWORD 値を指定する場合、alpha チャネルの値は `0xff` に設定する必要があります。

*formatString*   \_In\_\
Type: PCWSTR

イベントを説明するために使用する名前で、NULL 終端の Unicode 文字列へのポインターとして指定します。この文字列には、`sprintf` の書式指定に非常に近い形式で、任意の書式指定プレースホルダーを 0 個以上指定できます。このメソッドは最大 16 個のプレースホルダーをサポートします。

Type: ...

*formatString* にプレースホルダーが指定されている場合、対応する数の値をこのパラメーターで指定する必要があります。このパラメーターで指定する値の型は、対応するプレースホルダーで識別される型に依存します。

<a id="retvalSection" />

### 戻り値

Type: void

なし。

## 解説

この関数は、PIX の **Timing Capture** 機能で表示するために、CPU アクティビティのタイミング キャプチャ用のユーザー定義イベントを作成します。`PIXScopedEvent` で作成されたイベントは、API が呼び出されたスコープを抜けると自動的に終了するため、イベントの開始と終了の対応付けが自動的に行われます。

`PIXScopedEvent` 関数は、実行時に文字列を書式設定するのではなく、書式文字列と書式パラメーターを保存します。書式設定は、PIX でキャプチャ ファイルを読み込むときに行われます。最良のパフォーマンスを得るには、`PIXScopedEvent` で 8 バイト境界に配置された文字列、または (推奨として) 16 バイト境界に配置された文字列を使用してください。`%p` 書式指定子を使って `char\*` または `wchar_t\*` をポインターとして書式設定するには、`PIXScopedEvent` にポインターを渡す際に、そのポインターを `void\*` または任意の整数型または浮動小数点型にキャストします。

`PIXScopedEvent` の呼び出しでは、書式文字列とすべての変数の合計サイズおよびアラインメントを含めて、少なくとも 512 バイトの領域が保存用に確保されることが保証されます。一般に、PIX イベントは、ゲームの主要なコンポーネント、システム、またはコンテンツに沿った短い高パフォーマンスなマーカーを目的としています。

このメソッドは通常、CPU イベントの計測に使用します。ただし、`context` パラメーターに `ID3D12GraphicsCommandList*`、`ID3D12CommandQueue*`、または `ID3D12XboxDmaCommandList*` ポインターを渡すと、GPU イベントも計測できます。

<a id="requirementsSection" />

## 要件

**ヘッダー:** pix3.h

**ライブラリ:** pixevt.lib

**サポートされているプラットフォーム**: XBOX One ファミリ本体および XBOX Series 本体

<a id="seealsoSection" />

## 関連項目

[PIXScopedEvent](/reference/tools/pix3/functions/pixscopedevent-overloads)\
[PIX3](/reference/tools/pix3/pix3_members)\
[PIX (NDA トピック)](/tools/tools-console/pix/pix)


## Related topics

- [PIXScopedEvent](/ja-jp/reference/tools/pix3/functions/pixscopedevent-overloads.md)
- [PIXScopedEvent 関数](/ja-jp/reference/tools/pix3/functions/pixscopedevent.md)
- [PIXScopedEvent リファレンス](/ja-jp/reference/tools/pix3/functions/pixscopedevent_2.md)
- [PIXScopedEvent 関数リファレンス](/ja-jp/reference/tools/pix3/functions/pixscopedevent_3.md)
- [PIXBeginEvent の概要](/ja-jp/reference/tools/pix3/functions/pixbeginevent_4.md)