Class EffectCompilerFactory

Namespace

Stride.Shaders.Compiler

Assembly

Stride.Engine.dll

public static class EffectCompilerFactory

Inheritance

object

EffectCompilerFactory

Properties

RemoteEffectCompilerEnabled

Whether the remote effect compiler (connecting to Game Studio over a socket to compile shaders) is available. Set the "Stride.Engine.RemoteEffectCompilerEnabled" feature switch to false to let trimming/AOT drop the remote compiler and its networking stack (e.g. for shipping/iOS builds, which only load precompiled effects or compile locally).

[FeatureSwitchDefinition("Stride.Engine.RemoteEffectCompilerEnabled")]
public static bool RemoteEffectCompilerEnabled { get; }

Property Value

bool

Methods

CreateEffectCompiler(IVirtualFileProvider, EffectSystem, string, EffectCompilationMode, bool, TaskSchedulerSelector, DatabaseFileProvider)

public static IEffectCompiler CreateEffectCompiler(IVirtualFileProvider fileProvider, EffectSystem effectSystem = null, string packageName = null, EffectCompilationMode effectCompilationMode = EffectCompilationMode.Local, bool recordEffectRequested = false, TaskSchedulerSelector taskSchedulerSelector = null, DatabaseFileProvider database = null)

Parameters

fileProvider IVirtualFileProvider

effectSystem EffectSystem

packageName string

effectCompilationMode EffectCompilationMode

recordEffectRequested bool

taskSchedulerSelector TaskSchedulerSelector

database DatabaseFileProvider

Returns

IEffectCompiler