PIXBeginRetailEvent
Starts a user-defined retail event.Syntax
Parameters
contextType: void* Context for the event, accepts
ID3D12GraphicsCommandList\*, ID3D12GraphicsCommandList\* and ID3D12XboxDmaCommandList\* (XBOX only).
color Type: UINT64 The event color to use in the system timing chart. Use PIX_COLOR to specify a color, 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 whose types depend on the placeholders. This method supports up to a maximum of 16 format parameters.
Return value
Type: voidRemarks
With a debug or instrumented device,PIXBeginRetailEvent behaves identically to PIXBeginEvent. For a retail device, the events will be included in HIX files for GPU hang debugging.
PIXBeginRetailEvent and PIXEndRetailEvent pairs can be nested to any depth.
Requirements
Header: pix3.h Library: pixevt.lib Supported platforms: XBOX One family consoles and XBOX Series consolesSee also
PIX (NDA topic)pix3
PIXEndRetailEvent
PIXBeginRetailEvent(void*, UINT64, PCSTR, …)