starred/bmplib
1
0
Fork 0
mirror of https://github.com/rupertwh/bmplib.git synced 2026-07-08 18:06:05 +00:00
Code Issues 1 Packages Projects Releases 4 Wiki Activity

Docs update

Browse Source
This commit is contained in:
Rupert
2025-06-21 13:24:25 +02:00
parent c8ead48e33
commit 7ece494541
2 changed files with 8 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
API-full.md
View File

@@ -314,11 +314,14 @@ First completely read one image before proceeding to the next one.
OS/2 icons and pointers are often contained in bitmap arrays.
Some limitations apply for loading icons and pointers:
- The image is always returned as RGBA, loading index values and palette does
not work (yet).
- The image is always returned as 8 bit per channel RGBA, loading index values
and palette is not supported.
- Maximum supported size is 512x512. This shouldn't be limiting for actual
legacy icons and pointers.
- RLE is not supported (yet)
- For RLE images, undefined mode is always assumed to be
`BMP_UNDEFINED_LEAVE`, regardless of what `bmpread_set_undefined()` was set
to. (Because icons and pointers have their own mask-based transparency
scheme.)
### 1.11. Load the image

34
README.md
View File

@@ -32,7 +32,7 @@ Download [bmplib on github](https://github.com/rupertwh/bmplib).
BMP_RESULT_PNG and leave the file pointer in the correct state to be
passed on to either libpng or libjpeg. Works as designed. Don't want to
create dependency on those libs.
- We currently ignore icc-profiles and chromaticity/gamma values. See TODO.
- We currently ignore chromaticity/gamma values from V4+ headers. See TODO.
### Writing BMP files:
@@ -136,31 +136,14 @@ Microsoft tools, the new GIMP 3.0 is the only one I am aware of). Use
## TODOs:
### Definitely:
- [x] write indexed images.
- [x] write RLE-compressed images ~~(RLE4/RLE8 only. No OS/2 v2 BMPs)~~.
- [x] read RLE24-encoded BMPs.
- [x] read Huffman-encoded BMPs. (Still haven't found any real-life examples)
- [x] line-by-line reading/writing. ~~Right now, the image can only be
passed as a whole to/from bmplib.~~
- [x] read/write icc-profile and chromaticity/gamma values
- [x] sanity checks for size of of image / palette. Require confirmation
above a certain size (~ 500MB?)
- [x] store undefined pixels (RLE delta and early EOL/EOF) as alpha
- [ ] read/write chromaticity/gamma values
### Maybe:
- [x] passing indexed data and palette to user (optionally) instead of
RGB-data.
- [ ] interpret icc-profile, to enable giving at least sRGB/not-sRGB info.
(Like sRGB / probably-sRGB / maybe-sRGB). Torn on that one, would need
dependency on liblcms2.
- [x] "BA"-files (bitmap-arrays). Either return the first bitmap only
(which is the 'official' default) or let user pick one/multiple/all to
be read in sequence.
- [ ] Add a 'not-a-BMP-file' return type instead of just returning error.
- [x] icon- and pointer-files ("CI", "CP", "IC", "PT").
- [x] 64-bits BMPs. (I changed my mind)
### Unclear:
@@ -169,19 +152,6 @@ Microsoft tools, the new GIMP 3.0 is the only one I am aware of). Use
platforms/cpus. And Windows?
### Non-feature (internal):
- [x] complete API description (see API-full.md and API-quick-start.md)
- [x] bmp-read.c is getting too big, split into several files
## Misc:
- [x] License: probably LPGL3? That's what I'm going with for now.
Cheers,
Rupert