FSCWErrorCode Struct Reference

#include <ShaderCompileWorkerUtil.h>

Public Types
enum	ECode : int32 {   NotSet = -1 , Success , GeneralCrash , BadShaderFormatVersion ,   BadInputVersion , BadSingleJobHeader , BadPipelineJobHeader , CantDeleteInputFile ,   CantSaveOutputFile , NoTargetShaderFormatsFound , CantCompileForSpecificFormat , CrashInsidePlatformCompiler ,   BadInputFile , OutOfMemory }

Static Public Member Functions
static RENDERCORE_API void	Report (ECode Code, const FStringView &Info={})
static RENDERCORE_API void	Reset ()
static RENDERCORE_API ECode	Get ()
static RENDERCORE_API const FString &	GetInfo ()
static RENDERCORE_API bool	IsSet ()

Member Enumeration Documentation

ECode

enum FSCWErrorCode::ECode : int32

Enumerator
NotSet
Success
GeneralCrash
BadShaderFormatVersion
BadInputVersion
BadSingleJobHeader
BadPipelineJobHeader
CantDeleteInputFile
CantSaveOutputFile
NoTargetShaderFormatsFound
CantCompileForSpecificFormat
CrashInsidePlatformCompiler
BadInputFile
OutOfMemory

Member Function Documentation

Get()

FSCWErrorCode::ECode FSCWErrorCode::Get ( )

static

Returns the global SCW error code.

GetInfo()

const FString & FSCWErrorCode::GetInfo ( )

static

Returns the global SCW error code information string. Empty string if not set.

IsSet()

bool FSCWErrorCode::IsSet ( )

static

Returns true if the SCW global error code has been set. Equivalent to 'Get() != NotSet'.

Report()

void FSCWErrorCode::Report ( ECode  Code, const FStringView &  Info = {}  )

static

Sets the global SCW error code if it hasn't been set before. Call Reset first before setting a new value. Returns true on success, otherwise the error code has already been set.

Reset()

void FSCWErrorCode::Reset ( )

static

Resets the global SCW error code to NotSet.

---

The documentation for this struct was generated from the following files:

• Engine/Source/Runtime/RenderCore/Internal/ShaderCompileWorkerUtil.h
• Engine/Source/Runtime/RenderCore/Private/ShaderCore.cpp