summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorMichael Drake <tlsa@netsurf-browser.org>2022-03-26 14:13:56 +0000
committerMichael Drake <tlsa@netsurf-browser.org>2022-03-26 14:13:56 +0000
commit6011da798ff305ddee7ef36829f4c8c451cab600 (patch)
tree8a8a9ca2fb19c2a05630ee121a7878818da0060a /include
parent725d1c99112c2882708e44930393225d1b534bf4 (diff)
downloadnetsurf-6011da798ff305ddee7ef36829f4c8c451cab600.tar.gz
netsurf-6011da798ff305ddee7ef36829f4c8c451cab600.tar.bz2
Include: Bitmap: Document bitmap pixel alignment requirement.
Diffstat (limited to 'include')
-rw-r--r--include/netsurf/bitmap.h2
1 files changed, 2 insertions, 0 deletions
diff --git a/include/netsurf/bitmap.h b/include/netsurf/bitmap.h
index dfd11880d..a5be75d74 100644
--- a/include/netsurf/bitmap.h
+++ b/include/netsurf/bitmap.h
@@ -115,6 +115,8 @@ struct gui_bitmap_table {
/**
* Get the image buffer from a bitmap
*
+ * Note that all pixels must be 4-byte aligned.
+ *
* \param bitmap The bitmap to get the buffer from.
* \return The image buffer or NULL if there is none.
*/