AnotherFoxGuy/polyvox
1
0
Fork 0
Code Issues Pull Requests Activity

Add a few words into principles.rst

Browse Source 
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.
This commit is contained in:
Matt Williams 2012-07-21 00:03:24 +01:00
parent afb83d96de
commit 01fd3f9be5
1 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
documentation/principles.rst
View File

@ -1,3 +1,14 @@
**********************
Principles of PolyVox
**********************
.. 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...