Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > FShaderCompileThreadRunnableBase

Light Theme

Dark Theme

FShaderCompileThreadRunnableBase

Windows

MacOS

Linux

Inheritance Hierarchy

FRunnable

FShaderCompileThreadRunnableBase

	FShaderCompileDistributedThreadRunnable_Interface
	FShaderCompileFASTBuildThreadRunnable
	FShaderCompileThreadRunnable

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Public/ShaderCompiler.h
Include	#include "ShaderCompiler.h"

Syntax

class FShaderCompileThreadRunnableBase : public FRunnable

Variables

	Name	Description
TAtomic< bool >	bForceFinish
bool	bTerminatedByError	True if the thread has been terminated by an unhandled exception.
FString	ErrorMessage	If the thread has been terminated by an unhandled exception, this contains the error message.
FShaderCompilin...	Manager	The manager for this thread
int32	MaxPriorityIndex
int32	MinPriorityIndex
FRunnableThread...	Thread	The runnable thread

Constructors

	Name	Description
	FShaderCompileThreadRunnableBase ( FShaderCompilingManager* InMan... )

Destructors

	Name	Description
	~FShaderCompileThreadRunnableBase()

Functions

	Name	Description
void	CheckHealth()	Checks the thread's health, and passes on any errors that have occured.
int32	CompilingLoop()	Main work loop.
void	SetPriorityRange ( EShaderCompileJobPriority MinPriori..., EShaderCompileJobPriority MaxPriori... )
void	StartThread()
void	WaitForCompletion()

Overridden from FRunnable

		Name	Description
	uint32	Run()	Entry point for the shader compiling thread.
	void	Stop()	Stops the runnable object. This is called if a thread is requested to terminate early.

Name

Description

Run()

Entry point for the shader compiling thread.

Stop()

Stops the runnable object.

This is called if a thread is requested to terminate early.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss