Welcome to mirror list, hosted at ThFree Co, Russian Federation.

git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCampbell Barton <ideasman42@gmail.com>2015-07-22 13:35:33 +0300
committerCampbell Barton <ideasman42@gmail.com>2015-07-22 14:32:14 +0300
commita6f00bb75ca8ec22f66a47782ffa2b827bb0f8e9 (patch)
treeee8da7e8848340dc8d200a2b95ea55a8ed83f87e /source/blender/blenkernel/BKE_bvhutils.h
parentdf41f7bf4f1b16d833eb548e57b4512dfb1a3bfa (diff)
Use doxy sections in bvhutils
Diffstat (limited to 'source/blender/blenkernel/BKE_bvhutils.h')
-rw-r--r--source/blender/blenkernel/BKE_bvhutils.h24
1 files changed, 14 insertions, 10 deletions
diff --git a/source/blender/blenkernel/BKE_bvhutils.h b/source/blender/blenkernel/BKE_bvhutils.h
index e78fa65bbbf..a956933aa22 100644
--- a/source/blender/blenkernel/BKE_bvhutils.h
+++ b/source/blender/blenkernel/BKE_bvhutils.h
@@ -34,7 +34,7 @@
#include "BLI_bitmap.h"
#include "BLI_kdopbvh.h"
-/*
+/**
* This header encapsulates necessary code to buld a BVH
*/
@@ -42,7 +42,7 @@ struct DerivedMesh;
struct MVert;
struct MFace;
-/*
+/**
* struct that kepts basic information about a BVHTree build from a mesh
*/
typedef struct BVHTreeFromMesh {
@@ -100,18 +100,22 @@ BVHTree *bvhtree_from_mesh_faces_ex(
BLI_bitmap *mask, int numFaces_active,
float epsilon, int tree_type, int axis);
-/*
+/**
* Frees data allocated by a call to bvhtree_from_mesh_*.
*/
void free_bvhtree_from_mesh(struct BVHTreeFromMesh *data);
-/*
+/**
* Math functions used by callbacks
*/
-float bvhtree_ray_tri_intersection(const BVHTreeRay *ray, const float m_dist, const float v0[3], const float v1[3], const float v2[3]);
-float nearest_point_in_tri_surface_squared(const float v0[3], const float v1[3], const float v2[3], const float p[3], int *v, int *e, float nearest[3]);
+float bvhtree_ray_tri_intersection(
+ const BVHTreeRay *ray, const float m_dist,
+ const float v0[3], const float v1[3], const float v2[3]);
+float nearest_point_in_tri_surface_squared(
+ const float v0[3], const float v1[3], const float v2[3],
+ const float p[3], int *v, int *e, float nearest[3]);
-/*
+/**
* BVHCache
*/
@@ -126,12 +130,12 @@ enum {
typedef struct LinkNode *BVHCache;
-/*
+/**
* Queries a bvhcache for the cache bvhtree of the request type
*/
BVHTree *bvhcache_find(BVHCache *cache, int type);
-/*
+/**
* Inserts a BVHTree of the given type under the cache
* After that the caller no longer needs to worry when to free the BVHTree
* as that will be done when the cache is freed.
@@ -140,7 +144,7 @@ BVHTree *bvhcache_find(BVHCache *cache, int type);
*/
void bvhcache_insert(BVHCache *cache, BVHTree *tree, int type);
-/*
+/**
* inits and frees a bvhcache
*/
void bvhcache_init(BVHCache *cache);