PIXBeginRetailEvent 函数

启动用户定义的零售事件。

语法

void PIXBeginRetailEvent(  
         void* context,  
         UINT64 color,  
         PCSTR formatString,
         ...  
)

context
类型：void*

事件的上下文，接受 ID3D12GraphicsCommandList\*、ID3D12GraphicsCommandList\* 和 ID3D12XboxDmaCommandList\*（仅适用于 Xbox）。

color
类型：UINT64

要在系统计时图表中使用的事件颜色。使用 PIX_COLOR 指定颜色，使用 PIX_COLOR_INDEX 指定颜色索引，或传递原始 DWORD；请注意，格式为 ARGB，而 alpha 信道值必须为 0xff。
formatString _In_
类型：PCSTR

要用来描述事件的名称，作为一个指向以 null 结尾的字符串的指针。此字符串可能指定零个或多个可选字符串格式占位符，非常类似于 sprintf 格式。

类型：...

如果在 formatString 中使用占位符，则必须有相应数量的参数，参数类型取决于占位符。此方法支持最多 16 个格式参数。

类型：void

使用调试或检测设备时，PIXBeginRetailEvent 的行为与 PIXBeginEvent 完全相同。就零售设备而言，事件会被包含在 HIX 文件中，供 GPU 挂起调试。

PIXBeginRetailEvent 和 PIXEndRetailEvent 对可嵌套到任何深度。

头文件：pix3.h

库： pixevt.lib 支持平台：Xbox One 系列主机和 Xbox Series 主机