XApuEnqueueCommand

向 XAPU 命令队列提交单个命令。

Syntax

HRESULT XApuEnqueueCommand(  
         XApuHandle handle,  
         XApuCommandId* command,  
         uint32_t* totalCommandCount  
)  

Parameters

handle   _In_
Type: XApuHandle 通过调用 XApuConnect 返回的句柄。 command   _In_
Type: XApuCommandId* 要提交到 XAPU 输入队列的命令。 totalCommandCount   _Out_opt_
Type: uint32_t* 返回的命令总数。

Return value

Type: HRESULT 如果成功,则返回 S_OK;否则,返回错误代码。

Remarks

此调用速度很快,因为它不分配资源或处理数据,而只是将命令发送到硬件服务器。如果有 XApuConnectInputParameters::maxQueuedCommandsPerStream 个命令正在处理,则此调用将返回 XAPU_E_QUEUE_FULL。为避免此错误,调用方必须通过 XApuDequeueResult 检索一个或多个结果。此调用是线程安全的,即可以从多个线程提交命令,但从多个线程调用并不能带来性能优势。此调用还接受一个指向 uint32_t 的指针以返回当前会话的 totalCommandCount。该数字表示自会话开始以来以及在调用 XApuConnect 之后已成功提交的命令总数。该数字不会归零。如果硬件服务器处于错误状态,XApuEnqueueCommand 将返回 XAPU_E_DEVICE_FATAL_ERROR 错误代码。在这种情况下,应断开所有 XAPU 客户端并重新连接。如果此方法失败,将返回具有描述性的错误代码。下表将每个 XApuCommandType 映射到应传递给 XApuEnqueueCommand 的结构类型:

XApuCommandType	结构类型
XApuCommandType::Activate	XApuDecodeConvertActivateCommand
XApuCommandType::Deactivate	XApuCommandId
XApuCommandType::Process	XApuDecodeConvertCommand
XApuCommandType::Notify	XApuCommandId
XApuCommandType::Reset	XApuCommandId

Requirements

头文件: xapu.h 库: xapu.lib 支持的平台: XBOX Series X|S

(all) API references

Error codes

Audio API reference

Chat API reference

Developer kit only API reference

Graphics API reference

Input API reference

Lighting API reference

Networking API reference

XBOX PC remote iteration API reference

System API reference

Tools API reference

Windows device portal REST API reference

XBOX services API reference

MicrosoftGame.config reference

XApuEnqueueCommand

XApuEnqueueCommand

Syntax

Parameters

Return value

Remarks

Requirements

See also

​XApuEnqueueCommand

​Syntax

​Parameters

​Return value

​Remarks

​Requirements

​See also

XApuEnqueueCommand

Syntax

Parameters

Return value

Remarks

Requirements

See also