Skip to main content

PIX_COLOR_INDEX

Specifies a set of unique event categories and lets PIX choose the colors to represent each category.

Syntax

Parameters

i   
Type: BYTE
The index of the color.

Return value

Type: UINT Returns a UINT containing the color representing the category.

Remarks

Use the PIX_COLOR* functions to specify colors to pass as metadata to a PIX event/marker API. Use PIX_COLOR to specify a particular color for an event. Or, use PIX_COLOR_INDEX to specify a set of unique event categories, and let PIX choose the colors to represent each category. PIX_COLOR_INDEX allows for eight distinct color indexes to be used. The function will wrap the index values using i % 8 to choose the index that will determine the appropriate color.
The PIX_COLOR* functions can be used to determine the color parameter for a number of functions to represent how they will be displayed in a PIX chart. Those functions include the overloaded methods PIXBeginEvent and PIXSetMarker.

Requirements

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

See also

PIX_COLOR
PIXBeginEvent
PIXSetMarker
PIX3
PIX (NDA topic)
Last modified on August 20, 2026