FloodSpill 1.0.2

There is a newer version of this package available.
See the version list below for details.
dotnet add package FloodSpill --version 1.0.2                
NuGet\Install-Package FloodSpill -Version 1.0.2                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="FloodSpill" Version="1.0.2" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add FloodSpill --version 1.0.2                
#r "nuget: FloodSpill, 1.0.2"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install FloodSpill as a Cake Addin
#addin nuget:?package=FloodSpill&version=1.0.2

// Install FloodSpill as a Cake Tool
#tool nuget:?package=FloodSpill&version=1.0.2                

FloodSpiller-CSharp — an open-source multi-purpose flood-filling algorithm for C#

What can you do with it?

  • run a flood-fill in two-dimensional space
  • pass your own conditions for visiting positions and for stopping the flood
  • pass your own callbacks that will be executed for visited positions
  • use LIFO, FIFO or priority queue for deciding in what order positions should be processed
  • use scanline fill to double up execution speed
  • reuse position queue and the matrix used for marking visited positions to minimize memory allocation

It is:

  • fast
  • easy to use
  • elastic
  • compatible with .NET Standard 2.0 and .NET Framework 3.5

Code sample

private int[,] _positionMarkMatrix;

public void BucketFillImage(int floodStartX, int floodStartY, Color replacedColor, Color targetColor)
{
	var floodParameters = new FloodParameters(floodStartX, floodStartY)
	{
		BoundsRestriction = new FloodBounds(_imageSizeX, _imageSizeY),
		NeighbourhoodType = NeighbourhoodType.Four,
		Qualifier = (x, y) => GetColor(x, y) == replacedColor,
		NeighbourProcessor = (x, y, mark) => SetColor(x, y, targetColor),
		ProcessStartAsFirstNeighbour = true
	};

	var floodSpiller = new FloodSpiller();
	floodSpiller.SpillFlood(floodParameters, _positionMarkMatrix);
}

Performance report (measured with BenchmarkDotNet)

Area size Walls blocking flood Mode Average execution time
20x20 No walls (open area) Normal 32 µs
20x20 No walls (open area) Scanline 14 µs
20x20 Sparse pillars (11% of area) Normal 31 µs
20x20 Sparse pillars (11% of area) Scanline 25 µs
20x20 Circular walls (50% of area) Normal 19 µs
20x20 Circular walls (50% of area) Scanline 11 µs
200x200 No walls (open area) Normal 3,222 µs
200x200 No walls (open area) Scanline 1,249 µs
200x200 Sparse pillars (11% of area) Normal 2,868 µs
200x200 Sparse pillars (11% of area) Scanline 2,624 µs
200x200 Circular walls (50% of area) Normal 1,877 µs
200x200 Circular walls (50% of area) Scanline 947 µs
2000x2000 No walls (open area) Normal 355,445 µs
2000x2000 No walls (open area) Scanline 124,329 µs
2000x2000 Sparse pillars (11% of area) Normal 309,879 µs
2000x2000 Sparse pillars (11% of area) Scanline 267,670 µs
2000x2000 Circular walls (50% of area) Normal 204,312 µs
2000x2000 Circular walls (50% of area) Scanline 92,618 µs
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net35 is compatible.  net40 was computed.  net403 was computed.  net45 was computed.  net451 was computed.  net452 was computed.  net46 was computed.  net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • .NETFramework 3.5

    • C5 (>= 2.5.3)
  • .NETStandard 2.0

    • C5 (>= 2.5.3)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.4 1,238 2/8/2019
1.0.3 695 12/10/2018
1.0.2 632 12/6/2018

First complete release.