IDCompositionVisual::SetOffsetY(float), méthode (dcomp.h)

Modifie la valeur de la propriété OffsetY de ce visuel. La propriété OffsetY spécifie le nouveau décalage du visuel le long de l’axe y, par rapport au visuel parent.

Syntaxe

HRESULT SetOffsetY(
  [in] float offsetY
);

Paramètres

[in] offsetY

Type : float

Nouveau décalage du visuel le long de l’axe y, en pixels.

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

Cette méthode échoue si le paramètre offsetY est NaN, infini positif ou infini négatif.

La modification de la propriété OffsetY transforme le système de coordonnées de l’ensemble de la sous-arborescence visuelle enracinée sur ce visuel. Si la propriété Clip de ce visuel est spécifiée, le rectangle de clip est également transformé.

Une transformation spécifiée par la propriété Transform est appliquée après la propriété OffsetY. En d’autres termes, l’effet de la définition de la propriété Transform et de la propriété OffsetY est identique à la définition de la propriété Transform uniquement sur un objet de groupe de transformation où le premier membre du groupe est un objet IDCompositionTranslateTranslateTransform qui a la même valeur OffsetY que offsetY. Toutefois, vous devez utiliser IDCompositionVisual::SetOffsetY chaque fois que possible, car il est légèrement plus rapide.

Si les propriétés OffsetX et OffsetY ont la valeur 0 et que la propriété Transform a la valeur NULL, le système de coordonnées du visuel est le même que celui de son parent.

Si la propriété OffsetY était précédemment animée, cette méthode supprime l’animation et définit la propriété sur la valeur statique spécifiée.

Exemples

Pour obtenir un exemple, consultez Création d’une arborescence visuelle simple.

Spécifications

Voir aussi

IDCompositionVisual

IDCompositionVisual::SetOffsetX

IDCompositionVisual::SetTransform