summaryrefslogtreecommitdiffstats
path: root/libdimension/prtree.h
diff options
context:
space:
mode:
authorTavian Barnes <tavianator@gmail.com>2011-03-08 21:41:17 -0500
committerTavian Barnes <tavianator@gmail.com>2011-03-08 21:43:24 -0500
commit1e53f6ed29fd9a6ba56dabbf63fc3db6d76c6629 (patch)
treea203f0069d9d0c3891e437c56631fac88fa147ce /libdimension/prtree.h
parentf9c82dc760f65858adb23e0b57f762ef629c3ef5 (diff)
downloaddimension-1e53f6ed29fd9a6ba56dabbf63fc3db6d76c6629.tar.xz
Add some missing documentation.
Diffstat (limited to 'libdimension/prtree.h')
-rw-r--r--libdimension/prtree.h8
1 files changed, 5 insertions, 3 deletions
diff --git a/libdimension/prtree.h b/libdimension/prtree.h
index c69d1ec..86707cf 100644
--- a/libdimension/prtree.h
+++ b/libdimension/prtree.h
@@ -31,10 +31,12 @@
#include <stdbool.h>
+/** A priority R-tree; the spatial subdivision method used for intersection
+ queries against the scene graph. */
typedef struct dmnsn_prtree {
- dmnsn_bounding_box bounding_box;
- dmnsn_array *unbounded;
- dmnsn_array *bounded;
+ dmnsn_bounding_box bounding_box; /**< The bounding box for the whole scene. */
+ dmnsn_array *unbounded; /**< The unbounded objects. */
+ dmnsn_array *bounded; /**< A PR-tree of the bounded objects. */
} dmnsn_prtree;
/** Create a PR-tree. */