PIXSetRetailMarker
Inserts a retail marker, when a particular user-defined event occurs.Syntax
Parameters
contextType: void* Context for the event, accepts ID3D12GraphicsCommandList* , 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 to specify a color, use 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: PCWSTR The name to use to describe the event, as a pointer to a null-terminated Unicode string. 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: voidRemarks
With a debug or instrumented device,PIXSetRetailMarker behaves identically to 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.
Requirements
Header: pix3.h Library: pixevt.lib Supported platforms: XBOX One family consoles and XBOX Series consolesSee also
PIX overview (NDA topic)pix3
PIXSetRetailMarker(void*, UINT64, PCSTR, …)
PIXBeginRetailEvent