UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
RaytracingOptions.h File Reference
#include "RHIDefinitions.h"
#include "RayTracingPayloadType.h"

Go to the source code of this file.

Classes

struct  FRayTracingPrimaryRaysOptions
 

Namespaces

namespace  RayTracing
 

Enumerations

enum class  ERayTracingPrimaryRaysFlag : uint32 { None = 0 , UseGBufferForMaxDistance = 1 << 0 , PrimaryView = 1 << 1 , AllowSkipSkySample = 1 << 2 }
 
enum class  ERayTracingPipelineCompatibilityFlags { FullPipeline = 1 << 0 , Inline = 1 << 1 }
 
enum class  RayTracing::ECullingMode : uint8 {
  RayTracing::Disabled , RayTracing::BehindCameraByDistanceAndSolidAngle , RayTracing::DistanceAndSolidAngle , RayTracing::DistanceOrSolidAngle ,
  RayTracing::MAX
}
 

Functions

 ENUM_CLASS_FLAGS (ERayTracingPrimaryRaysFlag)
 
 ENUM_CLASS_FLAGS (ERayTracingPipelineCompatibilityFlags)
 
FORCEINLINE bool ShouldRenderRayTracingEffect (bool bEffectEnabled, ERayTracingPipelineCompatibilityFlags CompatibilityFlags, const FSceneView &View)
 
FORCEINLINE bool ShouldRenderRayTracingEffect (bool bEffectEnabled, ERayTracingPipelineCompatibilityFlags CompatibilityFlags, const FSceneViewFamily &ViewFamily)
 
FORCEINLINE bool ShouldRenderRayTracingSkyLightEffect ()
 
FORCEINLINE bool ShouldRenderRayTracingSkyLight (const FSkyLightSceneProxy *SkyLightSceneProxy, EShaderPlatform ShaderPlatform)
 
FORCEINLINE bool ShouldRenderRayTracingAmbientOcclusion (const FViewInfo &View)
 
FORCEINLINE bool ShouldRenderRayTracingTranslucency (const FViewInfo &View)
 
FORCEINLINE bool ShouldRenderRayTracingShadows (const FSceneViewFamily &ViewFamily)
 
FORCEINLINE bool ShouldRenderRayTracingShadowsForLight (const FSceneViewFamily &ViewFamily, const FLightSceneProxy &LightProxy)
 
FORCEINLINE bool ShouldRenderRayTracingShadowsForLight (const FSceneViewFamily &ViewFamily, const FLightSceneInfoCompact &LightInfo)
 
FORCEINLINE bool ShouldRenderPluginRayTracingGlobalIllumination (const FViewInfo &View)
 
FORCEINLINE bool HasRayTracedOverlay (const FSceneViewFamily &ViewFamily)
 
FORCEINLINE ECullingMode RayTracing::GetCullingMode (const FEngineShowFlags &ShowFlags)
 
FORCEINLINE float GetRayTracingCullingRadius ()
 
FORCEINLINE bool CanUseRayTracingAMDHitToken ()
 
FORCEINLINE bool IsRayTracingInstanceDebugDataEnabled (const FViewInfo &View)
 
FORCEINLINE bool IsRayTracingInstanceOverlapEnabled (const FViewInfo &View)
 
FORCEINLINE bool IsRayTracingFeedbackEnabled (const FSceneViewFamily &ViewFamily)
 
FORCEINLINE bool RaytracingDebugViewModeNeedsTonemapping (const FViewInfo &View)
 

Enumeration Type Documentation

◆ ERayTracingPipelineCompatibilityFlags

Enumerator
FullPipeline 
Inline 

◆ ERayTracingPrimaryRaysFlag

Enumerator
None 
UseGBufferForMaxDistance 
PrimaryView 
AllowSkipSkySample 

Function Documentation

◆ CanUseRayTracingAMDHitToken()

FORCEINLINE bool CanUseRayTracingAMDHitToken ( )

◆ ENUM_CLASS_FLAGS() [1/2]

ENUM_CLASS_FLAGS ( ERayTracingPipelineCompatibilityFlags  )

◆ ENUM_CLASS_FLAGS() [2/2]

ENUM_CLASS_FLAGS ( ERayTracingPrimaryRaysFlag  )

◆ GetRayTracingCullingRadius()

FORCEINLINE float GetRayTracingCullingRadius ( )

◆ HasRayTracedOverlay()

FORCEINLINE bool HasRayTracedOverlay ( const FSceneViewFamily ViewFamily)

◆ IsRayTracingFeedbackEnabled()

FORCEINLINE bool IsRayTracingFeedbackEnabled ( const FSceneViewFamily ViewFamily)

◆ IsRayTracingInstanceDebugDataEnabled()

FORCEINLINE bool IsRayTracingInstanceDebugDataEnabled ( const FViewInfo View)

◆ IsRayTracingInstanceOverlapEnabled()

FORCEINLINE bool IsRayTracingInstanceOverlapEnabled ( const FViewInfo View)

◆ RaytracingDebugViewModeNeedsTonemapping()

FORCEINLINE bool RaytracingDebugViewModeNeedsTonemapping ( const FViewInfo View)

◆ ShouldRenderPluginRayTracingGlobalIllumination()

FORCEINLINE bool ShouldRenderPluginRayTracingGlobalIllumination ( const FViewInfo View)

◆ ShouldRenderRayTracingAmbientOcclusion()

FORCEINLINE bool ShouldRenderRayTracingAmbientOcclusion ( const FViewInfo View)

◆ ShouldRenderRayTracingEffect() [1/2]

FORCEINLINE bool ShouldRenderRayTracingEffect ( bool  bEffectEnabled,
ERayTracingPipelineCompatibilityFlags  CompatibilityFlags,
const FSceneView View 
)

◆ ShouldRenderRayTracingEffect() [2/2]

FORCEINLINE bool ShouldRenderRayTracingEffect ( bool  bEffectEnabled,
ERayTracingPipelineCompatibilityFlags  CompatibilityFlags,
const FSceneViewFamily ViewFamily 
)

◆ ShouldRenderRayTracingShadows()

FORCEINLINE bool ShouldRenderRayTracingShadows ( const FSceneViewFamily ViewFamily)

◆ ShouldRenderRayTracingShadowsForLight() [1/2]

FORCEINLINE bool ShouldRenderRayTracingShadowsForLight ( const FSceneViewFamily ViewFamily,
const FLightSceneInfoCompact LightInfo 
)

◆ ShouldRenderRayTracingShadowsForLight() [2/2]

FORCEINLINE bool ShouldRenderRayTracingShadowsForLight ( const FSceneViewFamily ViewFamily,
const FLightSceneProxy LightProxy 
)

◆ ShouldRenderRayTracingSkyLight()

FORCEINLINE bool ShouldRenderRayTracingSkyLight ( const FSkyLightSceneProxy SkyLightSceneProxy,
EShaderPlatform  ShaderPlatform 
)

◆ ShouldRenderRayTracingSkyLightEffect()

FORCEINLINE bool ShouldRenderRayTracingSkyLightEffect ( )

◆ ShouldRenderRayTracingTranslucency()

FORCEINLINE bool ShouldRenderRayTracingTranslucency ( const FViewInfo View)