Class EffectPriorityScheduler

Namespace

Stride.Shaders.Compiler

Assembly

Stride.Shaders.dll

A TaskScheduler with control over concurrency and priority, useful with EffectCompilerCache.

public class EffectPriorityScheduler : TaskScheduler, IDisposable

Inheritance

object

TaskScheduler

EffectPriorityScheduler

Implements

IDisposable

Inherited Members

TaskScheduler.FromCurrentSynchronizationContext()

TaskScheduler.TryDequeue(Task)

TaskScheduler.TryExecuteTask(Task)

TaskScheduler.Current

TaskScheduler.Default

TaskScheduler.Id

TaskScheduler.UnobservedTaskException

Extension Methods

ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder)

ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder)

Constructors

EffectPriorityScheduler(ThreadPriority, int)

public EffectPriorityScheduler(ThreadPriority threadPriority, int maximumConcurrencyLevel)

Parameters

threadPriority ThreadPriority

maximumConcurrencyLevel int

Properties

MaximumConcurrencyLevel

Indicates the maximum concurrency level this TaskScheduler is able to support.

public override int MaximumConcurrencyLevel { get; }

Property Value

int

Returns an integer that represents the maximum concurrency level. The default scheduler returns MaxValue.

QueuedTaskCount

public int QueuedTaskCount { get; }

Property Value

int

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

GetOrCreatePriorityGroup(int)

Gets the or create a task scheduler for the given priority.

public TaskScheduler GetOrCreatePriorityGroup(int priority)

Parameters

priority int

The priority.

Returns

TaskScheduler

GetScheduledTasks()

For debugger support only, generates an enumerable of Task instances currently queued to the scheduler waiting to be executed.

protected override IEnumerable<Task> GetScheduledTasks()

Returns

IEnumerable<Task>

An enumerable that allows a debugger to traverse the tasks currently queued to this scheduler.

Exceptions

NotSupportedException

This scheduler is unable to generate a list of queued tasks at this time.

QueueTask(Task)

Queues a Task to the scheduler.

protected override void QueueTask(Task task)

Parameters

task Task

The Task to be queued.

Exceptions

ArgumentNullException

The task argument is null.

TryExecuteTaskInline(Task, bool)

Determines whether the provided Task can be executed synchronously in this call, and if it can, executes it.

protected override bool TryExecuteTaskInline(Task task, bool taskWasPreviouslyQueued)

Parameters

task Task

The Task to be executed.

taskWasPreviouslyQueued bool

A Boolean denoting whether or not task has previously been queued. If this parameter is True, then the task may have been previously queued (scheduled); if False, then the task is known not to have been queued, and this call is being made in order to execute the task inline without queuing it.

Returns

bool

A Boolean value indicating whether the task was executed inline.

Exceptions

ArgumentNullException

The task argument is null.

InvalidOperationException

The task was already executed.