PIXScopedEvent 函数

为 CPU 活动的计时捕获创建用户定义的事件,将显示在 Xbox 性能调查器 (PIX) 的计时捕获功能中。

语法

void PIXScopedEvent(
         UINT64 color,
         _In_ PCSTR formatString,
         ...
)

参数

color   
类型:UINT64

要在时间线图表中使用的事件颜色。 指定 PIX_COLOR 常量以使用预定义的颜色、指定 PIX_COLOR_INDEX 常量以使用颜色索引,或指定 ARGB 格式的 DWORD 值以使用自定义颜色。 如果指定了 ARGB 格式的 DWORD 值,则该值的 alpha 通道必须设置为 0xff

formatString _In_
类型:PCWSTR

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

类型:...

如果占位符在 formatString 中指定,则必须在此参数中指定值的相应数目。 在此参数中指定的值的类型取决于其对应占位符所标识的类型。

返回值

类型:void

无。

备注

此函数为 CPU 活动的计时捕获创建用户定义的事件,将显示在 PIX 的计时捕获功能中。 使用 PIXScopedEvent 创建的事件在调用了 API 的作用域退出时自动结束,这使得事件的开始和结束自动匹配。

PIXScopedEvent 函数将保存格式字符串和格式参数,而不是在运行时格式化字符串。 读取 PIX 中的捕获文件时会执行格式化。 将 8 字节对齐的字符串或 16 字节对齐的字符串(首选)用于 PIXScopedEvent 以获得最佳性能。 要使用 %p 格式说明符将 char\*wchar_t\* 作为指针进行格式化,当将指针传递到 PIXScopedEvent 时,请将其强制转换为 void\* 或指向任何整型或浮点类型的指针。

PIXScopedEvent 的调用保证至少有 512 字节的空间来保存记录数据,包括格式字符串和所有变量的完整大小和对齐。 一般情况下,PIX 事件用于与游戏的主要组件、系统或内容对齐的简短高性能标记。

要求

头文件:pix3.h

库:pixevt.lib

支持的平台:Xbox One 系列主机和 Xbox Series 主机

另请参阅

PIXScopedEvent
PIX3
PIX(NDA 主题)要求授权