IDXGIOutputDuplication::GetFramePointerShape 方法 (dxgi1_2.h)

获取有关当前桌面框架的新指针形状的信息。

语法

HRESULT GetFramePointerShape(
  [in]  UINT                            PointerShapeBufferSize,
  [out] void                            *pPointerShapeBuffer,
  [out] UINT                            *pPointerShapeBufferSizeRequired,
  [out] DXGI_OUTDUPL_POINTER_SHAPE_INFO *pPointerShapeInfo
);

参数

[in] PointerShapeBufferSize

调用方传递给 pPointerShapeBuffer 参数的缓冲区的大小(以字节为单位)。

[out] pPointerShapeBuffer

指向 GetFramePointerShape 复制并返回新指针形状的像素数据的缓冲区的指针。

[out] pPointerShapeBufferSizeRequired

指向变量的指针,该变量接收 GetFramePointerShape 在pPointerShapeBuffer 的缓冲区中存储新指针形状像素数据所需的字节数。

有关返回所需缓冲区大小的详细信息,请参阅备注。

[out] pPointerShapeInfo

指向接收指针形状信息的 DXGI_OUTDUPL_POINTER_SHAPE_INFO 结构的指针。

返回值

GetFramePointerShape 返回:

  • 如果成功检索了有关新指针形状的信息,S_OK。
  • 如果桌面重复接口无效,DXGI_ERROR_ACCESS_LOST。 当桌面上显示不同类型的图像时,桌面重复界面通常会失效。 这种情况的示例包括:
    • 桌面交换机
    • 模式更改
    • 从 DWM 打开、DWM 关闭或其他全屏应用程序切换
    在这种情况下,应用程序必须释放 IDXGIOutputDuplication 接口,并为新内容创建新的 IDXGIOutputDuplication
  • 如果调用应用程序提供的缓冲区不够大,DXGI_ERROR_MORE_DATA。
  • 如果应用程序调用 GetFramePointerShape 而不拥有桌面映像,则DXGI_ERROR_INVALID_CALL。
  • 如果 GetFramePointerShape 的参数之一不正确,E_INVALIDARG;例如,如果 pPointerShapeInfo 为 NULL。
  • 可能是 DXGI_ERROR 主题中描述的其他错误代码。

备注

GetFramePointerShape 将 size 值存储在 pPointerShapeBufferSizeRequired 的变量中。 此值指定 pPointerShapeBufferSizeRequired 存储新指针形状像素数据所需的字节数。 在以下情况下,可以使用 值来确定要为传递给 pPointerShapeBuffer 的未来缓冲区分配的内存量:

  • GetFramePointerShape 因DXGI_ERROR_MORE_DATA而失败,因为缓冲区不够大。
  • GetFramePointerShape 提供的缓冲区大于所需的缓冲区。 在 pPointerShapeBufferSizeRequired 处返回的大小值通知调用方实际使用的缓冲区空间量与调用方在 PointerShapeBufferSize 参数中分配和指定的缓冲区空间量。
pPointerShapeInfo 参数描述新的指针形状。

要求

   
最低受支持的客户端 Windows 8 [仅限桌面应用]
最低受支持的服务器 Windows Server 2012 [仅限桌面应用]
目标平台 Windows
标头 dxgi1_2.h
Library Dxgi.lib

请参阅

IDXGIOutputDuplication