b5230e0685
Added comments for all stb_ functions since I'm now using this program as an illustrative example of the value of something like stb_ functions. |
||
|---|---|---|
| deprecated | ||
| docs | ||
| tests | ||
| tools | ||
| README.md | ||
| stb.h | ||
| stb_c_lexer.h | ||
| stb_divide.h | ||
| stb_dxt.h | ||
| stb_image.h | ||
| stb_image_write.h | ||
| stb_perlin.h | ||
| stb_textedit.h | ||
| stb_truetype.h | ||
| stb_vorbis.c | ||
| stretchy_buffer.h | ||
README.md
stb
single-file public domain libraries for C/C++
| library | lastest version | category | description |
|---|---|---|---|
| stb_vorbis.c | 1.0 | audio | decode ogg vorbis files from file/memory to float/16-bit signed output |
| stb_image.h | 1.36 | graphics | image loading/decoding from file/memory: JPG, PNG, TGA, BMP, PSD, GIF, HDR, PIC |
| stb_truetype.h | 0.8 | graphics | parse, decode, and rasterize characters from truetype fonts |
| stb_image_write.h | 0.94 | graphics | image writing to disk: PNG, TGA, BMP |
| stretchy_buffer.h | 1.01 | utility | typesafe dynamic array for C (i.e. approximation to vector<>), doesn't compile as C++ |
| stb_textedit.h | 1.2 | UI | guts of a text editor for games etc implementing them from scratch |
| stb_dxt.h | 1.04 | 3D graphics | Fabian "ryg" Giesen's real-time DXT compressor |
| stb_perlin.h | 0.2 | 3D graphics | revised Perlin noise (3D input, 1D output) |
| stb_c_lexer.h | 0.04 | parsing | simplify writing parsers for C-like languages |
| stb_divide.h | 0.91 | math | more useful 32-bit modulus e.g. "euclidean divide" |
| stb.h | 2.23 | misc | helper functions for C, mostly redundant in C++; basically author's personal stuff |
FAQ
What's the license?
These libraries are in the public domain (or the equivalent where that is not possible). You can do anything you want with them. You have no legal obligation to do anything else, although I appreciate attribution.
If I wrap an stb library in a new library, does the new library have to be public domain?
No.
A lot of these libraries seem redundant to existing open source libraries. Are they better somehow?
Generally they're only better in that they're easier to integrate, easier to use, and easier to release (single file; good API; no attribution requirement). They may be less featureful, slower, and/or use more memory. If you're already using an equivalent library, there's probably no good reason to switch.
Why "stb"? Is this something to do with Set-Top Boxes?
No, they are just the initials for my name, Sean T. Barrett. This was not chosen out of egomania, but as a semi-robust way of namespacing the filenames and source function names.
Will you add more image types to stb_image.c?
If people submit them, I generally add them, but the goal of stb_image is less for applications like image viewer apps (which need to support every type of image under the sun) and more for things like games which can choose what images to use, so I may decline to add them if they're too rare or if the size of implementation vs. apparent benefit is too low.
Are there other single-file public-domain libraries out there?
Yes. I'll put a list here when people remind me what they are.
Do you have any advice on how to create my own single-file library?
Yes. https://github.com/nothings/stb/blob/master/docs/stb_howto.txt
Why public domain?
Because more people will use it. Because it's not viral, people are not obligated to give back, so you could argue that it hurts the development of it, and then because it doesn't develop as well it's not as good, and then because it's not as good, in the long run maybe fewer people will use it. I have total respect for that opinion, but I just don't believe it myself for most software.
Why C?
Primarily, because I use C, not C++. But it does also make it easier for other people to use them from other languages.
Why not C99? stdint.h, declare-anywhere, etc.
I still use MSVC 6 (1998) as my IDE because it has better human factors for me than later versions of MSVC.