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

# PIXBeginRetailEvent(void*, UINT64, PCSTR, ...)

> PIXBeginRetailEvent 関数

# PIXBeginRetailEvent 関数

ユーザー定義のリテール イベントを開始します。

## 構文

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

### パラメーター

*context*   \
Type: void\*

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

*color*   \
Type: UINT64

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

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

Type: ...

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

### 戻り値

Type: void

## 解説

デバッグ デバイスまたは計測用デバイスでは、`PIXBeginRetailEvent` は [PIXBeginEvent](https://docs.xbox.com/ja-jp/reference/tools/pix3/functions/pixbeginevent.md) と同じ動作をします。リテール デバイスでは、これらのイベントは GPU ハング デバッグ用の HIX ファイルに含まれます。

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

## 要件

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

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

## 関連項目

[PIXBeginRetailEvent(void\*,UINT64, PCWSTR, ...)](https://docs.xbox.com/ja-jp/reference/tools/pix3/functions/pixbeginretailevent_2.md)\
[PIXEndRetailEvent](https://docs.xbox.com/ja-jp/reference/tools/pix3/functions/pixendretailevent.md)\
[pix3](https://docs.xbox.com/ja-jp/reference/tools/pix3/pix3_members.md)\
[PIX (NDA トピック)](https://docs.xbox.com/ja-jp/tools/tools-console/pix/pix.md)


## Related topics

- [PIXBeginRetailEvent(void*,UINT64, PCWSTR, ...)](https://docs.xbox.com/ja-jp/reference/tools/pix3/functions/pixbeginretailevent_2.md)
- [PIXBeginEvent](https://docs.xbox.com/ja-jp/reference/tools/pix3/functions/pixbeginevent-overloads.md)
- [PIXSetRetailMarker(void*, UINT64, PCSTR, ...)](https://docs.xbox.com/ja-jp/reference/tools/pix3/functions/pixsetretailmarker.md)
- [PIXBeginEvent(void*, UINT64, PCSTR, ...)](https://docs.xbox.com/ja-jp/reference/tools/pix3/functions/pixbeginevent_3.md)
- [PIXBeginEvent(UINT64, PCSTR, ...)](https://docs.xbox.com/ja-jp/reference/tools/pix3/functions/pixbeginevent.md)