IDCompositionVisual::SetClip(constD2D_RECT_F&)-Methode (dcomp.h)

Legt die Clip-Eigenschaft dieses Visuals auf das angegebene Rechteck fest. Die Clip-Eigenschaft schränkt das Rendern der visuellen Unterstruktur, die in diesem Visual verankert ist, auf den angegebenen rechteckigen Bereich ein.

Syntax

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

Parameter

[in, ref] rect

Typ: const D2D_RECT_F

Das Rechteck, das zum Beschneiden dieses Visuals verwendet werden soll. Alle Eigenschaften des Rect-Parameters weisen einen numerischen Grenzwert von -2^21 bis 2^21 auf. Die API akzeptiert Zahlen außerhalb dieses Bereichs, aber sie werden immer in diesen Bereich eingespannt.

Rückgabewert

Typ: HRESULT

Wenn die Funktion erfolgreich ist, wird S_OK zurückgegeben. Andernfalls wird ein Fehlercode HRESULT zurückgegeben. Eine Liste der Fehlercodes finden Sie unter DirectComposition-Fehlercodes .

Hinweise

Durch Das Festlegen der Clip-Eigenschaft wird dieses Visual zusammen mit allen Visuals in der Unterstruktur, die in diesem Visual verankert ist, angeschnitten. Der Clip wird durch die Eigenschaften OffsetX, OffsetY und Transform transformiert.

Wenn die Clip-Eigenschaft zuvor ein Clip-Objekt angegeben hat, ersetzt das neu angegebene Cliprechteck das Clipobjekt.

Diese Methode schlägt fehl, wenn Elemente der Rect-Struktur NaN, positive Unendlichkeit oder negative Unendlichkeit sind.

Wenn das Cliprechteck leer ist, wird das Visual vollständig beschnitten. Das bedeutet, dass das Visual in der visuellen Struktur enthalten ist, aber es rendert nichts. Um ein bestimmtes Visual aus einer Komposition auszuschließen, entfernen Sie das Visual aus der visuellen Struktur, anstatt ein leeres Cliprechteck festzulegen. Das Entfernen des Visuals führt zu einer besseren Leistung.

Anforderungen

Weitere Informationen

Freistellen

IDCompositionRectangleClip

IDCompositionVisual