Skip to content

Commit 7bc39ad

Browse files
author
Stdlib Reference Bot
committed
Update the core module reference
1 parent 98d0080 commit 7bc39ad

35 files changed

Lines changed: 697 additions & 8 deletions

‎_includes/stdlib-reference-toc.html‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -588,6 +588,7 @@
588588
</li><li data-link="/stdlib-reference/types/raytracingaccelerationstructure-0am/init"><span>init</span>
589589
</li><li data-link="/stdlib-reference/types/raytracingaccelerationstructure-0am/kind"><span>kind</span>
590590
</li></ul>
591+
</li><li data-link="/stdlib-reference/types/traversable_transform_type-0123456789acdefghijkmnop/index"><span>TRAVERSABLE_TRANSFORM_TYPE</span>
591592
</li></ul>
592593
</li>
593594
<li data-link="/stdlib-reference/types/sampler_types"><span>Sampler types</span>
@@ -791,6 +792,8 @@
791792
</li><li data-link="/stdlib-reference/types/0texture-01/sample-0"><span>Sample</span>
792793
</li><li data-link="/stdlib-reference/types/0texture-01/samplebias-06"><span>SampleBias</span>
793794
</li><li data-link="/stdlib-reference/types/0texture-01/samplecmp-06"><span>SampleCmp</span>
795+
</li><li data-link="/stdlib-reference/types/0texture-01/samplecmpbias-069"><span>SampleCmpBias</span>
796+
</li><li data-link="/stdlib-reference/types/0texture-01/samplecmpgrad-069"><span>SampleCmpGrad</span>
794797
</li><li data-link="/stdlib-reference/types/0texture-01/samplecmplevel-069"><span>SampleCmpLevel</span>
795798
</li><li data-link="/stdlib-reference/types/0texture-01/samplecmplevelzero-069e"><span>SampleCmpLevelZero</span>
796799
</li><li data-link="/stdlib-reference/types/0texture-01/samplegrad-06"><span>SampleGrad</span>
@@ -1328,8 +1331,16 @@
13281331
</li><li data-link="/stdlib-reference/global-decls/dispatchraysindex-08c"><span>DispatchRaysIndex</span>
13291332
</li><li data-link="/stdlib-reference/global-decls/geometryindex-08"><span>GeometryIndex</span>
13301333
</li><li data-link="/stdlib-reference/global-decls/getclusterid-03ab"><span>GetClusterID</span>
1334+
</li><li data-link="/stdlib-reference/global-decls/getinstancetraversable-03b"><span>GetInstanceTraversable</span>
13311335
</li><li data-link="/stdlib-reference/global-decls/getlsspositionsandradii-036fi"><span>GetLssPositionsAndRadii</span>
13321336
</li><li data-link="/stdlib-reference/global-decls/getspherepositionandradius-039hk"><span>GetSpherePositionAndRadius</span>
1337+
</li><li data-link="/stdlib-reference/global-decls/gettransformlisthandle-03cg"><span>GetTransformListHandle</span>
1338+
</li><li data-link="/stdlib-reference/global-decls/gettransformlistsize-03cg"><span>GetTransformListSize</span>
1339+
</li><li data-link="/stdlib-reference/global-decls/gettraversablechild-03e"><span>GetTraversableChild</span>
1340+
</li><li data-link="/stdlib-reference/global-decls/gettraversableinstanceid-03em"><span>GetTraversableInstanceId</span>
1341+
</li><li data-link="/stdlib-reference/global-decls/gettraversableobjecttoworld-03ekm"><span>GetTraversableObjectToWorld</span>
1342+
</li><li data-link="/stdlib-reference/global-decls/gettraversabletransformtype-03en"><span>GetTraversableTransformType</span>
1343+
</li><li data-link="/stdlib-reference/global-decls/gettraversableworldtoobject-03ejl"><span>GetTraversableWorldToObject</span>
13331344
</li><li data-link="/stdlib-reference/global-decls/hit_kind_triangle_back_face-01245679abcdefgijklnopq"><span>HIT_KIND_TRIANGLE_BACK_FACE</span>
13341345
</li><li data-link="/stdlib-reference/global-decls/hit_kind_triangle_front_face-01245679abcdefgijklmopqr"><span>HIT_KIND_TRIANGLE_FRONT_FACE</span>
13351346
</li><li data-link="/stdlib-reference/global-decls/hitkind-03"><span>HitKind</span>

‎_includes/version.inc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
v2025.22.1
1+
v2025.23

‎global-decls/asfloat16.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,9 @@ Available in all stages.
6262
#### glsl
6363
Available in all stages.
6464

65+
#### cpp
66+
Available in all stages.
67+
6568
#### cuda
6669
Available in all stages.
6770

‎global-decls/asuint16.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,9 @@ Available in all stages.
6262
#### glsl
6363
Available in all stages.
6464

65+
#### cpp
66+
Available in all stages.
67+
6568
#### cuda
6669
Available in all stages.
6770

‎global-decls/getinstancetraversable-03b.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
layout: stdlib-reference
3+
---
4+
5+
# GetInstanceTraversable
6+
7+
## Description
8+
9+
Returns an instance traversable from an IAS by index.
10+
11+
12+
13+
## Signature
14+
15+
<pre>
16+
uint64_t <a href="getinstancetraversable-03b.html">GetInstanceTraversable</a>(
17+
uint64_t <a href="getinstancetraversable-03b.html#decl-ias" class="code_param">ias</a>,
18+
<span class="code_keyword">uint</span> <a href="getinstancetraversable-03b.html#decl-instIdx" class="code_param">instIdx</a>);
19+
20+
</pre>
21+
22+
## Parameters
23+
24+
#### <a id="decl-ias"></a>ias : uint64\_t
25+
Instance acceleration structure handle
26+
27+
#### <a id="decl-instIdx"></a>instIdx : uint
28+
Instance index
29+
30+
31+
## Return value
32+
Traversable handle for the specified instance
33+
34+
## Remarks
35+
IAS must be built with OPTIX_BUILD_FLAG_ALLOW_RANDOM_INSTANCE_ACCESS
36+
Currently only supported on CUDA/OptiX
37+
38+
39+
## Availability and Requirements
40+
41+
Defined for the following targets:
42+
43+
#### cuda
44+
Available in stages: `intersection`, `raygen`, `miss`, `callable`, `closesthit`, `anyhit`.
45+
46+
Requires capability: `optix_multilevel_traversal`.
47+
48+

‎global-decls/gettransformlisthandle-03cg.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
layout: stdlib-reference
3+
---
4+
5+
# GetTransformListHandle
6+
7+
## Description
8+
9+
Returns the traversable handle at a specific index in the transform path.
10+
11+
12+
13+
## Signature
14+
15+
<pre>
16+
uint64_t <a href="gettransformlisthandle-03cg.html">GetTransformListHandle</a>(<span class="code_keyword">uint</span> <a href="gettransformlisthandle-03cg.html#decl-index" class="code_param">index</a>);
17+
18+
</pre>
19+
20+
## Parameters
21+
22+
#### <a id="decl-index"></a>index : uint
23+
Index in the transform list (0 = root, GetTransformListSize()-1 = closest to primitive)
24+
25+
26+
## Return value
27+
Traversable handle at the specified index
28+
29+
## Remarks
30+
Currently only supported on CUDA/OptiX. Can only be called from intersection, any-hit, or closest-hit programs.
31+
32+
33+
## Availability and Requirements
34+
35+
Defined for the following targets:
36+
37+
#### cuda
38+
Available in stages: `intersection`, `closesthit`, `anyhit`.
39+
40+
Requires capability: `optix_multilevel_traversal`.
41+
42+

‎global-decls/gettransformlistsize-03cg.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
layout: stdlib-reference
3+
---
4+
5+
# GetTransformListSize
6+
7+
## Description
8+
9+
Returns the number of transforms in the path from root to the current primitive.
10+
11+
12+
13+
## Signature
14+
15+
<pre>
16+
<span class="code_keyword">uint</span> <a href="gettransformlistsize-03cg.html">GetTransformListSize</a>();
17+
18+
</pre>
19+
20+
## Return value
21+
Number of transforms from root traversable to current primitive
22+
23+
## Remarks
24+
Currently only supported on CUDA/OptiX. Can only be called from intersection, any-hit, or closest-hit programs.
25+
26+
27+
## Availability and Requirements
28+
29+
Defined for the following targets:
30+
31+
#### cuda
32+
Available in stages: `intersection`, `closesthit`, `anyhit`.
33+
34+
Requires capability: `optix_multilevel_traversal`.
35+
36+

‎global-decls/gettraversablechild-03e.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
layout: stdlib-reference
3+
---
4+
5+
# GetTraversableChild
6+
7+
## Description
8+
9+
Returns the child traversable handle from an instance traversable.
10+
11+
12+
13+
## Signature
14+
15+
<pre>
16+
uint64_t <a href="gettraversablechild-03e.html">GetTraversableChild</a>(uint64_t <a href="gettraversablechild-03e.html#decl-handle" class="code_param">handle</a>);
17+
18+
</pre>
19+
20+
## Parameters
21+
22+
#### <a id="decl-handle"></a>handle : uint64\_t
23+
Instance traversable handle to query
24+
25+
26+
## Return value
27+
Child traversable handle, or 0 if handle does not reference an instance
28+
29+
## Remarks
30+
Currently only supported on CUDA/OptiX
31+
32+
33+
## Availability and Requirements
34+
35+
Defined for the following targets:
36+
37+
#### cuda
38+
Available in stages: `intersection`, `raygen`, `miss`, `callable`, `closesthit`, `anyhit`.
39+
40+
Requires capability: `optix_multilevel_traversal`.
41+
42+

‎global-decls/gettraversableinstanceid-03em.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
layout: stdlib-reference
3+
---
4+
5+
# GetTraversableInstanceId
6+
7+
## Description
8+
9+
Returns the instance ID from a traversable handle.
10+
11+
12+
13+
## Signature
14+
15+
<pre>
16+
<span class="code_keyword">uint</span> <a href="gettraversableinstanceid-03em.html">GetTraversableInstanceId</a>(uint64_t <a href="gettraversableinstanceid-03em.html#decl-handle" class="code_param">handle</a>);
17+
18+
</pre>
19+
20+
## Parameters
21+
22+
#### <a id="decl-handle"></a>handle : uint64\_t
23+
Traversable handle to query
24+
25+
26+
## Return value
27+
Instance ID, or 0 if handle does not reference an instance
28+
29+
## Remarks
30+
Currently only supported on CUDA/OptiX
31+
32+
33+
## Availability and Requirements
34+
35+
Defined for the following targets:
36+
37+
#### cuda
38+
Available in stages: `intersection`, `raygen`, `miss`, `callable`, `closesthit`, `anyhit`.
39+
40+
Requires capability: `optix_multilevel_traversal`.
41+
42+

‎global-decls/gettraversableobjecttoworld-03ekm.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
layout: stdlib-reference
3+
---
4+
5+
# GetTraversableObjectToWorld
6+
7+
## Description
8+
9+
Returns the object-to-world transform from an instance traversable.
10+
11+
12+
13+
## Signature
14+
15+
<pre>
16+
<a href="../types/matrix/index.html" class="code_type">matrix</a>&lt;<span class="code_keyword">float</span>, 3, 4&gt; <a href="gettraversableobjecttoworld-03ekm.html">GetTraversableObjectToWorld</a>(uint64_t <a href="gettraversableobjecttoworld-03ekm.html#decl-handle" class="code_param">handle</a>);
17+
18+
</pre>
19+
20+
## Parameters
21+
22+
#### <a id="decl-handle"></a>handle : uint64\_t
23+
Instance traversable handle to query
24+
25+
26+
## Return value
27+
3x4 transform matrix representing the object-to-world transformation
28+
29+
## Remarks
30+
Currently only supported on CUDA/OptiX
31+
32+
33+
## Availability and Requirements
34+
35+
Defined for the following targets:
36+
37+
#### cuda
38+
Available in stages: `intersection`, `raygen`, `miss`, `callable`, `closesthit`, `anyhit`.
39+
40+
Requires capability: `optix_multilevel_traversal`.
41+
42+

0 commit comments

Comments
 (0)