|
| 1 | +<!--- THIS FILE IS AUTOMATICALLY GENERATED, DO NOT CHANGE IT BY HAND ---> |
| 2 | + |
| 3 | +stb |
| 4 | +=== |
| 5 | + |
| 6 | +single-file public domain libraries for C/C++ <a name="stb_libs"></a> |
| 7 | + |
| 8 | +library | lastest version | category | LoC | description |
| 9 | +--------------------- | ---- | -------- | --- | -------------------------------- |
| 10 | +**stb_vorbis.c** | 1.07 | audio | 5462 | decode ogg vorbis files from file/memory to float/16-bit signed output |
| 11 | +**stb_image.h** | 2.10 | graphics | 6614 | image loading/decoding from file/memory: JPG, PNG, TGA, BMP, PSD, GIF, HDR, PIC |
| 12 | +**stb_truetype.h** | 1.09 | graphics | 3249 | parse, decode, and rasterize characters from truetype fonts |
| 13 | +**stb_image_write.h** | 1.01 | graphics | 1044 | image writing to disk: PNG, TGA, BMP |
| 14 | +**stb_image_resize.h** | 0.90 | graphics | 2586 | resize images larger/smaller with good quality |
| 15 | +**stb_rect_pack.h** | 0.08 | graphics | 572 | simple 2D rectangle packer with decent quality |
| 16 | +**stretchy_buffer.h** | 1.02 | utility | 216 | typesafe dynamic array for C (i.e. approximation to vector<>), doesn't compile as C++ |
| 17 | +**stb_textedit.h** | 1.7 | user interface | 1301 | guts of a text editor for games etc implementing them from scratch |
| 18 | +**stb_voxel_render.h** | 0.83 | 3D graphics | 3750 | Minecraft-esque voxel rendering "engine" with many more features |
| 19 | +**stb_dxt.h** | 1.04 | 3D graphics | 630 | Fabian "ryg" Giesen's real-time DXT compressor |
| 20 | +**stb_perlin.h** | 0.2 | 3D graphics | 182 | revised Perlin noise (3D input, 1D output) |
| 21 | +**stb_easy_font.h** | 0.7 | 3D graphics | 258 | quick-and-dirty easy-to-deploy bitmap font for printing frame rate, etc |
| 22 | +**stb_tilemap_editor.h** | 0.37 | game dev | 4131 | embeddable tilemap editor |
| 23 | +**stb_herringbone_wa...** | 0.6 | game dev | 1220 | herringbone Wang tile map generator |
| 24 | +**stb_c_lexer.h** | 0.07 | parsing | 816 | simplify writing parsers for C-like languages |
| 25 | +**stb_divide.h** | 0.91 | math | 379 | more useful 32-bit modulus e.g. "euclidean divide" |
| 26 | +**stb.h** | 2.26 | misc | 14184 | helper functions for C, mostly redundant in C++; basically author's personal stuff |
| 27 | +**stb_leakcheck.h** | 0.2 | misc | 124 | quick-and-dirty malloc/free leak-checking |
| 28 | + |
| 29 | +Total libraries: 18 |
| 30 | +Total lines of C code: 46718 |
| 31 | + |
| 32 | + |
| 33 | +FAQ |
| 34 | +--- |
| 35 | + |
| 36 | +#### What's the license? |
| 37 | + |
| 38 | +These libraries are in the public domain (or the equivalent where that is not |
| 39 | +possible). You can do anything you want with them. You have no legal obligation |
| 40 | +to do anything else, although I appreciate attribution. |
| 41 | + |
| 42 | +#### <a name="other_libs"></a> Are there other single-file public-domain/open source libraries with minimal dependencies out there? |
| 43 | + |
| 44 | +[Yes.](https://github.com/nothings/stb/blob/master/docs/other_libs.md) |
| 45 | + |
| 46 | +#### If I wrap an stb library in a new library, does the new library have to be public domain? |
| 47 | + |
| 48 | +No. |
| 49 | + |
| 50 | +#### Some of these libraries seem redundant to existing open source libraries. Are they better somehow? |
| 51 | + |
| 52 | +Generally they're only better in that they're easier to integrate, |
| 53 | +easier to use, and easier to release (single file; good API; no |
| 54 | +attribution requirement). They may be less featureful, slower, |
| 55 | +and/or use more memory. If you're already using an equivalent |
| 56 | +library, there's probably no good reason to switch. |
| 57 | + |
| 58 | +###### Can I link directly to the table of stb libraries? |
| 59 | + |
| 60 | +You can use [this URL](https://github.com/nothings/stb#stb_libs) to link directly to that list. |
| 61 | + |
| 62 | +#### Why do you list "lines of code"? It's a terrible metric. |
| 63 | + |
| 64 | +Just to give you some idea of the internal complexity of the library, |
| 65 | +to help you manage your expectations, or to let you know what you're |
| 66 | +getting into. While not all the libraries are written in the same |
| 67 | +style, they're certainly similar styles, and so comparisons between |
| 68 | +the libraries are probably still meaningful. |
| 69 | + |
| 70 | +Note though that the lines do include both the implementation, the |
| 71 | +part that corresponds to a header file, and the documentation. |
| 72 | + |
| 73 | +#### Why single-file headers? |
| 74 | + |
| 75 | +Windows doesn't have standard directories where libraries |
| 76 | +live. That makes deploying libraries in Windows a lot more |
| 77 | +painful than open source developers on Unix-derivates generally |
| 78 | +realize. (It also makes library dependencies a lot worse in Windows.) |
| 79 | + |
| 80 | +There's also a common problem in Windows where a library was built |
| 81 | +against a different version of the runtime library, which causes |
| 82 | +link conflicts and confusion. Shipping the libs as headers means |
| 83 | +you normally just compile them straight into your project without |
| 84 | +making libraries, thus sidestepping that problem. |
| 85 | + |
| 86 | +Making them a single file makes it very easy to just |
| 87 | +drop them into a project that needs them. (Of course you can |
| 88 | +still put them in a proper shared library tree if you want.) |
| 89 | + |
| 90 | +Why not two files, one a header and one an implementation? |
| 91 | +The difference between 10 files and 9 files is not a big deal, |
| 92 | +but the difference between 2 files and 1 file is a big deal. |
| 93 | +You don't need to zip or tar the files up, you don't have to |
| 94 | +remember to attach *two* files, etc. |
| 95 | + |
| 96 | +#### Why "stb"? Is this something to do with Set-Top Boxes? |
| 97 | + |
| 98 | +No, they are just the initials for my name, Sean T. Barrett. |
| 99 | +This was not chosen out of egomania, but as a moderately sane |
| 100 | +way of namespacing the filenames and source function names. |
| 101 | + |
| 102 | +#### Will you add more image types to stb_image.c? |
| 103 | + |
| 104 | +If people submit them, I generally add them, but the goal of stb_image |
| 105 | +is less for applications like image viewer apps (which need to support |
| 106 | +every type of image under the sun) and more for things like games which |
| 107 | +can choose what images to use, so I may decline to add them if they're |
| 108 | +too rare or if the size of implementation vs. apparent benefit is too low. |
| 109 | + |
| 110 | +#### Do you have any advice on how to create my own single-file library? |
| 111 | + |
| 112 | +Yes. https://github.com/nothings/stb/blob/master/docs/stb_howto.txt |
| 113 | + |
| 114 | +#### Why public domain? |
| 115 | + |
| 116 | +I prefer it over GPL, LGPL, BSD, zlib, etc. for many reasons. |
| 117 | +Some of them are listed here: |
| 118 | +https://github.com/nothings/stb/blob/master/docs/why_public_domain.md |
| 119 | + |
| 120 | +#### Why C? |
| 121 | + |
| 122 | +Primarily, because I use C, not C++. But it does also make it easier |
| 123 | +for other people to use them from other languages. |
| 124 | + |
| 125 | +#### Why not C99? stdint.h, declare-anywhere, etc. |
| 126 | + |
| 127 | +I still use MSVC 6 (1998) as my IDE because it has better human factors |
| 128 | +for me than later versions of MSVC. |
| 129 | + |
| 130 | + |
| 131 | + |
0 commit comments