From 0f52f6accc3eac785c21461af6d07d4257288287 Mon Sep 17 00:00:00 2001 From: Sean Barrett Date: Wed, 1 Apr 2015 00:44:05 -0700 Subject: [PATCH] note documentation failure; update README.md --- README.md | 1 + stb_voxel_render.h | 16 ++++++++++++++++ tools/README.list | 1 + 3 files changed, 18 insertions(+) diff --git a/README.md b/README.md index 0940e21..9254663 100644 --- a/README.md +++ b/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 graphics | Minecraft-esque voxel rendering "engine" with many more features **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_easy_font.h** | 0.5 | 3D graphics | quick-and-dirty easy-to-deploy bitmap font for printing frame rate, etc diff --git a/stb_voxel_render.h b/stb_voxel_render.h index e9aa035..b5f160d 100644 --- a/stb_voxel_render.h +++ b/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 diff --git a/tools/README.list b/tools/README.list index 0f3639d..70f6ff7 100644 --- a/tools/README.list +++ b/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