polish for release

Author: SimonDanisch

docs/src/index.md

@@ -6,6 +6,8 @@ High-performance ray-triangle intersection engine with BVH acceleration for CPU
 
 - **Fast BVH acceleration** for ray-triangle intersection
 - **CPU and GPU support** via KernelAbstractions.jl
+- **MultiTypeSet**: GPU-safe heterogeneous collections with compile-time type-stable dispatch for materials, textures, lights, etc.
+- **GPU TLAS**: Two-level acceleration structure (BLAS/TLAS) with instanced geometry, per-instance transforms, and GPU-first design
 - **Analysis tools**: centroid calculation, illumination analysis, view factors for radiosity
 - **Makie integration** for visualization
 

src/Raycore.jl

@@ -48,7 +48,7 @@ include("kernel-abstractions.jl")
 include("kernels.jl")
 include("ray_intersection_session.jl")
 include("soa.jl")
-include("heterovec.jl")
+include("multitypeset.jl")
 include("unrolled.jl")
 
 # Macros
@@ -61,9 +61,9 @@ export Ray, RayDifferentials, Triangle, TriangleMesh, AccelPrimitive, BVH, Bound
 export BLAS, TLAS, InstanceDescriptor, BVHNode2, build_blas, build_tlas, INVALID_NODE
 export Instance, n_instances, n_geometries, build_triangle, is_degenerate_face
 
-# TLASBuilder (new MultiTypeSet-style API)
-export TLASBuilder, TLASHandle, StaticTLAS, INVALID_HANDLE
-export sync!, update_instance!, update!, n_total_instances
+# TLAS (GPU two-level acceleration structure)
+export TLASHandle, StaticTLAS, INVALID_HANDLE
+export sync!, update!, n_total_instances
 
 # BVH4 types (HIPRT-style 4-wide nodes)
 export BVHNode4, BLAS4, TLAS4, build_blas4, closest_hit4, any_hit4
@@ -86,7 +86,7 @@ export @get, @set, similar_soa
 # GPU-safe unrolled iteration
 export FastClosure, for_unrolled, map_unrolled, reduce_unrolled, sum_unrolled, getindex_unrolled
 
-# HeterogeneousVector for type-stable heterogeneous collections
+# MultiTypeSet - type-stable heterogeneous collections
 export SetKey, MultiTypeSet, StaticMultiTypeSet, TextureRef
 export is_invalid, is_valid, with_index, n_slots, deref, get_static, to_tuple
 export maybe_convert_field, store_texture, rebuild_static!

src/instanced-bvh.jl

@@ -203,10 +203,7 @@ mutable struct TLAS{Backend}
     next_instance_id::UInt32
 end
 
-# Legacy alias for compatibility
-const TLASBuilder = TLAS
-
-# Note: _get_isbits_ptr is defined in heterovec.jl and reused here
+# Note: _get_isbits_ptr is defined in multitypeset.jl and reused here
 
 # ==============================================================================
 # Instance - High-level wrapper for instanced geometry
@@ -2051,29 +2048,6 @@ end
 # Use TLAS(meshes, metadata_fn) for per-triangle metadata, or
 # TLAS([Instance(mesh1), Instance(mesh2), ...]) for the new Instance API.
 
-# Make closest_hit and any_hit work with both argument orders for compatibility
-"""
-    closest_hit(ray::AbstractRay, tlas::TLAS)
-
-BVH-compatible argument order for closest_hit.
-Returns (hit_found, triangle, distance, barycentric) - same as BVH.
-"""
-function closest_hit(ray::AbstractRay, tlas::TraversableTLAS)
-    hit, tri, t, bary, inst_id = closest_hit(tlas, ray)
-    return (hit, tri, t, bary)
-end
-
-"""
-    any_hit(ray::AbstractRay, tlas::TLAS)
-
-BVH-compatible argument order for any_hit.
-Returns (hit_found, triangle, distance, barycentric) - same as BVH.
-"""
-function any_hit(ray::AbstractRay, tlas::TraversableTLAS)
-    hit, tri, t, bary, inst_id = any_hit(tlas, ray)
-    return (hit, tri, t, bary)
-end
-
 """
     Base.eltype(tlas::TraversableTLAS)
 

src/heterovec.jl src/multitypeset.jlsrc/heterovec.jl renamed to src/multitypeset.jl

@@ -1,5 +1,5 @@
 # ============================================================================
-# HeterogeneousVector - Type-stable heterogeneous collections for GPU
+# MultiTypeSet - Type-stable heterogeneous collections for GPU
 # ============================================================================
 # Provides compile-time type-stable dispatch over collections of different types.
 # Used for materials, textures, media, lights, etc.
@@ -61,11 +61,8 @@ n_slots(smv::StaticMultiTypeSet) = length(smv.data)
 
 # Get the static version - identity for StaticMultiTypeSet, .static field for MultiTypeSet
 get_static(smv::StaticMultiTypeSet) = smv
-# Fallback for Tuple (used by legacy code paths)
-get_static(t::Tuple) = t
 
 # Convert to a flat Tuple of all elements (preserves concrete element types)
-to_tuple(t::Tuple) = t
 _concat_to_tuple() = ()
 _concat_to_tuple(v::AbstractVector, rest...) = (v..., _concat_to_tuple(rest...)...)
 to_tuple(smv::StaticMultiTypeSet) = _concat_to_tuple(smv.data...)
@@ -181,10 +178,10 @@ end
 # Dummy kernel for argconvert (same pattern as kernel-abstractions.jl)
 # ============================================================================
 
-KA.@kernel _heterovec_dummy_kernel() = nothing
+KA.@kernel _multitypeset_dummy_kernel() = nothing
 
 function _get_isbits_ptr(backend, gpu_arr)
-    kernel = _heterovec_dummy_kernel(backend)
+    kernel = _multitypeset_dummy_kernel(backend)
     return KA.argconvert(kernel, gpu_arr)
 end
 

test/runtests.jl

@@ -14,15 +14,18 @@ Aqua.test_all(Raycore; ambiguities=(; broken=true))
         include("test_intersection.jl")
     end
     @testset "Type Stability" begin
-        # include("test_type_stability.jl")
+        # include("test_type_stability.jl")  # disabled: @allocated tests fail on Julia 1.12
     end
     @testset "Bounds" begin
         include("bounds.jl")
     end
     @testset "Instanced BVH" begin
         include("test_instanced_bvh.jl")
     end
-    @testset "HeteroVec" begin
-        include("test_heterovec.jl")
+    @testset "MultiTypeSet" begin
+        include("test_multitypeset.jl")
+    end
+    @testset "Unrolled" begin
+        # include("test_unrolled.jl")  # requires BenchmarkTools (not in test deps)
     end
 end

test/test_instanced_bvh.jl

@@ -403,34 +403,6 @@ end
     @test hit_miss == false
 end
 
-@testset "TLAS BVH-compatible API (argument order)" begin
-    # Test that closest_hit(ray, tlas) works (BVH-compatible order)
-    v1, v2, v3 = Point3f(0, 0, 0), Point3f(1, 0, 0), Point3f(0, 1, 0)
-    tri = RTriangle(
-        SVector(v1, v2, v3),
-        SVector(Normal3f(0, 0, 1), Normal3f(0, 0, 1), Normal3f(0, 0, 1)),
-        SVector(Vec3f(0), Vec3f(0), Vec3f(0)),
-        SVector(Point2f(0, 0), Point2f(1, 0), Point2f(0, 1)),
-        UInt32(1)
-    )
-
-    blas = build_blas([tri])
-    identity = Mat4f(I)
-    instances = [InstanceDescriptor(UInt32(1), UInt32(1), identity, identity, UInt32(0))]
-    tlas = build_tlas([blas], instances)
-
-    ray = Ray(o=Point3f(0.25, 0.25, 1.0), d=Vec3f(0, 0, -1))
-
-    # BVH-compatible order (ray first)
-    hit, prim, dist, bary = closest_hit(ray, tlas)
-    @test hit == true
-    @test dist ≈ 1.0f0
-
-    # any_hit with BVH-compatible order
-    hit_any, _, _, _ = any_hit(ray, tlas)
-    @test hit_any == true
-end
-
 # ==============================================================================
 # Instance API Tests
 # ==============================================================================