SceneUtils.h File Reference

#include "UObject/ObjectMacros.h"
#include "RHIFeatureLevel.h"
#include "SceneUtils.generated.h"

Go to the source code of this file.

Classes
class	FDelayedRendererAction

Enumerations
enum class	EShadingPath { Mobile , Deferred , Num }
enum class	EMobileHDRMode { Unset , Disabled , EnabledFloat16 }
enum	EAntiAliasingMethod : int {   UMETA =(DisplayName = "None") , UMETA =(DisplayName = "None") , UMETA =(DisplayName = "None") , UMETA =(DisplayName = "None") ,   UMETA =(DisplayName = "None") , UMETA =(DisplayName = "None") , AAM_MAX }
enum class	ECustomDepthMode : uint8 { Disabled , Enabled , EnabledWithStencil }

Functions
ENGINE_API	DECLARE_LOG_CATEGORY_EXTERN (LogSceneUtils, Log, All)
EShadingPath	GetFeatureLevelShadingPath (FStaticFeatureLevel InFeatureLevel)
bool	IsTemporalAccumulationBasedMethod (EAntiAliasingMethod AntiAliasingMethod)
ENGINE_API bool	IsMobilePropagateAlphaEnabled (EShaderPlatform Platform)
ENGINE_API bool	IsMobileTonemapSubpassEnabled (EShaderPlatform Platform, bool bMultiViewRendering)
ENGINE_API bool	IsMobileTonemapSubpassEnabledInline (EShaderPlatform Platform, bool bMultiViewRendering, uint32 NumMSAASamples)
ENGINE_API bool	IsMobileColorsRGB ()
ENGINE_API EAntiAliasingMethod	GetDefaultAntiAliasingMethod (const FStaticFeatureLevel InFeatureLevel)
ENGINE_API const TCHAR *	GetShortAntiAliasingName (EAntiAliasingMethod AntiAliasingMethod)
ENGINE_API uint32	GetDefaultMSAACount (const FStaticFeatureLevel InFeatureLevel, uint32 PlatformMaxSampleCount=8)
ENGINE_API ECustomDepthMode	GetCustomDepthMode ()
bool	IsCustomDepthPassEnabled ()

Enumeration Type Documentation

EAntiAliasingMethod

enum EAntiAliasingMethod : int

Used by rendering project settings.

Enumerator
UMETA	Only supported with forward shading. MSAA sample count is controlled by r.MSAACount.
UMETA	Only supported with forward shading. MSAA sample count is controlled by r.MSAACount.
UMETA	Only supported with forward shading. MSAA sample count is controlled by r.MSAACount.
UMETA	Only supported with forward shading. MSAA sample count is controlled by r.MSAACount.
UMETA	Only supported with forward shading. MSAA sample count is controlled by r.MSAACount.
UMETA	Only supported with forward shading. MSAA sample count is controlled by r.MSAACount.
AAM_MAX

ECustomDepthMode

enum class ECustomDepthMode : uint8

strong

Enumerator
Disabled
Enabled
EnabledWithStencil

EMobileHDRMode

enum class EMobileHDRMode

strong

Enumerator
Unset
Disabled
EnabledFloat16

EShadingPath

enum class EShadingPath

strong

Enumerator
Mobile
Deferred
Num

Function Documentation

DECLARE_LOG_CATEGORY_EXTERN()

ENGINE_API DECLARE_LOG_CATEGORY_EXTERN	(	LogSceneUtils	,
		Log	,
		All
	)

This file contains the various draw mesh macros that display draw calls inside of PIX.

GetCustomDepthMode()

ENGINE_API ECustomDepthMode GetCustomDepthMode ( )

extern

GetDefaultAntiAliasingMethod()

ENGINE_API EAntiAliasingMethod GetDefaultAntiAliasingMethod

(

const FStaticFeatureLevel

InFeatureLevel

)

GetDefaultMSAACount()

ENGINE_API uint32 GetDefaultMSAACount	(	const FStaticFeatureLevel	InFeatureLevel,
		uint32	PlatformMaxSampleCount = 8
	)

GetFeatureLevelShadingPath()

EShadingPath GetFeatureLevelShadingPath ( FStaticFeatureLevel  InFeatureLevel )

inline

GetShortAntiAliasingName()

ENGINE_API const TCHAR * GetShortAntiAliasingName

(

EAntiAliasingMethod

AntiAliasingMethod

)

IsCustomDepthPassEnabled()

bool IsCustomDepthPassEnabled ( )

inline

IsMobileColorsRGB()

ENGINE_API bool IsMobileColorsRGB

(

)

IsMobilePropagateAlphaEnabled()

ENGINE_API bool IsMobilePropagateAlphaEnabled

(

EShaderPlatform

Platform

)

True if Alpha Propagate is enabled for the mobile renderer.

IsMobileTonemapSubpassEnabled()

ENGINE_API bool IsMobileTonemapSubpassEnabled	(	EShaderPlatform	Platform,
		bool	bMultiViewRendering
	)

IsMobileTonemapSubpassEnabledInline()

ENGINE_API bool IsMobileTonemapSubpassEnabledInline	(	EShaderPlatform	Platform,
		bool	bMultiViewRendering,
		uint32	NumMSAASamples
	)

IsTemporalAccumulationBasedMethod()

bool IsTemporalAccumulationBasedMethod ( EAntiAliasingMethod  AntiAliasingMethod )

inline

Returns whether the anti-aliasing method use a temporal accumulation