MÉTHODE IDCompositionVisual ::SetClip(constD2D_RECT_F&) (dcomp.h)

Définit la propriété Clip de ce visuel sur le rectangle spécifié. La propriété Clip limite le rendu de la sous-arborescence visuelle enracinée au niveau de ce visuel à la zone rectangulaire spécifiée.

Syntaxe

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

Paramètres

[in, ref] rect

Type : const D2D_RECT_F

Rectangle à utiliser pour découper ce visuel. Toutes les propriétés du paramètre rect ont une limite numérique de -2^21 à 2^21. L’API accepte des nombres en dehors de cette plage, mais ils sont toujours limités à cette plage.

Valeur retournée

Type : HRESULT

Si la fonction réussit, elle retourne S_OK. Sinon, elle retourne un code d’erreur HRESULT. Pour obtenir la liste des codes d’erreur, consultez Codes d’erreur DirectComposition .

Remarques

La définition de la propriété Clip extrait ce visuel avec tous les visuels de la sous-arborescence qui est enracinée sur ce visuel. Le clip est transformé par les propriétés OffsetX, OffsetY et Transform.

Si la propriété Clip a précédemment spécifié un objet clip, le rectangle de clip nouvellement spécifié remplace l’objet clip.

Cette méthode échoue si les membres de la structure rect sont NaN, l’infini positif ou l’infini négatif.

Si le rectangle de clip est vide, le visuel est entièrement clippé ; autrement dit, le visuel est inclus dans l’arborescence du visuel, mais il ne rend rien. Pour exclure un visuel particulier d’une composition, supprimez-le de l’arborescence visuelle au lieu de définir un rectangle de clip vide. La suppression du visuel entraîne de meilleures performances.

Configuration requise

Voir aussi

Découpage

IDCompositionRectangleClip

IDCompositionVisual