IDCompositionVisual::SetClip (constD2D_RECT_F&) 方法 (dcomp.h)

将此视觉对象的 Clip 属性设置为指定的矩形。 Clip 属性将根位于此视觉对象的可视子树的呈现限制为指定的矩形区域。

语法

HRESULT SetClip(
  [in, ref] const D2D_RECT_F & rect
);

参数

[in, ref] rect

类型: const D2D_RECT_F

用于剪裁此视觉对象的矩形。 rect 参数的所有属性的数字限制为 -2^21 到 2^21。 API 接受此范围之外的数字,但它们始终固定到此范围。

返回值

类型: HRESULT

如果函数成功,则返回S_OK。 否则,将返回 HRESULT 错误代码。 有关 错误代码的列表,请参阅 DirectComposition 错误代码

注解

设置 Clip 属性会剪裁此视觉对象以及子树中根植于此视觉对象的所有视觉对象。 剪辑由 OffsetX、OffsetY 和 Transform 属性转换。

如果 Clip 属性以前指定了剪辑对象,则新指定的剪辑矩形将替换剪辑对象。

如果 矩形 结构的任何成员为 NaN、正无穷大或负无穷大,此方法将失败。

如果剪裁矩形为空,则视觉对象将完全剪裁;也就是说,视觉对象包含在可视化树中,但它不呈现任何内容。 若要从合成中排除特定视觉对象,请从可视化树中删除视觉对象,而不是设置空剪辑矩形。 删除视觉对象可提高性能。

要求

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

另请参阅

剪裁

IDCompositionRectangleClip

IDCompositionVisual