PIXSetRetailMarker

当特定用户定义的事件发生时,插入一个零售标记。

语法

void PIXSetRetailMarker(  
         void* context,  
         UINT64 color,  
         PCWSTR formatString,  
         ...  
)  

参数

context   
类型:void*

事件的上下文,接受 ID3D12GraphicsCommandList*ID3D12CommandQueue*ID3D12XboxDmaCommandList*(仅适用于 Xbox)。

color   
类型:UINT64

在 PIX 窗口中发生此事件时将在计时图表中使用的颜色。
使用 PIX_COLOR 指定颜色,使用 PIX_COLOR_INDEX 指定颜色索引,或传递原始 DWORD;请注意,格式为 ARGB,而 alpha 信道值必须为 0xff。

formatString _In_
类型:PCWSTR

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

类型:...

如果在 formatString 中使用占位符,则必须有相应数量的参数(最多 16 个),参数类型与占位符匹配。

返回值

类型:void

备注

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

PIXSetRetailMarker 的调用可能会出现在任何地方,并且无需遵循对 PIXBeginRetailEvent 的调用。

要求

头文件:pix3.h

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

另请参阅

PIX 概述(NDA 主题)要求授权
pix3
PIXSetRetailMarker(void*, UINT64, PCSTR, ...)
PIXBeginRetailEvent