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

# PIXBeginRetailEvent

> PIXBeginRetailEvent

# PIXBeginRetailEvent

Inicia um evento de varejo definido pelo usuário.

## Sintaxe

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

### Parâmetros

*context*   \
Tipo: void\*

Contexto do evento; aceita `ID3D12GraphicsCommandList\*`, `ID3D12GraphicsCommandList\*` e `ID3D12XboxDmaCommandList\*` (somente XBOX).

*color*   \
Tipo: UINT64

A cor do evento a ser usada no gráfico de tempo do sistema. Use [PIX\_COLOR](/pt-BR/reference/tools/pix3/functions/pix_color) para especificar uma cor, [PIX\_COLOR\_INDEX](/pt-BR/reference/tools/pix3/functions/pix_color_index) para especificar um índice de cor ou passe um DWORD bruto, observando que o formato é ARGB e o valor do canal alfa deve ser 0xff.\
*formatString*   \_In\_\
Tipo: PCWSTR

O nome a ser usado para descrever o evento, como um ponteiro para uma cadeia de caracteres Unicode terminada em nulo. A cadeia de caracteres pode especificar zero ou mais espaços reservados de formato de cadeia de caracteres opcionais, muito semelhantes à formatação de `sprintf`.

Tipo: ...

Se forem usados espaços reservados em *formatString*, deverá haver um número correspondente de parâmetros cujos tipos dependem dos espaços reservados. Este método dá suporte a no máximo 16 parâmetros de formato.

### Valor retornado

Tipo: void

## Comentários

Com um dispositivo de depuração ou instrumentado, `PIXBeginRetailEvent` se comporta de forma idêntica a [PIXBeginEvent](/pt-BR/reference/tools/pix3/functions/pixbeginevent). Em um dispositivo de varejo, os eventos serão incluídos nos arquivos HIX para depuração de travamentos da GPU.

Os pares `PIXBeginRetailEvent` e `PIXEndRetailEvent` podem ser aninhados em qualquer profundidade.

## Requisitos

**Cabeçalho:** pix3.h

**Biblioteca:** pixevt.lib
**Plataformas com suporte:** consoles da família XBOX One e consoles XBOX Series

## Confira também

[PIX (tópico sob NDA)](/pt-BR/tools/tools-console/pix/pix)\
[pix3](/pt-BR/reference/tools/pix3/pix3_members)\
[PIXEndRetailEvent](/pt-BR/reference/tools/pix3/functions/pixendretailevent)\
[PIXBeginRetailEvent(void\*, UINT64, PCSTR, ...)](/pt-BR/reference/tools/pix3/functions/pixbeginretailevent)


## Related topics

- [PIXBeginRetailEvent](/reference/tools/pix3/functions/pixbeginretailevent_2.md)
- [PIXBeginRetailEvent function](/reference/tools/pix3/functions/pixbeginretailevent.md)
- [PIXBeginRetailEvent 函数](/zh-CN/reference/tools/pix3/functions/pixbeginretailevent.md)
- [Función PIXBeginRetailEvent](/es/reference/tools/pix3/functions/pixbeginretailevent.md)
- [PIXBeginRetailEvent 関数](/ja-jp/reference/tools/pix3/functions/pixbeginretailevent.md)