IDCompositionSurface::Scroll, méthode (dcomp.h)

Fait défiler une zone rectangulaire d’une surface logique Microsoft DirectComposition.

Syntaxe

HRESULT Scroll(
  [in]           const RECT *scrollRect,
  [in, optional] const RECT *clipRect,
  [in]           int        offsetX,
  [in]           int        offsetY
);

Paramètres

[in] scrollRect

Zone rectangulaire de la surface à faire défiler, par rapport au coin supérieur gauche de la surface. Si ce paramètre a la valeur NULL, l’ensemble de la surface est défilé.

[in, optional] clipRect

ClipRect extrait la destination (scrollRect après décalage) du défilement. Le seul contenu bitmap à faire défiler est celui qui reste à l’intérieur du rectangle de clip une fois le défilement terminé.

[in] offsetX

Quantité de défilement horizontal, en pixels. Utilisez des valeurs positives pour faire défiler vers la droite et des valeurs négatives pour défiler vers la gauche.

[in] offsetY

Quantité de défilement vertical, en pixels. Utilisez des valeurs positives pour faire défiler vers le bas et des valeurs négatives pour faire défiler vers le haut.

Valeur retournée

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 permet à une application de blt/copier un sous-rectangle d’un objet surface DirectComposition. Cela évite le rendu du contenu déjà disponible.

Le rectangle scrollRect doit être contenu dans les limites de la surface. Si le rectangle scrollRect sort des limites de la surface, cette méthode échoue.

Les bits copiés par l’opération de défilement (source) sont définis par l’intersection des rectangles scrollRect et clipRect .

Les bits affichés à l’écran (destination) sont définis par l’intersection du rectangle source de décalage et de clipRect.

Les opérations de défilement ne peuvent être appelées qu’avant l’appel de BeginDraw ou après l’appel de EndDraw. Les surfaces suspendues ou reprises ne sont pas candidates au défilement, car elles sont toujours en cours de mise à jour.

L’application est chargée de s’assurer que la zone de défilement d’un IDCompositionVirtualSurface est limitée à des pixels valides. Le comportement des pixels non valides dans scrollRect n’est pas défini.

Les zones sous-rectangulaires de surface virtuelle qui ont été ignorées par une opération de rognage ou de redimensionnement ne peuvent pas faire l’objet d’un défilement, même si le rognage ou le redimensionnement est appliqué dans le même lot. Le rognage et le redimensionnement sont appliqués immédiatement.

Spécifications

Voir aussi

IDCompositionSurface