From 1337e9cdfb68a3cb6d822d1595f78d5328ac1175 Mon Sep 17 00:00:00 2001 From: Recep Aslantas Date: Fri, 29 Mar 2024 08:10:56 +0300 Subject: [PATCH] docs: ray sphere docs improvements --- docs/source/ray.rst | 2 +- include/cglm/ray.h | 2 +- include/cglm/struct/ray.h | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/ray.rst b/docs/source/ray.rst index d1f0a1d..1538a1f 100644 --- a/docs/source/ray.rst +++ b/docs/source/ray.rst @@ -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 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 specific range (for example, tmin < t1, t2 < tmax) to determine if the intersections are within a desired segment of the ray diff --git a/include/cglm/ray.h b/include/cglm/ray.h index 841947e..d7831bc 100644 --- a/include/cglm/ray.h +++ b/include/cglm/ray.h @@ -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 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 * specific range (for example, tmin < t1, t2 < tmax) to determine if the * intersections are within a desired segment of the ray diff --git a/include/cglm/struct/ray.h b/include/cglm/struct/ray.h index d11be92..10609b9 100644 --- a/include/cglm/struct/ray.h +++ b/include/cglm/struct/ray.h @@ -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 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 * specific range (for example, tmin < t1, t2 < tmax) to determine if the * intersections are within a desired segment of the ray