> ## 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.

# PIXBeginEvent リファレンス

> PIXBeginEvent リファレンス

# PIXBeginEvent リファレンス

PIX の **System Timing Capture** 機能で表示するために、CPU または GPU アクティビティのタイミング キャプチャ用のユーザー定義イベントを開始します。

## 構文

```cpp theme={null}
void PIXBeginEvent(  
         void* context,  
         UINT64 color,  
         PCSTR formatString,
         ...  
)  
```

### パラメーター

*context*   \
Type: void\*

イベントのコンテキストです。`ID3D12GraphicsCommandList\*`、`ID3D12GraphicsCommandList\*`、および `ID3D12XboxDmaCommandList\*` (XBOX のみ) を受け付けます。

*color*   \
Type: UINT64

システム タイミング チャートで使用するイベントの色です。色を指定するには [PIX\_COLOR](/reference/tools/pix3/functions/pix_color)、色のインデックスを指定するには [PIX\_COLOR\_INDEX](/reference/tools/pix3/functions/pix_color_index) を使用します。または、フォーマットが ARGB で、alpha チャネルの値が 0xff でなければならないことに注意しつつ、生の DWORD を渡すこともできます。

*formatString*   \_In\_\
Type: PCSTR

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

Type: ...

*formatString* にプレースホルダーが使用されている場合、対応する数のパラメーターを、プレースホルダーに応じた型で渡す必要があります。このメソッドは最大 16 個の書式パラメーターをサポートします。

### 戻り値

Type: void

## 解説

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

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

このメソッドは CPU イベントの計測に使用します。GPU イベントの計測について詳しくは、[PIX3](/reference/tools/pix3/pix3_members) の [PIX GPU キャプチャ API](/reference/tools/pix3/pix3_members#pixgpucaptureapis) セクションをご覧ください。

`PIXBeginEvent` の呼び出しには、[PIXEndEvent](/reference/tools/pix3/functions/pixendevent) の対応する呼び出しが必要です。`PIXBeginEvent` と [PIXEndEvent](/reference/tools/pix3/functions/pixendevent) のペアの呼び出しは、同じスレッドで行う必要があります。計測間隔は約 200ns で、この関数を使用するオーバーヘッドは低いため、1 秒あたり最大数十万回まで `PIXBeginEvent` を呼び出すことができます。

`PIXBeginEvent` と `PIXEndEvent` のペアは、任意の深さでネストできます。

## 要件

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

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

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

## 関連項目

[PIXBeginEvent](/reference/tools/pix3/functions/pixbeginevent)\
[PIXBeginEvent\_2](/reference/tools/pix3/functions/pixbeginevent_2)\
[PIXBeginEvent\_4](/reference/tools/pix3/functions/pixbeginevent_4)\
[PIXEndEvent](/reference/tools/pix3/functions/pixendevent)\
[PIX3](/reference/tools/pix3/pix3_members)\
[PIX (NDA トピック)](/tools/tools-console/pix/pix)


## Related topics

- [PIXBeginEvent 関数リファレンス](/ja-jp/reference/tools/pix3/functions/pixbeginevent_2.md)
- [PIXEndEvent リファレンス](/ja-jp/reference/tools/pix3/functions/pixendevent.md)
- [PIXScopedEvent リファレンス](/ja-jp/reference/tools/pix3/functions/pixscopedevent_2.md)
- [PIXScopedEvent 関数リファレンス](/ja-jp/reference/tools/pix3/functions/pixscopedevent_3.md)
- [API リファレンス](/ja-jp/reference/gc-reference-toc.md)