PIXGetCaptureState

Retrieves the type of captures in progress, as a set of flags.

Syntax

DWORD PIXGetCaptureState(  
)  

Parameters

Return value

Type: DWORD Capture state flags. If no capture state flags are set, zero is returned, which indicates that PIX has no captures in progress.

Flags

Flag	Value	Description
PIX_CAPTURE_TIMING	(1 << 0)	System timing.
PIX_CAPTURE_GPU	(1 << 1)	Captures all commands and their inputs sent to the GPU so that it can be replayed and analyzed.
PIX_CAPTURE_FUNCTION_SUMMARY	(1 << 2)	A function summary capture was initiated from the Home tab.
PIX_CAPTURE_FUNCTION_DETAILS	(1 << 3)	A request for additional function details was initiated using the Capture Additional Calls button from either a function summary or callgraph capture.
PIX_CAPTURE_CALLGRAPH	(1 << 4)	A callgraph capture was initiated either from PIX or programmatically by calling `PIXBeginCapture`.
PIX_CAPTURE_INSTRUCTION_TRACE	(1 << 5)	A CPU instruction trace capture is in progress.
PIX_CAPTURE_SYSTEM_MONITOR_COUNTERS	(1 << 6)	System monitor counters.
PIX_CAPTURE_VIDEO	(1 << 7)	Video playback.
PIX_CAPTURE_AUDIO	(1 << 8)	Audio playback.
PIX_CAPTURE_GPU_TRACE	(1 << 9)	Captures GPU Streaming Performance Monitor (SPM) counters and Shader Queue Thread Tracing (SQTT) data from nearly all GPU blocks.
PIX_CAPTURE_RESERVED	(1 << 15)	Placeholder flag used internally by PIX for future or specialized capture scenarios.

Remarks

The flags retrieved from PIXCaptureState are used as parameters in the PIXBeginCapture function. In the case of PIXBeginCapture, the flag will determine which type of PIX capture is initiated. You can confirm that the capture began properly by calling this function to check the capture types that are currently running.

Requirements

Header: pix3.h Library: pixevt.lib Supported platforms: XBOX One family consoles and XBOX Series consoles

(all) API references

Error codes

Audio API reference

Chat API reference

Developer kit only API reference

Graphics API reference

Input API reference

Lighting API reference

Networking API reference

XBOX PC remote iteration API reference

System API reference

Tools API reference

Windows device portal REST API reference

XBOX services API reference

MicrosoftGame.config reference

PIXGetCaptureState

PIXGetCaptureState

Syntax

Parameters

Return value

Flags

Remarks

Requirements

See also

​PIXGetCaptureState

​Syntax

​Parameters

​Return value

​Flags

​Remarks

​Requirements

​See also

PIXGetCaptureState

Syntax

Parameters

Return value

Flags

Remarks

Requirements

See also