IDCompositionVisual::SetClip(IDCompositionClip*)-Methode (dcomp.h)

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

Syntax

HRESULT SetClip(
  [in, optional] IDCompositionClip *clip
);

Parameter

[in, optional] clip

Typ: IDCompositionClip*

Das Clipobjekt, das diesem Visual zugeordnet werden soll. Dieser Parameter kann NULL sein. Alle float-Eigenschaften von IDCompositionRectangleClip 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 Cliprechteck angegeben hat, ersetzt das neu angegebene Clip-Objekt das Cliprechteck.

Diese Methode schlägt fehl, wenn clip ein ungültiger Zeiger ist oder nicht von derselben IDCompositionDevice-Schnittstelle erstellt wurde, die dieses Visual erstellt hat. Die Schnittstelle kann keine benutzerdefinierte Implementierung sein. mit dieser Methode können nur schnittstellen verwendet werden, die von Microsoft DirectComposition erstellt wurden.

Wenn clip NULL ist, wird das Visual nicht relativ zum übergeordneten Element beschnitten. Das Visual wird jedoch durch das Clip-Objekt des übergeordneten Visuals oder durch das nächstgelegene Vorgängervisual mit einem Clip-Objekt beschnitten. Das Festlegen von Clip auf NULL ähnelt der Angabe eines Clipobjekts, dessen Cliprechteck die linke und obere Seite auf negative Unendlichkeit und die rechte und untere Seite auf positive Unendlichkeit festgelegt hat. Die Verwendung eines NULL-Clipobjekts führt zu einer etwas besseren Leistung.

Wenn clip ein Clipobjekt angibt, das über ein leeres Rechteck verfügt, 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