Flood Fill Algorithms in C# and GDI+

• Download source files - 17.5 Kb
• Download demo project - 110 Kb

Prerequisites

This article assumes that you have a basic understanding of:

• Direct pixel access in GDI+
• Pointers
• I highly recommend reading all of the articles in Christian Graus's image processing series, but if you don't read them all, at least you should read the first one - it gives you the basic knowledge necessary for pixel manipulation in GDI+.

Introduction/Overview

GDI+ does not have built-in flood fill capabilities. This example shows you how to create three different flood-fill algorithms for GDI+. It expands on the typical flood fill implementation by allowing adjustable color tolerance, and optional 8-way (diagonal) branching.

The flood fill algorithms will not be as fast as they would be if they were written in assembler, but you most likely won't notice this in ordinary use, because they are still quite fast.

Background

There are two main types of flood fills. The most common is 4-direction flood fill. This type of flood fill starts from a single point and branches up, down, and to the right and left. The 8-direction flood fill is similar to the 4-direction, except that it also branches diagonally.

Figure 1: The 4-direction flood fill branches in 4 directions from each pixel, whereas the 8-direction flood fill branches in 8 directions from each pixel.

The algorithms

We will look at 3 different flood fill algorithms - linear, recursive, and queue.

Recursive

This is the most common algortihm, and simplest to implement. The recursive algorithm branches in all directions at once. This can (read: often will) lead to stack overflows in a managed environment.

Queue

The queue algorithm is similar to the recursive algorithm, except that it adds the points to be checked to a queue rather than calling them directly. The loop returns immediately to the main fill method, rather than calling itself recursively. It requires extra heap space for a queue, but it uses hardly any stack space.

The queue algorithm is by far the slowest algorithm, taking about twice as long as the others. This may be partly because of lack of optimizations in the .NET Queue class, but the queue method would be slower regardless of whether the Queue class was optimized.

Linear

The linear algorithm first finds the horizontal extent of the color on a given level, then it moves horizontally from left to right, initializing the fill loop upwards and downwards for each point along the way.

By handling vertical and horizontal checking separately, this algorithm consumes only half the stack space that the recursive algorithm uses, while avoiding the extra heap space needed for a queue. It is also just as fast as the recursive algorithm.

Needless to say, the linear algorithm is the best algorithm of the three covered here. I decided to cover the others because they would inevitably be brought up anyway if I didn't do it in the article. Anyway, it's nice to see some other kinds of techniques that could be used.

The demonstration program

The demo program allows you to open and save bitmap files, and flood-fill them. It allows you to change the fill color and color tolerance for the fill operation, and has a brief explanation of each algorithm. You can watch the fill operation in slow motion (helpful for understanding how the different algorithms work). You can also see how long the flood fill operation took.

The code

So as not to take up too much space, I am only showing a small part of the code - the method that starts the fill, the 4-way version of the linear algorithm, and the function that checks the pixels.

///<SUMMARY>initializes the FloodFill operation</SUMMARY>

public override void FloodFill(Bitmap bmp, Point pt)
{
    //timeGetTime() is used instead of the 

    //performance ctr, for Win98/ME compatibility

    int ctr=timeGetTime(); 
    
    //get the color's int value, and convert it from 

    //RGBA to BGRA format (as GDI+ uses BGRA)

    m_fillcolor=ColorTranslator.ToWin32(m_fillcolorcolor);
    m_fillcolor=BGRA(GetB(m_fillcolor),
        GetG(m_fillcolor),GetR(m_fillcolor),GetA(m_fillcolor));
    
    //get the bits

    BitmapData bmpData=bmp.LockBits(
            new Rectangle(0,0,bmp.Width,bmp.Height),
            ImageLockMode.ReadWrite,
            PixelFormat.Format32bppArgb);
    System.IntPtr Scan0 = bmpData.Scan0;
    
    unsafe
    {
        //resolve pointer

        byte * scan0=(byte *)(void *)Scan0;
        //get the starting color

        //[loc += Y offset + X offset]

        int loc=CoordsToIndex(pt.X,pt.Y,bmpData.Stride);
        int color= *((int*)(scan0+loc));
        
        //create the array of bools that indicates whether each pixel

        //has been checked.  

        //(Should be bitfield, but C# doesn't support bitfields.)

        PixelsChecked=new bool;
        
        //do the first call to the loop

        switch(m_FillStyle)
        {
            case FloodFillStyle.Linear :
                if(m_FillDiagonal)
                {
                        LinearFloodFill8(scan0,pt.X,pt.Y,
                            new Size(bmpData.Width,bmpData.Height),
                            bmpData.Stride,
                            (byte*)&color);
                }else{
                        LinearFloodFill4(scan0,pt.X,pt.Y,
                            new Size(bmpData.Width,bmpData.Height),
                            bmpData.Stride,
                            (byte*)&color);
                }
                break;
            case FloodFillStyle.Queue :
                QueueFloodFill(scan0,pt.X,pt.Y,
                    new Size(bmpData.Width,bmpData.Height),
                    bmpData.Stride,
                    (byte*)&color);
                break;
            case FloodFillStyle.Recursive :
                if(m_FillDiagonal)
                {
                        RecursiveFloodFill8(scan0,pt.X,pt.Y,
                            new Size(bmpData.Width,bmpData.Height),
                            bmpData.Stride,
                            (byte*)&color);
                }else{
                        RecursiveFloodFill4(scan0,pt.X,pt.Y,
                            new Size(bmpData.Width,bmpData.Height),
                            bmpData.Stride,
                            (byte*)&color);
                }
                break;
        }
    }
    
    bmp.UnlockBits(bmpData);
        
    m_TimeBenchmark=timeGetTime()-ctr;
        
}



unsafe void LinearFloodFill4( byte* scan0, int x, int y,Size bmpsize,
                                int stride, byte* startcolor)
{
        
    //offset the pointer to the point passed in

    int* p=(int*) (scan0+(CoordsToIndex(x,y, stride)));
    
    
    //FIND LEFT EDGE OF COLOR AREA

    int LFillLoc=x; //the location to check/fill on the left

    int* ptr=p; //the pointer to the current location

    while(true)
    {
        ptr[0]=m_fillcolor;      //fill with the color

        PixelsChecked[LFillLoc,y]=true;
        LFillLoc--;               //de-increment counter

        ptr-=1;                      //de-increment pointer

        if(LFillLoc<=0 || 
            !CheckPixel((byte*)ptr,startcolor) ||  
            (PixelsChecked[LFillLoc,y]))
                //exit loop if we're at edge of bitmap or color area

                break;
        
    }
    LFillLoc++;
    
    //FIND RIGHT EDGE OF COLOR AREA

    int RFillLoc=x; //the location to check/fill on the left

    ptr=p;
    while(true)
    {
        ptr[0]=m_fillcolor; //fill with the color

        PixelsChecked[RFillLoc,y]=true;
        RFillLoc++;          //increment counter

        ptr+=1;                 //increment pointer

        if(RFillLoc>=bmpsize.Width || 
            !CheckPixel((byte*)ptr,startcolor) ||  
            (PixelsChecked[RFillLoc,y]))
                //exit loop if we're at edge of bitmap or color area

                break;
        
    }
    RFillLoc--;
    
    
    //START THE LOOP UPWARDS AND DOWNWARDS            

    ptr=(int*)(scan0+CoordsToIndex(LFillLoc,y,stride));
    for(int i=LFillLoc;i<=RFillLoc;i++)
    {
      //START LOOP UPWARDS

      //if we're not above the top of the bitmap 

      //and the pixel above this one is within the color tolerance

      if(y>0 && 
       CheckPixel((byte*)(scan0+CoordsToIndex(i,y-1,stride)),startcolor) && 
       (!(PixelsChecked[i,y-1])))
           LinearFloodFill4(scan0, i,y-1,bmpsize,stride,startcolor);

      //START LOOP DOWNWARDS

      if(y<(bmpsize.Height-1) && 
      CheckPixel((byte*)(scan0+CoordsToIndex(i,y+1,stride)),startcolor) && 
      (!(PixelsChecked[i,y+1])))
           LinearFloodFill4(scan0, i,y+1,bmpsize,stride,startcolor);
      ptr+=1;
    }
        
}

///<SUMMARY>Sees if a pixel is within the color tolerance range.</SUMMARY>

//px - a pointer to the pixel to check

//startcolor - a pointer to the color of the pixel we started at

unsafe bool CheckPixel(byte* px, byte* startcolor)
{
    bool ret=true;
    for(byte i=0;i<3;i++)
            ret&= (px[i]>= (startcolor[i]-m_Tolerance[i])) &&
                    px[i] <= (startcolor[i]+m_Tolerance[i]);            
    return ret;
}

Undoubtedly there will be optimizations that I did not think of, and you are more than welcome to mention any that you find.

History

• 10/05/03 - Posted the article