From 01fd3f9be55ab996491d154a67ccf72245f6fbfe Mon Sep 17 00:00:00 2001 From: Matt Williams Date: Sat, 21 Jul 2012 00:03:24 +0100 Subject: [PATCH] Add a few words into principles.rst This is just a skeleton of the sorts of things we should mention. I also added a big red box to remind us to write some stuff before release. --- documentation/principles.rst | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/documentation/principles.rst b/documentation/principles.rst index d9f5568d..ecfbcef1 100644 --- a/documentation/principles.rst +++ b/documentation/principles.rst @@ -1,3 +1,14 @@ ********************** Principles of PolyVox -********************** \ No newline at end of file +********************** + +.. warning :: + This section is being written and is just a skeleton for now + +PolyVox provides a library for managing 3D arrays (volumes) of data (voxels). It gives you the tools to iterate through, randomly access, read and write volumes. It supports any type you'd like to represent each voxel whether it's just an ``int`` or a class which encapsulates both density and colour. + +Once you have a volume, PolyVox provides a number of tools for turning it into something that you can pass to your rendering engine. These are called `surface extractors`. + +Each surface extractor needs to be told how to interperet your voxel type and that is done using... + +Link to a page describing how to write your own voxel type and link it to a surface extractor...