IDCompositionSurface::Scroll-Methode (dcomp.h)
Scrollt einen rechteckigen Bereich einer logischen Microsoft DirectComposition-Oberfläche.
Syntax
HRESULT Scroll(
[in] const RECT *scrollRect,
[in, optional] const RECT *clipRect,
[in] int offsetX,
[in] int offsetY
);
Parameter
[in] scrollRect
Der rechteckige Bereich der zu scrollenden Oberfläche relativ zur oberen linken Ecke der Oberfläche. Wenn dieser Parameter NULL ist, wird die gesamte Oberfläche gescrollt.
[in, optional] clipRect
Der clipRect-Clip das Ziel (scrollRect nach Offset) des Bildlaufs. Die einzigen Bitmapinhalte, die gescrollt werden, sind diejenigen, die nach Abschluss des Bildlaufs innerhalb des Cliprechtecks verbleiben.
[in] offsetX
Die Menge des horizontalen Bildlaufs in Pixel. Verwenden Sie positive Werte, um nach rechts zu scrollen, und negative Werte, um nach links zu scrollen.
[in] offsetY
Die Menge des vertikalen Bildlaufs in Pixel. Verwenden Sie positive Werte, um nach unten zu scrollen, und negative Werte, um nach oben zu scrollen.
Rückgabewert
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
Mit dieser Methode kann eine Anwendung ein Unterrechteck eines DirectComposition-Oberflächenobjekts blt/kopieren. Dadurch wird das erneute Rendern von Inhalten vermieden, die bereits verfügbar sind.
Das rechteck scrollRect muss in den Begrenzungen der Oberfläche enthalten sein. Wenn das rechteck scrollRect die Grenzen der Oberfläche überschreitet, schlägt diese Methode fehl.
Die vom Bildlaufvorgang (Quelle) kopierten Bits werden durch die Schnittmenge der Rechtecke scrollRect und clipRect definiert.
Die auf dem Bildschirm (Ziel) angezeigten Bits werden durch die Schnittmenge des Offsetquellrechtecks und clipRect definiert.
Bildlaufvorgänge können nur vor dem Aufrufen von BeginDraw oder nach dem Aufruf von EndDraw aufgerufen werden. Angehaltene oder fortgesetzte Oberflächen sind keine Kandidaten für den Bildlauf, da sie noch aktualisiert werden.
Die Anwendung ist dafür verantwortlich, sicherzustellen, dass der scrollbare Bereich für eine IDCompositionVirtualSurface auf gültige Pixel beschränkt ist. Das Verhalten für ungültige Pixel in scrollRect ist nicht definiert.
Virtuelle Flächen mit untergeordnetem Rechteck, die durch einen Kürzungs- oder Größenänderungsvorgang verworfen wurden, können auch dann nicht scrollen, wenn die Kürzung oder Größenänderung im selben Batch angewendet wird. Kürzen und Ändern der Größe werden sofort angewendet.
Anforderungen
| Unterstützte Mindestversion (Client) | Windows 8 [nur Desktop-Apps] |
| Unterstützte Mindestversion (Server) | Windows Server 2012 [nur Desktop-Apps] |
| Zielplattform | Windows |
| Kopfzeile | dcomp.h |
| Bibliothek | Dcomp.lib |
| DLL | Dcomp.dll |