RayTracingInstance.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "RenderResource.h"
#include "MeshBatch.h"
 
class FRayTracingGeometry;
 
enum class ERayTracingInstanceLayer : uint8
{
    NearField,
    FarField,
};
 
struct FRayTracingInstance
{
    const FRayTracingGeometry* Geometry;
 
    TArray<FMeshBatch> Materials;
 
    TConstArrayView<FMeshBatch> MaterialsView;
 
    bool OwnsMaterials() const
    {
        return Materials.Num() != 0;
    }
 
    TArrayView<const FMeshBatch> GetMaterials() const
    {
        if (OwnsMaterials())
        {
            check(MaterialsView.Num() == 0);
            return TArrayView<const FMeshBatch>(Materials);
        }
        else
        {
            check(Materials.Num() == 0);
            return MaterialsView;
        }
    }
 
    bool bApplyLocalBoundsTransform = false;
 
    bool bThinGeometry = false;
 
    UE_DEPRECATED(5.6, "Near/far field assignment is done based on ERayTracingPrimitiveFlags::FarField.")
    ERayTracingInstanceLayer InstanceLayer = ERayTracingInstanceLayer::NearField;
 
    bool bInstanceMaskAndFlagsDirty = true;
 
    uint32 NumTransforms = 0;
 
    // Indices of primitive instances to be included in ray tracing scene
    TArray<uint32> PrimitiveInstanceIndices;
 
    TConstArrayView<uint32> PrimitiveInstanceIndicesView;
 
    bool OwnsPrimitiveInstanceIndices() const
    {
        return PrimitiveInstanceIndices.Num() != 0;
    }
 
    TConstArrayView<uint32> GetPrimitiveInstanceIndices() const
    {
        if (OwnsPrimitiveInstanceIndices())
        {
            check(PrimitiveInstanceIndicesView.Num() == 0);
            return TConstArrayView<uint32>(PrimitiveInstanceIndices);
        }
        else
        {
            check(PrimitiveInstanceIndices.Num() == 0);
            return PrimitiveInstanceIndicesView;
        }
    }
 
    TArray<FMatrix> InstanceTransforms;
 
    TConstArrayView<FMatrix> InstanceTransformsView;
 
    bool OwnsTransforms() const
    {
        return InstanceTransforms.Num() != 0;
    }
 
    TConstArrayView<FMatrix> GetTransforms() const
    {
        if (OwnsTransforms())
        {
            check(InstanceTransformsView.Num() == 0);
            return TConstArrayView<FMatrix>(InstanceTransforms);
        }
        else
        {
            check(InstanceTransforms.Num() == 0);
            return InstanceTransformsView;
        }
    }
 
    //disable deprecation warnings for default constructors
    PRAGMA_DISABLE_DEPRECATION_WARNINGS
    FRayTracingInstance() = default;
    FRayTracingInstance(const FRayTracingInstance&) = default;
    FRayTracingInstance& operator=(const FRayTracingInstance&) = default;
    FRayTracingInstance(FRayTracingInstance&&) = default;
    FRayTracingInstance& operator=(FRayTracingInstance&&) = default;
    ~FRayTracingInstance() = default;
    PRAGMA_ENABLE_DEPRECATION_WARNINGS
};