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
程式庫 Dcomp.lib
Dll Dcomp.dll

另請參閱

裁剪

IDCompositionRectangleClip

IDCompositionVisual