Navigation
API > API/Plugins > API/Plugins/XGEController
| Name | FXGEControllerModule |
| Type | class |
| Header File | /Engine/Plugins/XGEController/Source/Public/XGEControllerModule.h |
| Include Path | #include "XGEControllerModule.h" |
Syntax
class FXGEControllerModule : public IDistributedBuildController
Implements Interfaces
- IDistributedBuildController
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FXGEControllerModule() |
XGEControllerModule.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FXGEControllerModule() |
XGEControllerModule.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bControllerInitialized | bool | Whether the controller was successfully initialized. This is only possible when bSupported is true. | XGEControllerModule.h | |
| bModuleInitialized | bool | Whether the module was initialized. | XGEControllerModule.h | |
| bRestartWorker | bool | XGEControllerModule.h | ||
| bShutdown | bool | XGEControllerModule.h | ||
| bSupported | bool | Whether this system can use XGE shader compilation. | XGEControllerModule.h | |
| BuildProcessHandle | FProcHandle | XGEControllerModule.h | ||
| ControlWorkerDirectory | const FString | XGEControllerModule.h | ||
| DispatchedTasks | TMap< uint32, FDistributedBuildTask * > | Map of tasks dispatched to the controller and running within XGE, that have not yet finished. | XGEControllerModule.h | |
| InputNamedPipe | FPlatformNamedPipe | We need two pipes, as the named pipe API does not support simultaneous read/write on two threads. | XGEControllerModule.h | |
| LastEventTime | volatile uint32 | XGEControllerModule.h | ||
| NextFileID | FThreadSafeCounter | XGEControllerModule.h | ||
| NextTaskID | FThreadSafeCounter | XGEControllerModule.h | ||
| OutputNamedPipe | FPlatformNamedPipe | XGEControllerModule.h | ||
| PendingTasks | TQueue< FDistributedBuildTask * > | Queue of tasks submitted by the engine, but not yet dispatched to the controller. | XGEControllerModule.h | |
| PipeName | const FString | XGEControllerModule.h | ||
| ReadBackThreadFuture | TFuture< void > | XGEControllerModule.h | ||
| RootWorkingDirectory | const FString | XGEControllerModule.h | ||
| TasksCS | FCriticalSection * | Taken when accessing the PendingTasks and DispatchedTasks members. | XGEControllerModule.h | |
| WorkingDirectory | const FString | XGEControllerModule.h | ||
| WriteOutThreadEvent | FEventRef | Event for the thread that communicates with the XGE controller | XGEControllerModule.h | |
| WriteOutThreadFuture | TFuture< void > | XGEControllerModule.h | ||
| XGConsolePath | FString | XGEControllerModule.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void CleanWorkingDirectory() |
XGEControllerModule.h | ||
virtual FString CreateUniqueFilePath() |
XGEControllerModule.h | ||
virtual TFuture< FDistributedBuildTaskResult > EnqueueTask
(
const FTaskCommandData& CommandData |
XGEControllerModule.h | ||
virtual const FString GetName() |
XGEControllerModule.h | ||
virtual void InitializeController() |
XGEControllerModule.h | ||
virtual bool IsSupported() |
XGEControllerModule.h | ||
void ReadBackThreadProc() |
XGEControllerModule.h | ||
virtual void ShutdownModule() |
XGEControllerModule.h | ||
virtual void StartupModule() |
XGEControllerModule.h | ||
virtual bool SupportsLocalWorkers() |
XGEControllerModule.h | ||
void WriteOutThreadProc() |
XGEControllerModule.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FXGEControllerModule & Get() |
XGEControllerModule.h |