Some docs for bsp5.h

This commit is contained in:
Bill Currie 2010-08-30 16:08:04 +09:00
parent 68dda63de5
commit 69189600a4

View file

@ -48,14 +48,14 @@ typedef struct visfacet_s {
struct visfacet_s *next; struct visfacet_s *next;
int planenum; int planenum;
int planeside; // which side is the front of the face int planeside; ///< which side is the front of the face
int texturenum; int texturenum;
int contents[2]; // 0 = front side int contents[2]; ///< 0 = front side
struct visfacet_s *original;// face on node struct visfacet_s *original;///< face on node
int outputnumber; // valid only for original faces after int outputnumber; ///< valid only for original faces after
// write surfaces ///< write surfaces
qboolean detail; // is a detail face qboolean detail; ///< is a detail face
struct winding_s *points; struct winding_s *points;
int *edges; int *edges;
@ -63,17 +63,17 @@ typedef struct visfacet_s {
typedef struct surface_s { typedef struct surface_s {
struct surface_s *next; struct surface_s *next;
struct surface_s *original; // before BSP cuts it up struct surface_s *original; ///< before BSP cuts it up
int planenum; int planenum;
int outputplanenum; // valid only after WriteSurfacePlanes int outputplanenum; ///< valid only after WriteSurfacePlanes
vec3_t mins, maxs; vec3_t mins, maxs;
qboolean onnode; // true if surface has already been used qboolean onnode; ///< true if surface has already been used
// as a splitting node ///< as a splitting node
qboolean has_detail; // true if the surface has detail brushes qboolean has_detail; ///< true if the surface has detail brushes
qboolean has_struct; // true if the surface has non-detail qboolean has_struct; ///< true if the surface has non-detail
// brushes ///< brushes
face_t *faces; // links to all the faces on either side face_t *faces; ///< links to all the faces on either side
// of the surf ///< of the surf
} surface_t; } surface_t;
// there is a node_t structure for every node and leaf in the bsp tree // there is a node_t structure for every node and leaf in the bsp tree
@ -82,8 +82,8 @@ typedef struct surface_s {
typedef struct node_s { typedef struct node_s {
vec3_t mins,maxs; ///< bounding volume, not just points inside vec3_t mins,maxs; ///< bounding volume, not just points inside
// information for decision nodes // information for decision nodes
int planenum; ///< -1 = leaf node int planenum; ///< -1 = leaf node
int outputplanenum; ///< valid only after WriteNodePlanes int outputplanenum; ///< valid only after WriteNodePlanes
int firstface; ///< decision node only int firstface; ///< decision node only
int numfaces; ///< decision node only int numfaces; ///< decision node only
@ -93,7 +93,7 @@ typedef struct node_s {
// information for leafs // information for leafs
int contents; ///< leaf nodes (0 for decision nodes) int contents; ///< leaf nodes (0 for decision nodes)
face_t **markfaces; ///< leaf nodes only, point to node faces face_t **markfaces; ///< leaf nodes only, point to node faces
struct portal_s *portals; struct portal_s *portals; ///< portals on this leaf
int visleafnum; ///< -1 = solid int visleafnum; ///< -1 = solid
int valid; ///< for flood filling int valid; ///< for flood filling
int occupied; ///< light number in leaf for outside filling int occupied; ///< light number in leaf for outside filling