Share via

PIX_COLOR

  • Article

Specifies a particular color for an event.

Syntax

UINT PIX_COLOR(  
         BYTE r,  
         BYTE g,  
         BYTE b  
)

Parameters

r   
Type: BYTE

The red component of the color.

g   
Type: BYTE

The green component of the color.

b   
Type: BYTE

The blue component of the color.

Return value

Type: UINT

Returns a UINT containing the specified color.

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.

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 PIXBeginEvent, PIXScopedEvent, and PIXSetMarker.

Requirements

Header: pix3.h

Library: pixevt.lib

Supported platforms: Xbox One family consoles and Xbox Series consoles

See also

PIX_COLOR_INDEX
PIXBeginEvent
PIXScopedEvent
PIXSetMarker
PIX (NDA topic)
PIX3