MÉTHODE IDCompositionVisual::SetClip(IDCompositionClip*) (dcomp.h)

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

Syntaxe

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

Paramètres

[in, optional] clip

Type : IDCompositionClip*

Objet clip à associer à ce visuel. Ce paramètre peut être NULL. Toutes les propriétés float d’IDCompositionRectangleClip 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 .

Notes

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 rectangle de clip, l’objet Clip qui vient d’être spécifié remplace le rectangle clip.

Cette méthode échoue si clip n’est pas un pointeur non valide ou s’il n’a pas été créé par la même interface IDCompositionDevice que celle qui a créé ce visuel. L’interface ne peut pas être une implémentation personnalisée ; seules les interfaces créées par Microsoft DirectComposition peuvent être utilisées avec cette méthode.

Si clip a la valeur NULL, le visuel n’est pas clippé par rapport à son parent. Toutefois, le visuel est découpé par l’objet clip du visuel parent ou par le visuel ancêtre le plus proche qui a un objet clip. La définition de clip sur NULL est similaire à la spécification d’un objet clip dont le rectangle de clip a les côtés gauche et supérieur définis sur l’infini négatif, et les côtés droit et inférieur définis sur l’infini positif. L’utilisation d’un objet clip NULL génère des performances légèrement meilleures.

Si clip spécifie un objet clip qui a un rectangle 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.

Spécifications

Client minimal pris en charge	Windows 8 [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2012 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	dcomp.h
Bibliothèque	Dcomp.lib
DLL	Dcomp.dll

Voir aussi

Découpage

IDCompositionRectangleClip

IDCompositionVisual