Rasagar/Library/PackageCache/com.unity.rendering.light-transport/Tests/Editor/UnifiedRayTracing/AccelStructTests.cs

601 lines
23 KiB
C#
Raw Normal View History

2024-08-26 13:07:20 -07:00
using NUnit.Framework;
using System;
using UnityEditor;
using System.Runtime.InteropServices;
using Unity.Mathematics;
using Unity.Collections.LowLevel.Unsafe;
namespace UnityEngine.Rendering.UnifiedRayTracing.Tests
{
internal static class MeshUtil
{
static internal Mesh CreateSingleTriangleMesh(float2 scaling, float3 translation)
{
Mesh mesh = new Mesh();
Vector3[] vertices = new Vector3[]
{
(Vector3)translation + new Vector3(0.0f, 0.0f, 0),
(Vector3)translation + new Vector3(1.0f * scaling.x, 0.0f, 0),
(Vector3)translation + new Vector3(0.0f, 1.0f * scaling.y, 0)
};
mesh.vertices = vertices;
Vector3[] normals = new Vector3[]
{
-Vector3.forward,
-Vector3.forward,
-Vector3.forward
};
mesh.normals = normals;
Vector2[] uv = new Vector2[]
{
new Vector2(0, 1),
new Vector2(1, 1),
new Vector2(0, 0)
};
mesh.uv = uv;
int[] tris = new int[3]
{
0, 2, 1
};
mesh.triangles = tris;
return mesh;
}
static internal Mesh CreateQuadMesh()
{
Mesh mesh = new Mesh();
Vector3[] vertices = new Vector3[]
{
new Vector3(-0.5f, -0.5f, 0.0f),
new Vector3(0.5f, -0.5f, 0.0f),
new Vector3(-0.5f, 0.5f, 0.0f),
new Vector3(0.5f, 0.5f, 0.0f)
};
mesh.vertices = vertices;
Vector3[] normals = new Vector3[]
{
-Vector3.forward,
-Vector3.forward,
-Vector3.forward,
-Vector3.forward
};
mesh.normals = normals;
Vector2[] uv = new Vector2[]
{
new Vector2(0, 0),
new Vector2(1, 0),
new Vector2(0, 1),
new Vector2(1, 1)
};
mesh.uv = uv;
int[] tris = new int[6]
{
0, 2, 1,
2, 3, 1
};
mesh.triangles = tris;
return mesh;
}
}
public class ComputeRayTracingAccelStructTests
{
[StructLayout(LayoutKind.Sequential)]
internal struct BvhNode
{
public uint child0;
public uint child1;
public uint parent;
public uint update;
public float3 aabb0_min;
public float3 aabb0_max;
public float3 aabb1_min;
public float3 aabb1_max;
}
[StructLayout(LayoutKind.Sequential)]
internal struct BvhHeader
{
public uint totalNodeCount;
public uint leafNodeCount;
public uint root;
public uint unused;
public float3 aabb_min;
public float3 aabb_max;
public uint3 unused1;
public uint3 unused2;
}
static private void AssertFloat3sAreEqual(float3 expected, float3 actual, float tolerance)
{
Assert.AreEqual(expected.x, actual.x, tolerance);
Assert.AreEqual(expected.y, actual.y, tolerance);
Assert.AreEqual(expected.z, actual.z, tolerance);
}
static private void AssertAABBsAreEqual(float3 expectedMin, float3 expectedMax, float3 actualMin, float3 actualMax, float tolerance)
{
AssertFloat3sAreEqual(expectedMin, actualMin, tolerance);
AssertFloat3sAreEqual(expectedMax, actualMax, tolerance);
}
[Test]
public void Build_TwoInstancesOfASingleTriangleMesh_ShouldGenerateCorrectResult()
{
var resources = new RayTracingResources();
resources.Load();
var MB = 1024 * 1024;
var geoPoolDesc = new GeometryPoolDesc()
{
vertexPoolByteSize = MB,
indexPoolByteSize = MB,
meshChunkTablesByteSize = MB
};
using var accelStruct = new ComputeRayTracingAccelStruct(
new AccelerationStructureOptions() { buildFlags = BuildFlags.PreferFastBuild },
resources,
new ReferenceCounter());
uint instanceCount = 2;
{
var mesh = MeshUtil.CreateSingleTriangleMesh(new float2(1.0f, 1.0f), float3.zero);
var globalTranslation = new float3(1.0f, 1.0f, 0.0f);
for (uint i = 0; i < instanceCount; i++)
{
var instanceDesc = new MeshInstanceDesc(mesh);
instanceDesc.localToWorldMatrix = Matrix4x4.Translate(globalTranslation + new float3(2.0f * i, 0.0f, 0.0f));
accelStruct.AddInstance(instanceDesc);
}
using var scratchBuffer = RayTracingHelper.CreateScratchBufferForBuild(accelStruct);
using var cmd = new CommandBuffer();
accelStruct.Build(cmd, scratchBuffer);
Graphics.ExecuteCommandBuffer(cmd);
Object.DestroyImmediate(mesh);
}
var tolerance = 0.001f;
{
// Verify bottom level BVH.
uint expectedTotalNodeCount = 1;
var bottomLevelNodes = new BvhNode[(int)expectedTotalNodeCount + 1]; // plus one for header
accelStruct.bottomLevelBvhBuffer.GetData(bottomLevelNodes);
var header = UnsafeUtility.As<BvhNode, BvhHeader>(ref bottomLevelNodes[0]);
Assert.AreEqual(expectedTotalNodeCount, header.totalNodeCount);
Assert.AreEqual(1, header.leafNodeCount);
Assert.AreEqual(expectedTotalNodeCount, header.totalNodeCount);
AssertAABBsAreEqual(new float3(0.0f, 0.0f, 0.0f), new float3(1.0f, 1.0f, 0.0f), header.aabb_min, header.aabb_max, tolerance);
}
{
// Verify top level BVH.
uint expectedTotalNodeCount = 2 * instanceCount - 1;
var topLevelNodes = new BvhNode[(int)expectedTotalNodeCount + 1]; // plus one for header
accelStruct.topLevelBvhBuffer.GetData(topLevelNodes);
var header = UnsafeUtility.As<BvhNode, BvhHeader>(ref topLevelNodes[0]);
Assert.AreEqual(expectedTotalNodeCount, header.totalNodeCount);
Assert.AreEqual(instanceCount, header.leafNodeCount);
Assert.AreEqual(expectedTotalNodeCount, header.totalNodeCount);
AssertAABBsAreEqual(new float3(1.0f, 1.0f, 0.0f), new float3(4.0f, 2.0f, 0.0f), header.aabb_min, header.aabb_max, tolerance);
var instanceBvhRoot = topLevelNodes[1];
Assert.AreEqual(1, instanceBvhRoot.child0);
Assert.AreEqual(2, instanceBvhRoot.child1);
AssertAABBsAreEqual(new float3(1.0f, 1.0f, 0.0f), new float3(2.0f, 2.0f, 0.0f), instanceBvhRoot.aabb0_min, instanceBvhRoot.aabb0_max, tolerance);
AssertAABBsAreEqual(new float3(3.0f, 1.0f, 0.0f), new float3(4.0f, 2.0f, 0.0f), instanceBvhRoot.aabb1_min, instanceBvhRoot.aabb1_max, tolerance);
var leftChild = topLevelNodes[2];
Assert.AreEqual(0, leftChild.parent);
var rightChild = topLevelNodes[3];
Assert.AreEqual(0, leftChild.parent);
}
}
}
[TestFixture("Compute")]
[TestFixture("Hardware")]
public class AccelStructTests
{
RayTracingBackend m_Backend;
RayTracingContext m_Context;
RayTracingResources m_Resources;
IRayTracingAccelStruct m_AccelStruct;
IRayTracingShader m_Shader;
public AccelStructTests(string backendAsString)
{
m_Backend = Enum.Parse<RayTracingBackend>(backendAsString);
}
[SetUp]
public void SetUp()
{
if (!SystemInfo.supportsRayTracing && m_Backend == RayTracingBackend.Hardware)
{
Assert.Ignore("Cannot run test on this Graphics API. Hardware RayTracing is not supported");
}
if (!SystemInfo.supportsComputeShaders && m_Backend == RayTracingBackend.Compute)
{
Assert.Ignore("Cannot run test on this Graphics API. Compute shaders are not supported");
}
if (SystemInfo.graphicsDeviceName.Contains("llvmpipe"))
{
Assert.Ignore("Cannot run test on this device (Renderer: llvmpipe (LLVM 10.0.0, 128 bits)). Tests are disabled because they fail on some platforms (that do not support 11 SSBOs). Once we do not run Ubuntu 18.04 try removing this");
}
CreateRayTracingResources();
}
[TearDown]
public void TearDown()
{
DisposeRayTracingResources();
}
[Test]
public void RayTracePixelsInUnitQuad([Values(1, 10, 100)] int rayResolution, [Values(0, 1, 2, 3)] int buildFlagsAsInteger)
{
var buildFlags = (BuildFlags)buildFlagsAsInteger; // We do this ugly but simple cast hack because the BuildFlags type is not public as time of this writing (test methods must be public and so must their argument types).
// re-create the acceleration structure with suitable options
m_AccelStruct?.Dispose();
var options = new AccelerationStructureOptions() { buildFlags = buildFlags };
m_AccelStruct = m_Context.CreateAccelerationStructure(options);
Mesh mesh = MeshUtil.CreateQuadMesh();
var instanceDesc = new MeshInstanceDesc();
instanceDesc = new MeshInstanceDesc(mesh);
instanceDesc.localToWorldMatrix = Matrix4x4.identity;
instanceDesc.localToWorldMatrix.SetTRS(new Vector3(0.5f, 0.5f, 0.0f), Quaternion.identity, new Vector3(1.0f, 1.0f, 1.0f));
instanceDesc.enableTriangleCulling = false;
instanceDesc.frontTriangleCounterClockwise = true;
m_AccelStruct.AddInstance(instanceDesc);
// trace N*N rays towards the quad and expect to hit it
int N = rayResolution;
var rays = new RayWithFlags[N*N];
int rayI = 0;
for (int v = 0; v < N; ++v)
{
for (int u = 0; u < N; ++u)
{
float2 uv = new float2((float)u, (float)v);
uv += 0.5f;
uv /= N;
float3 origin = new float3(uv.x, uv.y, 1.0f);
float3 direction = new float3(0.0f, 0.0f, -1.0f);
rays[rayI] = new RayWithFlags(origin, direction);
rays[rayI].culling = (uint)RayCulling.None;
rayI++;
}
}
HitGeomAttributes[] hitAttributes = null;
var hits = TraceRays(rays, out hitAttributes);
for (int i = 0; i < hits.Length; ++i)
{
Assert.IsTrue(hits[i].Valid(), $"Expected all rays to hit the quad but ray {i} missed.");
}
}
[Test]
public void FrontOrBackFaceCulling()
{
const int instanceCount = 4;
Mesh mesh = MeshUtil.CreateSingleTriangleMesh(new float2(1.5f, 1.5f), new float3(-0.5f, -0.5f, 0.0f));
CreateMatchingRaysAndInstanceDescs(instanceCount, mesh, out RayWithFlags[] rays, out MeshInstanceDesc[] instanceDescs);
var raysDuplicated = new RayWithFlags[instanceCount * 3];
Array.Copy(rays, 0, raysDuplicated, 0, instanceCount);
Array.Copy(rays, 0, raysDuplicated, instanceCount, instanceCount);
Array.Copy(rays, 0, raysDuplicated, 2* instanceCount, instanceCount);
for (int i = 0; i < instanceCount; ++i)
{
raysDuplicated[i].culling = (uint)RayCulling.None;
raysDuplicated[i + instanceCount].culling = (uint)RayCulling.CullFrontFace;
raysDuplicated[i + instanceCount * 2].culling = (uint)RayCulling.CullBackFace;
}
instanceDescs[0].enableTriangleCulling = false;
instanceDescs[0].frontTriangleCounterClockwise = true;
instanceDescs[1].enableTriangleCulling = false;
instanceDescs[1].frontTriangleCounterClockwise = false;
instanceDescs[2].enableTriangleCulling = true;
instanceDescs[2].frontTriangleCounterClockwise = true;
instanceDescs[3].enableTriangleCulling = true;
instanceDescs[3].frontTriangleCounterClockwise = false;
for (int i = 0; i < instanceCount; ++i)
{
m_AccelStruct.AddInstance(instanceDescs[i]);
}
HitGeomAttributes[] hitAttributes = null;
var hits = TraceRays(raysDuplicated, out hitAttributes);
// No culling
Assert.IsTrue(hits[0].Valid());
Assert.IsTrue(hits[1].Valid());
Assert.IsTrue(hits[2].Valid());
Assert.IsTrue(hits[3].Valid());
// FrontFace culling
Assert.IsTrue(hits[4].Valid());
Assert.IsTrue(hits[5].Valid());
Assert.IsTrue(hits[6].Valid());
Assert.IsTrue(!hits[7].Valid());
// BackFace culling
Assert.IsTrue(hits[8].Valid());
Assert.IsTrue(hits[9].Valid());
Assert.IsTrue(!hits[10].Valid());
Assert.IsTrue(hits[11].Valid());
}
[Test]
public void InstanceAndRayMask()
{
const int instanceCount = 8;
Mesh mesh = MeshUtil.CreateSingleTriangleMesh(new float2(1.5f, 1.5f), new float3(-0.5f, -0.5f, 0.0f));
CreateMatchingRaysAndInstanceDescs(instanceCount, mesh, out RayWithFlags[] rays, out MeshInstanceDesc[] instanceDescs);
var rayAndInstanceMasks = new (uint instanceMask, uint rayMask)[]
{
(0, 0),
(0xFFFFFFFF, 0xFFFFFFFF),
(0, 0xFFFFFFFF),
(0xFFFFFFFF, 0),
(0x0F, 0x01),
(0x0F, 0xF0),
(0x90, 0xF0),
(0xF0, 0x10),
};
for (int i = 0; i < instanceCount; ++i)
{
instanceDescs[i].mask = rayAndInstanceMasks[i].instanceMask;
rays[i].instanceMask = rayAndInstanceMasks[i].rayMask;
}
for (int i = 0; i < instanceCount; ++i)
{
m_AccelStruct.AddInstance(instanceDescs[i]);
}
HitGeomAttributes[] hitAttributes = null;
var hits = TraceRays(rays, out hitAttributes);
for (int i = 0; i < instanceCount; ++i)
{
bool rayShouldHit = ((rayAndInstanceMasks[i].instanceMask & rayAndInstanceMasks[i].rayMask) != 0);
bool rayHit = hits[i].Valid();
var message = String.Format("Ray {0} hit for InstanceMask: 0x{1:X} & RayMask: 0x{2:X}",
rayShouldHit ? "should" : "shouldn't",
rayAndInstanceMasks[i].instanceMask,
rayAndInstanceMasks[i].rayMask);
Assert.AreEqual(rayShouldHit, rayHit, message);
}
}
[Test]
public void AddAndRemoveInstances()
{
const int instanceCount = 4;
Mesh mesh = MeshUtil.CreateSingleTriangleMesh(new float2(1.5f, 1.5f), new float3(-0.5f, -0.5f, 0.0f));
CreateMatchingRaysAndInstanceDescs(instanceCount, mesh, out RayWithFlags[] rays, out MeshInstanceDesc[] instanceDescs);
var instanceHandles = new int[instanceCount];
var expectedVisibleInstances = new bool[instanceCount];
for (int i = 0; i < instanceCount; ++i)
{
instanceHandles[i] = m_AccelStruct.AddInstance(instanceDescs[i]);
expectedVisibleInstances[i] = true;
}
CheckVisibleInstances(rays, expectedVisibleInstances);
m_AccelStruct.RemoveInstance(instanceHandles[0]); expectedVisibleInstances[0] = false;
m_AccelStruct.RemoveInstance(instanceHandles[2]); expectedVisibleInstances[2] = false;
CheckVisibleInstances(rays, expectedVisibleInstances);
m_AccelStruct.ClearInstances();
Array.Fill(expectedVisibleInstances, false);
CheckVisibleInstances(rays, expectedVisibleInstances);
m_AccelStruct.AddInstance(instanceDescs[3]);
expectedVisibleInstances[3] = true;
CheckVisibleInstances(rays, expectedVisibleInstances);
}
private void AddTerrainToAccelerationStructure(int heightmapResolution)
{
Terrain.CreateTerrainGameObject(new TerrainData());
Terrain terrain = GameObject.FindFirstObjectByType<Terrain>();
Assert.NotNull(terrain);
// Set terrain texture resolution on terrain data.
terrain.terrainData.heightmapResolution = heightmapResolution;
// Convert to mesh.
AsyncTerrainToMeshRequest request = TerrainToMesh.ConvertAsync(terrain);
request.WaitForCompletion();
// Add the terrain to the acceleration structure.
MeshInstanceDesc instanceDesc = new MeshInstanceDesc(request.GetMesh());
instanceDesc.localToWorldMatrix = float4x4.identity;
m_AccelStruct.AddInstance(instanceDesc);
}
[Test]
public void Add_1KTerrain_Works()
{
AddTerrainToAccelerationStructure(1025);
}
[Test]
[Ignore("This test is disabled because of the allocation limitation of 2 GB in GraphicsBuffer.")]
public void Add_4KTerrain_Works()
{
AddTerrainToAccelerationStructure(4097);
}
void CheckVisibleInstances(RayWithFlags[] rays, bool[] expectedVisibleInstances)
{
HitGeomAttributes[] hitAttributes = null;
var hits = TraceRays(rays, out hitAttributes);
for (int i = 0; i < rays.Length; ++i)
{
Assert.AreEqual(expectedVisibleInstances[i], hits[i].Valid(), $"Unexpected state of intersection with instance {i}");
}
}
void CreateMatchingRaysAndInstanceDescs(uint instanceCount, Mesh mesh, out RayWithFlags[] rays, out MeshInstanceDesc[] instanceDescs)
{
instanceDescs = new MeshInstanceDesc[instanceCount];
rays = new RayWithFlags[instanceCount];
var ray = new RayWithFlags(new float3(0.0f, 0.0f, 1.0f), new float3(0.0f, 0.0f, -1.0f));
float3 step = new float3(2.0f, 0.0f, 0.0f);
for (int i = 0; i < instanceCount; ++i)
{
instanceDescs[i] = new MeshInstanceDesc(mesh);
instanceDescs[i].localToWorldMatrix = float4x4.Translate(step * i);
rays[i] = ray;
rays[i].origin += step * i;
}
}
Hit[] TraceRays(RayWithFlags[] rays, out HitGeomAttributes[] hitAttributes)
{
var bufferTarget = GraphicsBuffer.Target.Structured;
var rayCount = rays.Length;
using var raysBuffer = new GraphicsBuffer(bufferTarget, rayCount, Marshal.SizeOf<RayWithFlags>());
raysBuffer.SetData(rays);
using var hitsBuffer = new GraphicsBuffer(bufferTarget, rayCount, Marshal.SizeOf<Hit>());
using var attributesBuffer = new GraphicsBuffer(bufferTarget, rayCount, Marshal.SizeOf<HitGeomAttributes>());
using var scratchBuffer = RayTracingHelper.CreateScratchBufferForBuildAndDispatch(m_AccelStruct, m_Shader, (uint)rayCount, 1, 1);
var cmd = new CommandBuffer();
m_AccelStruct.Build(cmd, scratchBuffer);
m_Shader.SetAccelerationStructure(cmd, "_AccelStruct", m_AccelStruct);
m_Shader.SetBufferParam(cmd, Shader.PropertyToID("_Rays"), raysBuffer);
m_Shader.SetBufferParam(cmd, Shader.PropertyToID("_Hits"), hitsBuffer);
m_Shader.Dispatch(cmd, scratchBuffer, (uint)rayCount, 1, 1);
Graphics.ExecuteCommandBuffer(cmd);
var hits = new Hit[rayCount];
hitsBuffer.GetData(hits);
hitAttributes = new HitGeomAttributes[rayCount];
attributesBuffer.GetData(hitAttributes);
return hits;
}
void CreateRayTracingResources()
{
m_Resources = new RayTracingResources();
m_Resources.Load();
m_Context = new RayTracingContext(m_Backend, m_Resources);
m_AccelStruct = m_Context.CreateAccelerationStructure(new AccelerationStructureOptions());
Type type = BackendHelpers.GetTypeOfShader(m_Backend);
string filename = BackendHelpers.GetFileNameOfShader(m_Backend, $"Tests/Editor/UnifiedRayTracing/TraceRays");
Object shader = AssetDatabase.LoadAssetAtPath($"Packages/com.unity.rendering.light-transport/{filename}", type);
m_Shader = m_Context.CreateRayTracingShader(shader);
}
void DisposeRayTracingResources()
{
m_AccelStruct?.Dispose();
m_Context?.Dispose();
}
[StructLayout(LayoutKind.Sequential)]
public struct RayWithFlags
{
public float3 origin;
public float minT;
public float3 direction;
public float maxT;
public uint culling;
public uint instanceMask;
uint padding;
uint padding2;
public RayWithFlags(float3 origin, float3 direction)
{
this.origin = origin;
this.direction = direction;
minT = 0.0f;
maxT = float.MaxValue;
instanceMask = 0xFFFFFFFF;
culling = 0;
padding = 0;
padding2 = 0;
}
}
[System.Flags]
enum RayCulling { None = 0, CullFrontFace = 0x10, CullBackFace = 0x20 }
[StructLayout(LayoutKind.Sequential)]
public struct Hit
{
public uint instanceID;
public uint primitiveIndex;
public float2 uvBarycentrics;
public float hitDistance;
public uint isFrontFace;
public bool Valid() { return instanceID != 0xFFFFFFFF; }
}
[StructLayout(LayoutKind.Sequential)]
public struct HitGeomAttributes
{
public float3 position;
public float3 normal;
public float3 faceNormal;
public float4 uv0;
public float4 uv1;
}
}
}