Browse Source

note documentation failure; update README.md

Sean Barrett 10 years ago
parent
commit
0f52f6accc
3 changed files with 18 additions and 0 deletions
  1. 1 0
      README.md
  2. 16 0
      stb_voxel_render.h
  3. 1 0
      tools/README.list

+ 1 - 0
README.md

@@ -13,6 +13,7 @@ library    | lastest version | category | description
 **stb_rect_pack.h** | 0.05 | graphics | simple 2D rectangle packer with decent quality
 **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.5 | UI | guts of a text editor for games etc implementing them from scratch
+**stb_voxel_render.h** | 0.75 | 3D&nbsp;graphics | Minecraft-esque voxel rendering "engine" with many more features
 **stb_dxt.h** | 1.04 | 3D&nbsp;graphics | Fabian "ryg" Giesen's real-time DXT compressor
 **stb_perlin.h** | 0.2 | 3D&nbsp;graphics | revised Perlin noise (3D input, 1D output)
 **stb_easy_font.h** | 0.5 | 3D&nbsp;graphics | quick-and-dirty easy-to-deploy bitmap font for printing frame rate, etc

+ 16 - 0
stb_voxel_render.h

@@ -576,6 +576,22 @@ struct stbvox_input_description
    // on the E/N/W/S sides of the block.
    // Encode with STBVOX_MAKE_SIDE_TEXROT(rot_e, rot_n, rot_w, rot_s)
 
+
+//////////////////////////////////////////////////////////////////////////////
+// X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X//
+//X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X //
+// X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X//
+//X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X //
+// X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X//
+//X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X //
+// X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X//
+//X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X //
+//////////////////////////////////////////////////////////////////////////////
+
+   // Note the detailed documentation runs out here, I still have to finish this
+   // and document all the #define STBVOX_CONFIGs as well
+
+
    unsigned char *overlay;                 // index into palettes listed below
    unsigned char *selector;                // raw selector (chooses which mesh to write to)
    unsigned char *geometry;                // STBVOX_MAKE_GEOMETRY   -- geom:4, rot:2, vheight:2

+ 1 - 0
tools/README.list

@@ -6,6 +6,7 @@ stb_image_resize.h          | graphics         | resize images larger/smaller wi
 stb_rect_pack.h             | graphics         | simple 2D rectangle packer with decent quality
 stretchy_buffer.h           | utility          | typesafe dynamic array for C (i.e. approximation to vector<>), doesn't compile as C++
 stb_textedit.h              | UI               | guts of a text editor for games etc implementing them from scratch
+stb_voxel_render.h          | 3D graphics      | Minecraft-esque voxel rendering "engine" with many more features
 stb_dxt.h                   | 3D graphics      | Fabian "ryg" Giesen's real-time DXT compressor
 stb_perlin.h                | 3D graphics      | revised Perlin noise (3D input, 1D output)
 stb_easy_font.h             | 3D graphics      | quick-and-dirty easy-to-deploy bitmap font for printing frame rate, etc