External/cglm
1
0
Fork 0
mirror of https://github.com/recp/cglm.git synced 2025-10-04 01:00:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: ray sphere docs improvements

Browse Source
This commit is contained in:
Recep Aslantas
2024-03-29 08:10:56 +03:00
parent 9df36ce005
commit 1337e9cdfb
3 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/source/ray.rst
View File

@@ -40,7 +40,7 @@ Functions documentation
- t1 > 0, t2 > 0: ray intersects the sphere at t1 and t2 both ahead of the origin - t1 > 0, t2 > 0: ray intersects the sphere at t1 and t2 both ahead of the origin
- t1 < 0, t2 > 0: ray starts inside the sphere, exits at t2 - t1 < 0, t2 > 0: ray starts inside the sphere, exits at t2
- t1 < 0, t2 < 0: no intersection ahead of the ray - t1 < 0, t2 < 0: no intersection ahead of the ray ( returns false )
- the caller can check if the intersection points (t1 and t2) fall within a - the caller can check if the intersection points (t1 and t2) fall within a
specific range (for example, tmin < t1, t2 < tmax) to determine if the specific range (for example, tmin < t1, t2 < tmax) to determine if the
intersections are within a desired segment of the ray intersections are within a desired segment of the ray

2
include/cglm/ray.h
View File

@@ -86,7 +86,7 @@ glm_ray_triangle(vec3 origin,
* *
* - t1 > 0, t2 > 0: ray intersects the sphere at t1 and t2 both ahead of the origin * - t1 > 0, t2 > 0: ray intersects the sphere at t1 and t2 both ahead of the origin
* - t1 < 0, t2 > 0: ray starts inside the sphere, exits at t2 * - t1 < 0, t2 > 0: ray starts inside the sphere, exits at t2
* - t1 < 0, t2 < 0: no intersection ahead of the ray * - t1 < 0, t2 < 0: no intersection ahead of the ray ( returns false )
* - the caller can check if the intersection points (t1 and t2) fall within a * - the caller can check if the intersection points (t1 and t2) fall within a
* specific range (for example, tmin < t1, t2 < tmax) to determine if the * specific range (for example, tmin < t1, t2 < tmax) to determine if the
* intersections are within a desired segment of the ray * intersections are within a desired segment of the ray

2
include/cglm/struct/ray.h
View File

@@ -44,7 +44,7 @@ glms_ray_(triangle)(vec3s origin,
* *
* - t1 > 0, t2 > 0: ray intersects the sphere at t1 and t2 both ahead of the origin * - t1 > 0, t2 > 0: ray intersects the sphere at t1 and t2 both ahead of the origin
* - t1 < 0, t2 > 0: ray starts inside the sphere, exits at t2 * - t1 < 0, t2 > 0: ray starts inside the sphere, exits at t2
* - t1 < 0, t2 < 0: no intersection ahead of the ray * - t1 < 0, t2 < 0: no intersection ahead of the ray ( returns false )
* - the caller can check if the intersection points (t1 and t2) fall within a * - the caller can check if the intersection points (t1 and t2) fall within a
* specific range (for example, tmin < t1, t2 < tmax) to determine if the * specific range (for example, tmin < t1, t2 < tmax) to determine if the
* intersections are within a desired segment of the ray * intersections are within a desired segment of the ray