XGameStreamingGetDisplayDetails
此 API 返回指定客户端的显示详细信息。可用于做出明智的决策,例如以什么自定义纵横比呈现或使用什么分辨率来启用 DirectCapture。语法
参数
client _In_类型:XGameStreamingClientId 正在查询的流式处理客户端。 maxSupportedPixels _In_
类型:uint32_t 游戏支持的最大像素数。 widestSupportedAspectRatio _In_
类型:float 游戏支持的最宽纵横比。这是使用支持的最宽分辨率通过 width / height 计算得出的。 tallestSupportedAspectRatio _In_
类型:float 游戏支持的最高纵横比。这是使用支持的最高分辨率通过 width / height 计算得出的。 displayDetails _Out_
类型:XGameStreamingDisplayDetails* 流式处理客户端的显示详细信息。
返回值
类型:HRESULT 如果成功,则返回 S_OK;否则返回错误代码。潜在错误
有关错误代码列表,请参阅错误代码。
备注
displayDetails 中的数据可用于驱动游戏的各个方面,例如渲染游戏的分辨率,以及告知关键信息或 UI 的放置位置,以确保它们可交互且不被遮挡。
displayDetails 结构中的 preferredWidth 和 preferredHeight 基于流式处理客户端上的实际显示、基于流式处理系统的限制以及游戏提供的参数(maxSupportedPixels、widestSupportedAspectRatio、tallestSupportedAspectRatio)。
请记住,数据可能在游戏启动时不可用,也可能在客户端连接事件时不一定可用,因此游戏应使用事件或轮询。
示例
要求
标头: xgamestreaming.h库: xgameruntime.lib
支持的平台: Windows、XBOX One 系列主机和 XBOX Series 主机
