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

# PIXSetRetailMarker function

> PIXSetRetailMarker function

# PIXSetRetailMarker function

Inserts a retail marker, when a particular user-defined event occurs.

## Syntax

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

### Parameters

*context*   \
Type: void\*

Context for the event, accepts 1ID3D12GraphicsCommandList\*`,`ID3D12CommandQueue\*`and`ID3D12XboxDmaCommandList\*\` (XBOX only).

*color*   \
Type: UINT64

The color that will be used in the timing chart when this event occurs in PIX windows.\
Use [PIX\_COLOR](/reference/tools/pix3/functions/pix_color) to specify a color, use [PIX\_COLOR\_INDEX](/reference/tools/pix3/functions/pix_color_index) to specify a color index, or pass in a raw DWORD noting that the format is ARGB and the alpha channel value must be 0xff.

*formatString*   \_In\_\
Type: PCSTR

The name to use to describe the event. The string may specify zero or more optional string format placeholders, very similar to **sprintf** formatting.

Type: ...

If placeholders are used in *formatString*, there must be a corresponding number of parameters (up to a maximum of 16) whose types match the placeholders.

### Return value

Type: void

## Remarks

With a debug or instrumented device, `PIXSetRetailMarker` behaves identically to [PIXSetMarker](/reference/tools/pix3/functions/pixsetmarker). For a retail device, the markers will be included in HIX files for GPU hang debugging.

Calls to `PIXSetRetailMarker` can occur anywhere, and do not have to follow a call to [PIXBeginRetailEvent](/reference/tools/pix3/functions/pixbeginretailevent).

## Requirements

**Header:** pix3.h

**Library:** pixevt.lib
**Supported platforms:** XBOX One family consoles and XBOX Series consoles

## See also

[PIXSetRetailMarker(void\*, UINT64, PCWSTR, ...)](/reference/tools/pix3/functions/pixsetretailmarker_2)\
[pix3](/reference/tools/pix3/pix3_members)\
[PIX (NDA topic)](/tools/tools-console/pix/pix)


## Related topics

- [PIXSetRetailMarker](/reference/tools/pix3/functions/pixsetretailmarker_2.md)
- [PIXSetMarker function](/reference/tools/pix3/functions/pixsetmarker.md)
- [PIXSetMarker function reference](/reference/tools/pix3/functions/pixsetmarker_3.md)
- [PIXSetMarker](/reference/tools/pix3/functions/pixsetmarker-overloads.md)
- [PIXEndRetailEvent](/reference/tools/pix3/functions/pixendretailevent.md)