Fix and improve documentation of PixmapPaint

This commit is contained in:
Elias Batek 2024-10-06 03:55:04 +02:00
parent 1d2f907d3c
commit eade7a3754
1 changed files with 11 additions and 2 deletions

View File

@ -402,7 +402,7 @@ struct SubPixmap {
return size.height; return size.height;
} }
/// height /// ditto
void height(int value) { void height(int value) {
size.height = value; size.height = value;
} }
@ -477,6 +477,15 @@ struct SubPixmap {
Both defects could indicate an invalid subimage. Both defects could indicate an invalid subimage.
Use this function to verify the SubPixmap. Use this function to verify the SubPixmap.
) )
$(WARNING
Do not use invalid SubPixmaps.
The library assumes that the SubPixmaps it receives are always valid.
Non-valid SubPixmaps are not meant to be used for creative effects
or similar either. Such uses might lead to unexpected quirks or
crashes eventually.
)
+/ +/
bool isValid() const { bool isValid() const {
return ( return (
@ -860,7 +869,7 @@ struct SubPixmapScanner {
Wrapper for scanning a [Pixmap] line by line. Wrapper for scanning a [Pixmap] line by line.
See_also: See_also:
Unlike [SubPixmapScanner], this does not work with `const(Pixmap)`. Unlike [SubPixmapScanner], this does not work with `const(SubPixmap)`.
+/ +/
struct SubPixmapScannerRW { struct SubPixmapScannerRW {
private { private {