PIX API Reference

The PIX header (pix.h) and library (PIXEvt.lib) define the following API items.

Functions

Name Description
ConfigurePMCs Configures the four hardware Performance Monitor Counters (PMCs) to enable a title to read the counters directly for the title code.
GetPMCValue Gets the value of a hardware Performance Monitor Counter (PMC).
PIXBeginCapture Starts a programmatically controlled PIX capture.
PIXBeginEvent Starts a user-defined event for a timing capture of CPU activity, to be displayed in the System Timing Capture feature of PIX.
PIXEndCapture Stops a programmatically controlled capture that was started with PIXBeginCapture.
PIXEndEvent Defines the end of a user-defined event.
PIXGetCaptureState Retrieves the type of captures in progress, as a set of flags.
PIXRecordMemoryAllocationEvent Records a memory allocation event. Provides the data that PIX needs to display information about all memory allocations made from within the title’s custom memory allocators in memory profiling captures. By providing this data, PIX will show all the same data for your custom allocators that it does for calls to VirtualAlloc/VirtualFree and HeapAlloc/HeapFree.
PIXRecordMemoryFreeEvent Records a memory freeing event. Provides the data that PIX needs to display information about all memory allocations made from within the title’s custom memory allocators in memory profiling captures. By providing this data, PIX will show all the same data for your custom allocators that it does for calls to VirtualAlloc/VirtualFree and HeapAlloc/HeapFree.
PIXReportCounter Displays a user-defined counter in the PIX UI.
PIXScopedEvent Creates a user-defined event for a timing capture of CPU activity, to be displayed in the System Timing Capture feature of PIX. Events defined by calling PIXScopedEvent begin when the API is called and end when the enclosing scope exits.
PIXSetMarker Inserts a marker into the CPU timeline in the PIX System Timing Capture window, when a particular user-defined event occurs.

Structures

Name Description
PIXCaptureParameters Parameters for PIXBeginCapture.

Macros

Name Description
MAX_PIX_STRING_LENGTH The maximum length of a user-defined named event, in characters.
PIX_COLOR Specifies a color for a PIX event or marker, from red, green and blue values.
PIX_COLOR_INDEX Specifies an arbitrary color index. PIX allocates a unique color for each index number.

See also

PIX