commit f560e067a24e4978a93e407b9dba84f219fa0706
author Lei Zhang <thestig@chromium.org> Tue Aug 20 19:25:59 2019 +0000
committer Chromium commit bot <commit-bot@chromium.org> Tue Aug 20 19:25:59 2019 +0000
tree 5cc93cf3e165ae2d27d3e0dbe810632c4a48bfad
parent 3ead67210db42e40e473cf5cd1715af160c24086

Mention how much memory FPDFBitmap_Create() can allocate.

Currently 4 GB, because CFX_DIBitmap::CalculatePitchAndSize() outputs
the size as a uint32_t.

Change-Id: I5c544290ec52840c91a0963a3a9fa1ef869c9937
Reviewed-on: https://pdfium-review.googlesource.com/c/pdfium/+/59795
Reviewed-by: Tom Sepez <tsepez@chromium.org>
Commit-Queue: Lei Zhang <thestig@chromium.org>

public/fpdfview.h

diff --git a/public/fpdfview.h b/public/fpdfview.h
index 55ab33c..f8c6a99 100644
--- a/public/fpdfview.h
+++ b/public/fpdfview.h
@@ -889,7 +889,8 @@
 //
 //          This function allocates enough memory for holding all pixels in the
 //          bitmap, but it doesn't initialize the buffer. Applications can use
-//          FPDFBitmap_FillRect to fill the bitmap using any color.
+//          FPDFBitmap_FillRect() to fill the bitmap using any color. If the OS
+//          allows it, this function can allocate up to 4 GB of memory.
 FPDF_EXPORT FPDF_BITMAP FPDF_CALLCONV FPDFBitmap_Create(int width,
                                                         int height,
                                                         int alpha);