PIXSetRetailMarker function

Article
06/22/2023

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

Syntax

void PIXSetRetailMarker(  
         void* context,  
         UINT64 color,  
         PCSTR formatString,  
         ...  
)

Parameters

context
Type: void*

Context for the event, accepts 1ID3D12GraphicsCommandList*,ID3D12CommandQueue*andID3D12XboxDmaCommandList*` (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: 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. 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 consoles

Share via