Struct ParallelExecutionSettings

Defines execution settings for methods in ParallelRowIterator.

Namespace: SixLabors.ImageSharp.Advanced

Assembly: SixLabors.ImageSharp.dll

Syntax

public readonly struct ParallelExecutionSettings

Constructors

| Improve this Doc View Source

ParallelExecutionSettings(Int32, MemoryAllocator)

Initializes a new instance of the ParallelExecutionSettings struct.

Declaration

public ParallelExecutionSettings(int maxDegreeOfParallelism, MemoryAllocator memoryAllocator)

Parameters

Type	Name	Description
Int32	maxDegreeOfParallelism	The value used for initializing when using TPL.
MemoryAllocator	memoryAllocator	The MemoryAllocator.

| Improve this Doc View Source

ParallelExecutionSettings(Int32, Int32, MemoryAllocator)

Initializes a new instance of the ParallelExecutionSettings struct.

Declaration

public ParallelExecutionSettings(int maxDegreeOfParallelism, int minimumPixelsProcessedPerTask, MemoryAllocator memoryAllocator)

Parameters

Type	Name	Description
Int32	maxDegreeOfParallelism	The value used for initializing when using TPL.
Int32	minimumPixelsProcessedPerTask	The value for MinimumPixelsProcessedPerTask.
MemoryAllocator	memoryAllocator	The MemoryAllocator.

Fields

| Improve this Doc View Source

DefaultMinimumPixelsProcessedPerTask

Default value for MinimumPixelsProcessedPerTask.

Declaration

public const int DefaultMinimumPixelsProcessedPerTask = null

Field Value

Type	Description
Int32

Properties

| Improve this Doc View Source

MaxDegreeOfParallelism

Gets the value used for initializing when using TPL.

Declaration

public readonly int MaxDegreeOfParallelism { get; }

Property Value

Type	Description
Int32

| Improve this Doc View Source

MemoryAllocator

Gets the MemoryAllocator.

Declaration

public readonly MemoryAllocator MemoryAllocator { get; }

Property Value

Type	Description
MemoryAllocator

| Improve this Doc View Source

MinimumPixelsProcessedPerTask

Gets the minimum number of pixels being processed by a single task when parallelizing operations with TPL. Launching tasks for pixel regions below this limit is not worth the overhead. Initialized with DefaultMinimumPixelsProcessedPerTask by default, the optimum value is operation specific. (The cheaper the operation, the larger the value is.)

Declaration

public readonly int MinimumPixelsProcessedPerTask { get; }

Property Value

Type	Description
Int32

Methods

| Improve this Doc View Source

FromConfiguration(Configuration)

Get the default ParallelExecutionSettings for a Configuration

Declaration

public static ParallelExecutionSettings FromConfiguration(Configuration configuration)

Parameters

Type	Name	Description
Configuration	configuration	The Configuration.

Returns

Type	Description
ParallelExecutionSettings	The ParallelExecutionSettings.

| Improve this Doc View Source

MultiplyMinimumPixelsPerTask(Int32)

Creates a new instance of ParallelExecutionSettings having MinimumPixelsProcessedPerTask multiplied by multiplier

Declaration

public readonly ParallelExecutionSettings MultiplyMinimumPixelsPerTask(int multiplier)

Parameters

Type	Name	Description
Int32	multiplier	The value to multiply MinimumPixelsProcessedPerTask with.

Returns

Type	Description
ParallelExecutionSettings	The modified ParallelExecutionSettings.