PIXEndCapture

Stops a programmatically controlled capture that was started with PIXBeginCapture.

Syntax

HRESULT PIXEndCapture(
         BOOL discard
)

Parameters

discard
Type: BOOL

[in] Indicates whether the capture should be discarded:

If discard is TRUE, the captured data is discarded, and the capture will not be displayed in PIX.
If discard is FALSE, the captured data is saved, and PIX will display the resulting capture.

The discard parameter is useful to throw away captures that didn’t meet the criteria you were looking for. For example, you can use PIXBeginCapture and PIXEndCapture to attempt to capture calls to a function that fall within a predefined time range. You may wish to only display captures for calls to a function that fall within that range.

Return value

Type: HRESULT

Indicates whether the capture complete successfully. S_OK is returned on success.

Example

PIXBeginCapture(PIX_CAPTURE_CALLGRAPH, nullptr);
engine->Render();
BOOL discard = engine->frameNormal();
PIXEndCapture(discard);

Requirements

Header: Declared in pix.h.