Skip to content

Commit 9d039c1

Browse files
committed
Document what rayQueryTerminate actually does
1 parent 63a02ee commit 9d039c1

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

docs/api-specs/ray_tracing.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -125,8 +125,9 @@ rayQueryGenerateIntersection(hit_t: f32)
125125
// - Commits a hit from triangular non-opaque geometry.
126126
rayQueryConfirmIntersection()
127127
128-
// - Aborts the query.
129-
rayQueryTerminate()
128+
// Aborts the query which is in progress, that is, the next `rayQueryProceed` is guaranteed to return `false`
129+
// and any call to `rayQueryGetCommittedIntersection` will return the closest committed result so far.
130+
rayQueryTerminate(rq: ptr<function, ray_query>)
130131
131132
// - Returns intersection details about a hit considered `Committed`.
132133
rayQueryGetCommittedIntersection(rq: ptr<function, ray_query>) -> RayIntersection

0 commit comments

Comments
 (0)