| 1 |
<!--- THIS FILE IS AUTOMATICALLY GENERATED, DO NOT CHANGE IT BY HAND ---> |
| 2 |
|
| 3 |
stb |
| 4 |
=== |
| 5 |
|
| 6 |
single-file public domain (or MIT licensed) libraries for C/C++ |
| 7 |
|
| 8 |
Noteworthy: |
| 9 |
|
| 10 |
* image loader: [stb_image.h](stb_image.h) |
| 11 |
* image writer: [stb_image_write.h](stb_image_write.h) |
| 12 |
* image resizer: [stb_image_resize.h](stb_image_resize.h) |
| 13 |
* font text rasterizer: [stb_truetype.h](stb_truetype.h) |
| 14 |
* typesafe containers: [stb_ds.h](stb_ds.h) |
| 15 |
|
| 16 |
Most libraries by stb, except: stb_dxt by Fabian "ryg" Giesen, stb_image_resize |
| 17 |
by Jorge L. "VinoBS" Rodriguez, and stb_sprintf by Jeff Roberts. |
| 18 |
|
| 19 |
<a name="stb_libs"></a> |
| 20 |
|
| 21 |
library | lastest version | category | LoC | description |
| 22 |
--------------------- | ---- | -------- | --- | -------------------------------- |
| 23 |
**[stb_vorbis.c](stb_vorbis.c)** | 1.20 | audio | 5563 | decode ogg vorbis files from file/memory to float/16-bit signed output |
| 24 |
**[stb_image.h](stb_image.h)** | 2.26 | graphics | 7762 | image loading/decoding from file/memory: JPG, PNG, TGA, BMP, PSD, GIF, HDR, PIC |
| 25 |
**[stb_truetype.h](stb_truetype.h)** | 1.24 | graphics | 5011 | parse, decode, and rasterize characters from truetype fonts |
| 26 |
**[stb_image_write.h](stb_image_write.h)** | 1.15 | graphics | 1690 | image writing to disk: PNG, TGA, BMP |
| 27 |
**[stb_image_resize.h](stb_image_resize.h)** | 0.96 | graphics | 2631 | resize images larger/smaller with good quality |
| 28 |
**[stb_rect_pack.h](stb_rect_pack.h)** | 1.00 | graphics | 628 | simple 2D rectangle packer with decent quality |
| 29 |
**[stb_ds.h](stb_ds.h)** | 0.65 | utility | 1880 | typesafe dynamic array and hash tables for C, will compile in C++ |
| 30 |
**[stb_sprintf.h](stb_sprintf.h)** | 1.09 | utility | 1879 | fast sprintf, snprintf for C/C++ |
| 31 |
**[stretchy_buffer.h](stretchy_buffer.h)** | 1.04 | utility | 263 | typesafe dynamic array for C (i.e. approximation to vector<>), doesn't compile as C++ |
| 32 |
**[stb_textedit.h](stb_textedit.h)** | 1.13 | user interface | 1404 | guts of a text editor for games etc implementing them from scratch |
| 33 |
**[stb_voxel_render.h](stb_voxel_render.h)** | 0.89 | 3D graphics | 3807 | Minecraft-esque voxel rendering "engine" with many more features |
| 34 |
**[stb_dxt.h](stb_dxt.h)** | 1.10 | 3D graphics | 753 | Fabian "ryg" Giesen's real-time DXT compressor |
| 35 |
**[stb_perlin.h](stb_perlin.h)** | 0.5 | 3D graphics | 428 | revised Perlin noise (3D input, 1D output) |
| 36 |
**[stb_easy_font.h](stb_easy_font.h)** | 1.1 | 3D graphics | 305 | quick-and-dirty easy-to-deploy bitmap font for printing frame rate, etc |
| 37 |
**[stb_tilemap_editor.h](stb_tilemap_editor.h)** | 0.41 | game dev | 4161 | embeddable tilemap editor |
| 38 |
**[stb_herringbone_wa...](stb_herringbone_wang_tile.h)** | 0.7 | game dev | 1221 | herringbone Wang tile map generator |
| 39 |
**[stb_c_lexer.h](stb_c_lexer.h)** | 0.11 | parsing | 966 | simplify writing parsers for C-like languages |
| 40 |
**[stb_divide.h](stb_divide.h)** | 0.93 | math | 430 | more useful 32-bit modulus e.g. "euclidean divide" |
| 41 |
**[stb_connected_comp...](stb_connected_components.h)** | 0.96 | misc | 1049 | incrementally compute reachability on grids |
| 42 |
**[stb.h](stb.h)** | 2.37 | misc | 14454 | helper functions for C, mostly redundant in C++; basically author's personal stuff |
| 43 |
**[stb_leakcheck.h](stb_leakcheck.h)** | 0.6 | misc | 194 | quick-and-dirty malloc/free leak-checking |
| 44 |
**[stb_include.h](stb_include.h)** | 0.02 | misc | 295 | implement recursive #include support, particularly for GLSL |
| 45 |
|
| 46 |
Total libraries: 22 |
| 47 |
Total lines of C code: 56774 |
| 48 |
|
| 49 |
|
| 50 |
FAQ |
| 51 |
--- |
| 52 |
|
| 53 |
#### What's the license? |
| 54 |
|
| 55 |
These libraries are in the public domain. You can do anything you |
| 56 |
want with them. You have no legal obligation |
| 57 |
to do anything else, although I appreciate attribution. |
| 58 |
|
| 59 |
They are also licensed under the MIT open source license, if you have lawyers |
| 60 |
who are unhappy with public domain. Every source file includes an explicit |
| 61 |
dual-license for you to choose from. |
| 62 |
|
| 63 |
#### <a name="other_libs"></a> Are there other single-file public-domain/open source libraries with minimal dependencies out there? |
| 64 |
|
| 65 |
[Yes.](https://github.com/nothings/single_file_libs) |
| 66 |
|
| 67 |
#### If I wrap an stb library in a new library, does the new library have to be public domain/MIT? |
| 68 |
|
| 69 |
No, because it's public domain you can freely relicense it to whatever license your new |
| 70 |
library wants to be. |
| 71 |
|
| 72 |
#### What's the deal with SSE support in GCC-based compilers? |
| 73 |
|
| 74 |
stb_image will either use SSE2 (if you compile with -msse2) or |
| 75 |
will not use any SIMD at all, rather than trying to detect the |
| 76 |
processor at runtime and handle it correctly. As I understand it, |
| 77 |
the approved path in GCC for runtime-detection require |
| 78 |
you to use multiple source files, one for each CPU configuration. |
| 79 |
Because stb_image is a header-file library that compiles in only |
| 80 |
one source file, there's no approved way to build both an |
| 81 |
SSE-enabled and a non-SSE-enabled variation. |
| 82 |
|
| 83 |
While we've tried to work around it, we've had multiple issues over |
| 84 |
the years due to specific versions of gcc breaking what we're doing, |
| 85 |
so we've given up on it. See https://github.com/nothings/stb/issues/280 |
| 86 |
and https://github.com/nothings/stb/issues/410 for examples. |
| 87 |
|
| 88 |
#### Some of these libraries seem redundant to existing open source libraries. Are they better somehow? |
| 89 |
|
| 90 |
Generally they're only better in that they're easier to integrate, |
| 91 |
easier to use, and easier to release (single file; good API; no |
| 92 |
attribution requirement). They may be less featureful, slower, |
| 93 |
and/or use more memory. If you're already using an equivalent |
| 94 |
library, there's probably no good reason to switch. |
| 95 |
|
| 96 |
#### Can I link directly to the table of stb libraries? |
| 97 |
|
| 98 |
You can use [this URL](https://github.com/nothings/stb#stb_libs) to link directly to that list. |
| 99 |
|
| 100 |
#### Why do you list "lines of code"? It's a terrible metric. |
| 101 |
|
| 102 |
Just to give you some idea of the internal complexity of the library, |
| 103 |
to help you manage your expectations, or to let you know what you're |
| 104 |
getting into. While not all the libraries are written in the same |
| 105 |
style, they're certainly similar styles, and so comparisons between |
| 106 |
the libraries are probably still meaningful. |
| 107 |
|
| 108 |
Note though that the lines do include both the implementation, the |
| 109 |
part that corresponds to a header file, and the documentation. |
| 110 |
|
| 111 |
#### Why single-file headers? |
| 112 |
|
| 113 |
Windows doesn't have standard directories where libraries |
| 114 |
live. That makes deploying libraries in Windows a lot more |
| 115 |
painful than open source developers on Unix-derivates generally |
| 116 |
realize. (It also makes library dependencies a lot worse in Windows.) |
| 117 |
|
| 118 |
There's also a common problem in Windows where a library was built |
| 119 |
against a different version of the runtime library, which causes |
| 120 |
link conflicts and confusion. Shipping the libs as headers means |
| 121 |
you normally just compile them straight into your project without |
| 122 |
making libraries, thus sidestepping that problem. |
| 123 |
|
| 124 |
Making them a single file makes it very easy to just |
| 125 |
drop them into a project that needs them. (Of course you can |
| 126 |
still put them in a proper shared library tree if you want.) |
| 127 |
|
| 128 |
Why not two files, one a header and one an implementation? |
| 129 |
The difference between 10 files and 9 files is not a big deal, |
| 130 |
but the difference between 2 files and 1 file is a big deal. |
| 131 |
You don't need to zip or tar the files up, you don't have to |
| 132 |
remember to attach *two* files, etc. |
| 133 |
|
| 134 |
#### Why "stb"? Is this something to do with Set-Top Boxes? |
| 135 |
|
| 136 |
No, they are just the initials for my name, Sean T. Barrett. |
| 137 |
This was not chosen out of egomania, but as a moderately sane |
| 138 |
way of namespacing the filenames and source function names. |
| 139 |
|
| 140 |
#### Will you add more image types to stb_image.h? |
| 141 |
|
| 142 |
No. As stb_image use has grown, it has become more important |
| 143 |
for us to focus on security of the codebase. Adding new image |
| 144 |
formats increases the amount of code we need to secure, so it |
| 145 |
is no longer worth adding new formats. |
| 146 |
|
| 147 |
#### Do you have any advice on how to create my own single-file library? |
| 148 |
|
| 149 |
Yes. https://github.com/nothings/stb/blob/master/docs/stb_howto.txt |
| 150 |
|
| 151 |
#### Why public domain? |
| 152 |
|
| 153 |
I prefer it over GPL, LGPL, BSD, zlib, etc. for many reasons. |
| 154 |
Some of them are listed here: |
| 155 |
https://github.com/nothings/stb/blob/master/docs/why_public_domain.md |
| 156 |
|
| 157 |
#### Why C? |
| 158 |
|
| 159 |
Primarily, because I use C, not C++. But it does also make it easier |
| 160 |
for other people to use them from other languages. |
| 161 |
|
| 162 |
#### Why not C99? stdint.h, declare-anywhere, etc. |
| 163 |
|
| 164 |
I still use MSVC 6 (1998) as my IDE because it has better human factors |
| 165 |
for me than later versions of MSVC. |