stb/README.md

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