From e41a9c79b8e57ae704b6d89b02925bcb8d304cc5 Mon Sep 17 00:00:00 2001 From: Michael Miller Date: Mon, 18 Nov 2019 11:15:50 -0800 Subject: [PATCH] Updated NeoBitmapFile object API (markdown) --- NeoBitmapFile-object-API.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/NeoBitmapFile-object-API.md b/NeoBitmapFile-object-API.md index 24859c2..f72372a 100644 --- a/NeoBitmapFile-object-API.md +++ b/NeoBitmapFile-object-API.md @@ -14,7 +14,8 @@ NeoBitmapFile image; ## Methods ### bool Begin(FILE file) This will initialize the NeoBitmapFile to use the given file. It will check the contents of the file for a valid image and configure itself to read data from the file. -It will return false if the file is not a compatible file format. Currently it requires the file to be BMP, 24 or 32 bit, with no compression. +It will return false if the file is not a compatible file format. Currently it requires the file to be BMP, 24 or 32 bit, with no compression. +The `file` instance passed in will be managed by the NeoBitmapFile object so there is no need to close it manually. ### uint16_t PixelSize() const This will return the number of bytes a single pixel takes.