Share via

PIXEndRetailEvent

  • Article

Defines the end of a user-defined retail event.

Syntax

void PIXEndRetailEvent(  
         void* context  
)

Parameters

context   
Type: void*

Context for the event, accepts ID3D12GraphicsCommandList\*, ID3D12GraphicsCommandList\*, and ID3D12XboxDmaCommandList\* (Xbox only).
The context associates the PIX marker with the D3D12 object it is set on.

Return value

Type: void

Remarks

With a debug or instrumented device, PIXEndERetailEvent behaves identically to PIXEndEvent. For a retail device, the events will be included in HIX files for GPU hang debugging.

Each call to PIXEndERetailEvent must be paired with a corresponding call to PIXBeginRetailEvent. In a worst case scenario, mismatched event calls may cause PIX to crash.

Requirements

Header: pix3.h

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

See also

PIXBeginRetailEvent
pix3
PIX (NDA topic)