Added bacjkgroundImageStyle and fixed test cases

Author: codebude

QRCoder/ArtQRCode.cs

@@ -53,10 +53,12 @@ public Bitmap GetGraphic(Bitmap backgroundImage = null)
         /// <param name="pixelSizeFactor">Value between 0.0 to 1.0 that defines how big the module dots are. The bigger the value, the less round the dots will be.</param>
         /// <param name="drawQuietZones">If true a white border is drawn around the whole QR Code</param>
         /// <param name="quietZoneRenderingStyle">Style of the quiet zones</param>
+        /// <param name="backgroundImageStyle">Style of the background image (if set). Fill=spanning complete graphic; DataAreaOnly=Don't paint background into quietzone</param>
         /// <param name="finderPatternImage">Optional image that should be used instead of the default finder patterns</param>
         /// <returns>QRCode graphic as bitmap</returns>
         public Bitmap GetGraphic(int pixelsPerModule, Color darkColor, Color lightColor, Color backgroundColor, Bitmap backgroundImage = null, double pixelSizeFactor = 0.8, 
-                                 bool drawQuietZones = true, QuietZoneStyle quietZoneRenderingStyle = QuietZoneStyle.Flat, Bitmap finderPatternImage = null)
+                                 bool drawQuietZones = true, QuietZoneStyle quietZoneRenderingStyle = QuietZoneStyle.Dotted, 
+                                 BackgroundImageStyle backgroundImageStyle = BackgroundImageStyle.DataAreaOnly, Bitmap finderPatternImage = null)
         {
             if (pixelSizeFactor > 1)
                 throw new Exception("The parameter pixelSize must be between 0 and 1. (0-100%)");
@@ -79,7 +81,16 @@ public Bitmap GetGraphic(int pixelsPerModule, Color darkColor, Color lightColor,
                             graphics.FillRectangle(brush, new Rectangle(0, 0, size, size));
                         //Render background if set
                         if (backgroundImage != null)
-                            graphics.DrawImage(Resize(backgroundImage, size), 0, 0);
+                        {
+                            if (backgroundImageStyle == BackgroundImageStyle.Fill)
+                                graphics.DrawImage(Resize(backgroundImage, size), 0, 0);
+                            else if (backgroundImageStyle == BackgroundImageStyle.DataAreaOnly)
+                            {
+                                var bgOffset = 4 - offset;
+                                graphics.DrawImage(Resize(backgroundImage, size - (2 * bgOffset * pixelsPerModule)), 0 + (bgOffset * pixelsPerModule), (bgOffset * pixelsPerModule));
+                            }
+                        }
+                            
 
                         var darkModulePixel = MakeDotPixel(pixelsPerModule, pixelSize, darkBrush);
                         var lightModulePixel = MakeDotPixel(pixelsPerModule, pixelSize, lightBrush);
@@ -232,6 +243,15 @@ public enum QuietZoneStyle
             Dotted,
             Flat
         }
+
+        /// <summary>
+        /// Defines how the background image (if set) shall be rendered.
+        /// </summary>
+        public enum BackgroundImageStyle
+        {
+            Fill,
+            DataAreaOnly
+        }
     }
 
     public static class ArtQRCodeHelper
@@ -253,16 +273,18 @@ public static class ArtQRCodeHelper
         /// <param name="pixelSizeFactor">Value between 0.0 to 1.0 that defines how big the module dots are. The bigger the value, the less round the dots will be.</param>
         /// <param name="drawQuietZones">If true a white border is drawn around the whole QR Code</param>
         /// <param name="quietZoneRenderingStyle">Style of the quiet zones</param>
+        /// <param name="backgroundImageStyle">Style of the background image (if set). Fill=spanning complete graphic; DataAreaOnly=Don't paint background into quietzone</param>
         /// <param name="finderPatternImage">Optional image that should be used instead of the default finder patterns</param>
         /// <returns>QRCode graphic as bitmap</returns>
         public static Bitmap GetQRCode(string plainText, int pixelsPerModule, Color darkColor, Color lightColor, Color backgroundColor, ECCLevel eccLevel, bool forceUtf8 = false, 
                                        bool utf8BOM = false, EciMode eciMode = EciMode.Default, int requestedVersion = -1, Bitmap backgroundImage = null, double pixelSizeFactor = 0.8,
-                                       bool drawQuietZones = true, QuietZoneStyle quietZoneRenderingStyle = QuietZoneStyle.Flat, Bitmap finderPatternImage = null)
+                                       bool drawQuietZones = true, QuietZoneStyle quietZoneRenderingStyle = QuietZoneStyle.Flat, 
+                                       BackgroundImageStyle backgroundImageStyle = BackgroundImageStyle.DataAreaOnly, Bitmap finderPatternImage = null)
         {
             using (var qrGenerator = new QRCodeGenerator())
             using (var qrCodeData = qrGenerator.CreateQrCode(plainText, eccLevel, forceUtf8, utf8BOM, eciMode, requestedVersion))
             using (var qrCode = new ArtQRCode(qrCodeData))
-                return qrCode.GetGraphic(pixelsPerModule, darkColor, lightColor, backgroundColor, backgroundImage, pixelSizeFactor, drawQuietZones, quietZoneRenderingStyle, finderPatternImage);
+                return qrCode.GetGraphic(pixelsPerModule, darkColor, lightColor, backgroundColor, backgroundImage, pixelSizeFactor, drawQuietZones, quietZoneRenderingStyle, backgroundImageStyle, finderPatternImage);
         }
     }
 }

QRCoderTests/ArtQRCodeRendererTests.cs

@@ -24,9 +24,9 @@ public void can_create_standard_qrcode_graphic()
 
             var result = HelperFunctions.BitmapToHash(bmp);
 #if NET35_OR_GREATER || NET40_OR_GREATER
-            result.ShouldBe("ea1a9008dbfe7825a6e17ed228a83a6f");
+            result.ShouldBe("11ebdda91b9632d016798cb6de2f5339");
 #else
-            result.ShouldBe("9e18d03a3f2a4ca0fb603350f9764d6d");
+            result.ShouldBe("cb38c3156eaf13cdfba699bdafc3a84c");
 #endif
         }
 
@@ -41,9 +41,9 @@ public void can_create_standard_qrcode_graphic_with_custom_finder()
 
             var result = HelperFunctions.BitmapToHash(bmp);
 #if NET35_OR_GREATER || NET40_OR_GREATER
-            result.ShouldBe("a6895846ed6b56de997bfcb2c4a72736");
+            result.ShouldBe("c54a7389ae995abc838f0d228acc3bad");
 #else
-            result.ShouldBe("8185b055473b170afa56152ec46c4be4");
+            result.ShouldBe("1102c0c6f235eaf4c3ac639f82f17bfa");
 #endif
         }
 
@@ -75,9 +75,9 @@ public void can_create_standard_qrcode_graphic_with_background()
             var result = HelperFunctions.BitmapToHash(bmp);
 
 #if NET35_OR_GREATER || NET40_OR_GREATER
-            result.ShouldBe("9f4f860d0c15ed4b1258dbbea89c4b4b");
+            result.ShouldBe("2caa9c0ee8fcb4a93841debb58cf41bc");
 #else
-            result.ShouldBe("16f3ad423cc0690cc2e259d3731400cd");
+            result.ShouldBe("bbea08507282773175cfe7b52f0ddae4");
 #endif
         }