Document SubPixmap.xferTo()

and improve docs slightly.
This commit is contained in:
Elias Batek 2024-10-06 00:19:32 +02:00
parent 1d0822c89a
commit 38301f1507
1 changed files with 16 additions and 0 deletions

View File

@ -416,7 +416,17 @@ struct SubPixmap {
} }
} }
/++
Blends the pixels of this subimage into a target image.
The target MUST have the same size.
See_also:
Usually youll want to use [drawPixmap] instead.
+/
public void xferTo(SubPixmap target, Blend blend = blendNormal) const { public void xferTo(SubPixmap target, Blend blend = blendNormal) const {
debug assert(target.size == this.size);
auto src = SubPixmapScanner(this); auto src = SubPixmapScanner(this);
auto dst = SubPixmapScannerRW(target); auto dst = SubPixmapScannerRW(target);
@ -630,6 +640,8 @@ struct SubPixmap {
} }
/++ /++
$(I Advanced functionality.)
Wrapper for scanning a [Pixmap] line by line. Wrapper for scanning a [Pixmap] line by line.
+/ +/
struct PixmapScanner { struct PixmapScanner {
@ -663,6 +675,8 @@ struct PixmapScanner {
} }
/++ /++
$(I Advanced functionality.)
Wrapper for scanning a [Pixmap] line by line. Wrapper for scanning a [Pixmap] line by line.
+/ +/
struct SubPixmapScanner { struct SubPixmapScanner {
@ -703,6 +717,8 @@ struct SubPixmapScanner {
} }
/++ /++
$(I Advanced functionality.)
Wrapper for scanning a [Pixmap] line by line. Wrapper for scanning a [Pixmap] line by line.
See_also: See_also: