> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# PIXGetCaptureState

> PIXGetCaptureState

# PIXGetCaptureState

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

## Syntax

```cpp theme={null}
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](/reference/tools/pix3/functions/pixbegincapture.md) function.
In the case of [PIXBeginCapture](/reference/tools/pix3/functions/pixbegincapture.md), 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

## See also

[PIXBeginCapture](/reference/tools/pix3/functions/pixbegincapture.md)\
[PIX3](/reference/tools/pix3/pix3_members.md)\
[PIX (NDA topic)](/tools/tools-console/pix/pix.md)


## Related topics

- [PIX3 (API contents)](/reference/tools/pix3/pix3_members.md)
- [PIXCaptureParameters](/reference/tools/pix3/structs/pixcaptureparameters.md)
- [CreateCaptureAudioStateMonitor](/reference/audio/audiostatemonitor/functions/createcaptureaudiostatemonitor.md)
- [CreateCaptureAudioStateMonitorForCategory](/reference/audio/audiostatemonitor/functions/createcaptureaudiostatemonitorforcategory.md)
- [CreateCaptureAudioStateMonitorForCategoryAndDeviceId](/reference/audio/audiostatemonitor/functions/createcaptureaudiostatemonitorforcategoryanddeviceid.md)