Recent changes to Cheat Sheet

Cheat Sheet modified by EyreFree

EyreFree — Mon, 07 Jun 2021 13:37:50 -0000

--- v4
+++ v5
@@ -9,62 +9,62 @@

 #### 2. Recognition

-Get QR Codes from CGImage, maybe there are several codes in a image, so it will return an array:
+A String Array is returned as there might be several QR Codes in a single `CGImage`:

     :::swift
-    if let testImage = UIImage(named: "test.png")?.toCGImage() {
-        if let tryCodes = EFQRCode.recognize(image: testImage) {
-            if tryCodes.count > 0 {
-                print("There are \(tryCodes.count) codes in testImage.")
-                for (index, code) in tryCodes.enumerated() {
-                    print("The content of \(index) QR Code is: \(code).")
-                }
-            } else {
-                print("There is no QR Codes in testImage.")
+    if let testImage = UIImage(named: "test.png")?.cgImage {
+        let codes = EFQRCode.recognize(testImage)
+        if !codes.isEmpty {
+            print("There are \(codes.count) codes")
+            for (index, code) in codes.enumerated() {
+                print("The content of QR Code \(index) is \(code).")
             }
         } else {
-            print("Recognize failed, check your input image!")
+            print("There is no QR Codes in testImage.")
         }
     }

 #### 3. Generation

-Create QR Code image, quick usage:
+Create QR Code image, basic usage:
+
+|Parameter|Description|
+|-:|:-|
+|`content`|***REQUIRED***, content of QR Code|
+|`size`|Width and height of image|
+|`backgroundColor`|Background color of QRCode|
+|`foregroundColor`|Foreground color of QRCode|
+|`watermark`|Background image of QRCode|

     :::swift
-    //                    content: Content of QR Code
-    //            size (Optional): Width and height of image
-    // backgroundColor (Optional): Background color of QRCode
-    // foregroundColor (Optional): Foreground color of QRCode
-    //       watermark (Optional): Background image of QRCode
-
-    :::swift
-    if let tryImage = EFQRCode.generate(
-        content: "https://github.com/EyreFree/EFQRCode",
-        watermark: UIImage(named: "WWF")?.toCGImage()
+    if let image = EFQRCode.generate(
+        for: "https://github.com/EFPrefix/EFQRCode",
+        watermark: UIImage(named: "WWF")?.cgImage
     ) {
-        print("Create QRCode image success: \(tryImage)")
+        print("Create QRCode image success \(image)")
     } else {
         print("Create QRCode image failed!")
     }

 Result: 

-
+

 #### 4. Generation from GIF

-You can create GIF QRCode with function `generateWithGIF` of class `EFQRCode`, for example:
+Use `EFQRCode.generateGIF` to create GIF QRCode.
+
+|Parameter|Description|
+|-:|:-|
+|`generator`|***REQUIRED***, an `EFQRCodeGenerator` instance with other settings|
+|`data`|***REQUIRED***, encoded input GIF|
+|`delay`|Output QRCode GIF delay, emitted means no change|
+|`loopCount`|Times looped in GIF, emitted means no change|

     :::swift
-    //                  data: Data of input GIF
-    //             generator: An object of EFQRCodeGenerator, use for setting
-    // pathToSave (Optional): Path to save the output GIF, default is temp path
-    //      delay (Optional): Output QRCode GIF delay, default is same as input GIF
-    //  loopCount (Optional): Output QRCode GIF loopCount, default is same as input GIF
-
-    :::swift
-    if let qrcodeData = EFQRCode.generateWithGIF(data: data, generator: generator) {
+    if let qrCodeData = EFQRCode.generateGIF(
+        using: generator, withWatermarkGIF: data
+    ) {
         print("Create QRCode image success.")
     } else {
         print("Create QRCode image failed!")
@@ -72,281 +72,8 @@

 You can get more information from the demo, result will like this:

-
+

-## User Guide
+#### 5. Next

-### 1. Recognition
-
-    :::swift
-    EFQRCode.recognize(image: CGImage)
-
-Or
-
-    :::swift
-    EFQRCodeRecognizer(image: CGImage).recognize()
-
-Two way before is exactly the same, because of the possibility of more than one two-dimensional code in the same iamge, so the return value is `[String]? ', if the return is nil means that the input data is incorrect or null. If the return array is empty, it means we can not recognize  any two-dimensional code at the image.
-
-### 2. Generation
-
-    :::swift
-    EFQRCode.generate(
-        content: String,
-        size: EFIntSize,
-        backgroundColor: CIColor,
-        foregroundColor: CIColor,
-        watermark: CGImage?
-    )
-
-Or
-
-    :::swift
-    let generator = EFQRCodeGenerator(content: String, size: EFIntSize)
-    generator.setContent(content: String)
-    generator.setMode(mode: EFQRCodeMode)
-    generator.setInputCorrectionLevel(inputCorrectionLevel: EFInputCorrectionLevel)
-    generator.setSize(size: EFIntSize)
-    generator.setMagnification(magnification: EFIntSize?)
-    generator.setColors(backgroundColor: CIColor, foregroundColor: CIColor)
-    generator.setIcon(icon: CGImage?, size: EFIntSize?)
-    generator.setWatermark(watermark: CGImage?, mode: EFWatermarkMode)
-    generator.setForegroundPointOffset(foregroundPointOffset: CGFloat)
-    generator.setAllowTransparent(allowTransparent: Bool)
-    generator.setPointShape(pointShape: EFPointShape)
-    generator.setBinarizationThreshold(binarizationThreshold: CGFloat)
-    
-    // Final two-dimensional code image we get
-    generator.generate()
-
-Two way before is exactly the same, the return value is `CGImage?`, if the return is nil means that there is some wrong during the generation.
-
-#### Parameters Explaination
-
-* **content: String?**
-
-Content, compulsive, capacity is limited, 1273 character most, the density of the two-dimensional lattice increases with the increase of the content. Comparison of different capacity is as follows:
-
-10 characters | 250 characters
-:-------------------------:|:-------------------------:
-![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/compareContent1.jpg)|![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/compareContent2.jpg)
-
-* **mode: EFQRCodeMode**
-
-Mode of QR Code, the definition of EFQRCodeMode:
-
-    :::swift
-    public enum EFQRCodeMode: Int {
-        case none           = 0;
-        case grayscale      = 1;
-        case binarization   = 2;
-    }
-
-none | grayscale | binarization
-:-------------------------:|:-------------------------:|:-------------------------:
-![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/mode1.jpg)|![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/mode2.jpg)|![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/mode3.jpg)
-
-* **inputCorrectionLevel: EFInputCorrectionLevel**
-
-Error-tolerant rate, optional, 4 different level, L: 7% / M 15% / Q 25% / H 30%, default is H, the definition of EFInputCorrectionLevel:
-
-    :::swift
-    // EFInputCorrectionLevel
-    public enum EFInputCorrectionLevel: Int {
-        case l = 0;     // L 7%
-        case m = 1;     // M 15%
-        case q = 2;     // Q 25%
-        case h = 3;     // H 30%
-    }
-
-Comparison of different inputCorrectionLevel:
-
-L | M | Q | H
-:-------------------------:|:-------------------------:|:-------------------------:|:-------------------------:
-![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/compareInputCorrectionLevel1.jpg)|![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/compareInputCorrectionLevel2.jpg)|![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/compareInputCorrectionLevel3.jpg)|![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/compareInputCorrectionLevel4.jpg)
-
-* **size: EFIntSize**
-
-Two-dimensional code length, optional, default is 256 (PS: if magnification is not nil, size will be ignored), the definition of EFIntSize:
-
-    :::swift
-    public class EFIntSize {
-        public private(set) var width: Int = 0
-        public private(set) var height: Int = 0
-    
-        public init(width: Int, height: Int) {
-            self.width = width
-            self.height = height
-        }
-    
-        public func toCGSize() -> CGSize {
-            return CGSize(width: self.width, height: self.height)
-        }
-    
-        public func widthCGFloat() -> CGFloat {
-            return CGFloat(width)
-        }
-    
-        public func heightCGFloat() -> CGFloat {
-            return CGFloat(height)
-        }
-    }
-
-234*234 | 312*234
-:-------------------------:|:-------------------------:
-![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/size1.jpg)|![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/size2.jpg)
-
-* **magnification: EFIntSize?**
-
-Magnification, optional, default is nil.
-
-Because by the existence of size scaling two-dimensional code clarity is not high, if you want to get a more clear two-dimensional code, you can use magnification to set the size of the final generation of two-dimensional code. Here is the smallest ratio relative to the two-dimensional code matrix is concerned, if there is a wanted size but I hope to have a clear and size and have size approximation of the two-dimensional code by using magnification, through `maxMagnificationLessThanOrEqualTo (size: CGFloat), and `minMagnificationGreaterThanOrEqualTo (size: CGFloat), want to get magnification these two functions the specific value, the use of specific methods are as follows:
-
-    :::swift
-    let generator = EFQRCodeGenerator(
-        content: String,
-        inputCorrectionLevel: EFInputCorrectionLevel,
-        size: EFIntSize,
-        magnification: EFIntSize?,
-        backgroundColor: CIColor,
-        foregroundColor: CIColor
-    )
-    
-    // Want to get max magnification when size is less than or equalTo 600
-    if let magnification = generator.maxMagnificationLessThanOrEqualTo(size: 600) {
-        generator.magnification = EFIntSize(width: magnification, height: magnification)
-    }
-    
-    // Or
-    
-    // Want to get min magnification when width is greater than or equalTo 600 and height is greater than or equalTo 800
-    // if let magnificationWidth = generator.minMagnificationGreaterThanOrEqualTo(size: 600),
-    //     let magnificationHeight = generator.minMagnificationGreaterThanOrEqualTo(size: 600) {
-    //     generator.magnification = EFIntSize(width: magnificationWidth, height: magnificationHeight)
-    // }
-    
-    // Final two-dimensional code image
-    generator.image
-
-size 300 | magnification 9
-:-------------------------:|:-------------------------:
-![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/compareMagnification1.jpg)|![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/compareMagnification2.jpg)
-
-* **backgroundColor: CIColor**
-
-BackgroundColor, optional, default is white.
-
-* **foregroundColor: CIColor**
-
-ForegroundColor, optional, color of code point, default is black.
-
-  ForegroundColor set to red | BackgroundColor set to gray  
-:-------------------------:|:-------------------------:
-![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/compareForegroundcolor.jpg)|![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/compareBackgroundcolor.jpg)
-
-* **icon: CGImage?**
-
-Icon image in the center of code image, optional, default is nil.
-
-* **iconSize: CGFloat?**
-
-Size of icon image, optional, default is 20% of size: 
-
-  Default 20% size | Set to 64  
-:-------------------------:|:-------------------------:
-![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/compareIcon.jpg)|![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/compareIconSize.jpg)
-
-* **watermark: CGImage?**
-
-Watermark image, optional, default is nil, for example: 
-
-  1 | 2  
-:-------------------------:|:-------------------------:
-![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/compareWatermark1.jpg)|![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/compareWatermark2.jpg)
-
-* **watermarkMode: EFWatermarkMode**
-
-The watermark placed in two-dimensional code position, optional, default is scaleAspectFill, refer to UIViewContentMode, you can treat the two-dimensional code as UIImageView, the definition of UIViewContentMode:
-
-    :::swift
-    // Like UIViewContentMode
-    public enum EFWatermarkMode: Int {
-        case scaleToFill        = 0;
-        case scaleAspectFit     = 1;
-        case scaleAspectFill    = 2;
-        case center             = 3;
-        case top                = 4;
-        case bottom             = 5;
-        case left               = 6;
-        case right              = 7;
-        case topLeft            = 8;
-        case topRight           = 9;
-        case bottomLeft         = 10;
-        case bottomRight        = 11;
-    }
-
-* **foregroundPointOffset: CGFloat**
-
-Foreground point offset, optional, default is 0, is not recommended to use, may make the two-dimensional code broken:
-
-0 | 0.5 
-:-------------------------:|:-------------------------:
-![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/compareForegroundPointOffset1.jpg)|![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/compareForegroundPointOffset2.jpg)
-
-* **allowTransparent: Bool**
-
-Allow watermark image transparent, optional, default is `true`:
-
-true | false
-:-------------------------:|:-------------------------:
-![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/compareAllowTransparent1.jpg)|![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/compareAllowTransparent2.jpg)
-
-* **pointShape: EFPointShape**
-
-Shape of foreground point, default is `.square`, the definition of UIViewContentMode:
-
-    :::swift
-    public enum EFPointShape: Int {
-        case square         = 0;
-        case circle         = 1;
-    }
-
-square | circle
-:-------------------------:|:-------------------------:
-![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/compareAllowTransparent1.jpg)|![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/pointShape.jpg)
-
-* **binarizationThreshold: CGFloat**
-
-Threshold for binarization (Only for mode binarization).
-
-Origin | 0.3 | 0.5 | 0.8
-:-------------------------:|:-------------------------:|:-------------------------:|:-------------------------:
-![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/binarizationThreshold0.jpg)|![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/binarizationThreshold1.jpg)|![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/binarizationThreshold2.jpg)|![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/binarizationThreshold3.jpg)
-
-### 3. Generation from GIF
-
-1. First you should get the complete data of a GIF file, type is `Data`, can not get from `UIImage` or you will only get the first frame;
-2. Then you can create GIF QRCode with function `generateWithGIF` of class `EFQRCode`, for example:
-
-    :::swift
-    //                  data: Data of input GIF
-    //             generator: An object of EFQRCodeGenerator, use for setting
-    // pathToSave (Optional): Path to save the output GIF, default is temp path
-    //      delay (Optional): Output QRCode GIF delay, default is same as input GIF
-    //  loopCount (Optional): Output QRCode GIF loopCount, default is same as input GIF
-
-The `generator` here is an object of class `EFQRCodeGenerator`, to process each frame in GIF, you can find the use of it above.
-
-    :::swift
-    if let qrcodeData = EFQRCode.generateWithGIF(data: data, generator: generator) {
-        print("Create QRCode image success.")
-    } else {
-        print("Create QRCode image failed!")
-    }
-
-You can get more information from the demo, result will like this:
-
-
-
-3. Now you can get the complete data of output QRCode GIF, next we can save it to local path / system photo library / upload to server or some other things you want to do;
-4. Emmmmmm, note that the `tempResultPath` of `EFQRcode` is the path of data of GIF of last generation.
+Learn more about advanced customizations from the [User Guide](https://github.com/EFPrefix/EFQRCode/blob/main/USERGUIDE.md).

Cheat Sheet modified by EyreFree

EyreFree — Mon, 07 Jun 2021 13:37:50 -0000

--- v3
+++ v4
@@ -51,6 +51,28 @@
 Result:

 
+
+#### 4. Generation from GIF
+
+You can create GIF QRCode with function `generateWithGIF` of class `EFQRCode`, for example:
+
+    :::swift
+    //                  data: Data of input GIF
+    //             generator: An object of EFQRCodeGenerator, use for setting
+    // pathToSave (Optional): Path to save the output GIF, default is temp path
+    //      delay (Optional): Output QRCode GIF delay, default is same as input GIF
+    //  loopCount (Optional): Output QRCode GIF loopCount, default is same as input GIF
+
+    :::swift
+    if let qrcodeData = EFQRCode.generateWithGIF(data: data, generator: generator) {
+        print("Create QRCode image success.")
+    } else {
+        print("Create QRCode image failed!")
+    }
+
+You can get more information from the demo, result will like this:
+
+

 ## User Guide

@@ -300,3 +322,31 @@
 Origin | 0.3 | 0.5 | 0.8
 :-------------------------:|:-------------------------:|:-------------------------:|:-------------------------:
 ![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/binarizationThreshold0.jpg)|![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/binarizationThreshold1.jpg)|![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/binarizationThreshold2.jpg)|![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/binarizationThreshold3.jpg)
+
+### 3. Generation from GIF
+
+1. First you should get the complete data of a GIF file, type is `Data`, can not get from `UIImage` or you will only get the first frame;
+2. Then you can create GIF QRCode with function `generateWithGIF` of class `EFQRCode`, for example:
+
+    :::swift
+    //                  data: Data of input GIF
+    //             generator: An object of EFQRCodeGenerator, use for setting
+    // pathToSave (Optional): Path to save the output GIF, default is temp path
+    //      delay (Optional): Output QRCode GIF delay, default is same as input GIF
+    //  loopCount (Optional): Output QRCode GIF loopCount, default is same as input GIF
+
+The `generator` here is an object of class `EFQRCodeGenerator`, to process each frame in GIF, you can find the use of it above.
+
+    :::swift
+    if let qrcodeData = EFQRCode.generateWithGIF(data: data, generator: generator) {
+        print("Create QRCode image success.")
+    } else {
+        print("Create QRCode image failed!")
+    }
+
+You can get more information from the demo, result will like this:
+
+
+
+3. Now you can get the complete data of output QRCode GIF, next we can save it to local path / system photo library / upload to server or some other things you want to do;
+4. Emmmmmm, note that the `tempResultPath` of `EFQRcode` is the path of data of GIF of last generation.

Cheat Sheet modified by EyreFree

EyreFree — Mon, 07 Jun 2021 13:37:50 -0000

--- v2
+++ v3
@@ -1,4 +1,4 @@
-## Fast Start
+## Quick Start

 #### 1. Import EFQRCode

@@ -32,27 +32,16 @@
 Create QR Code image, quick usage:

     :::swift
-    // Common parameters:
-    //                         content: Content of QR Code
-    // inputCorrectionLevel (Optional): error-tolerant rate
-    //                                  L 7%
-    //                                  M 15%
-    //                                  Q 25%
-    //                                  H 30%(Default)
-    //                 size (Optional): Width and height of image
-    //        magnification (Optional): Magnification of QRCode compare with the minimum size
-    //                                  (Parameter size will be ignored if magnification is not nil)
-    //      backgroundColor (Optional): Background color of QRCode
-    //      foregroundColor (Optional): Foreground color of QRCode
-    //                 icon (Optional): Icon in the middle of QR Code Image and it's setting
-    //            watermark (Optional): Watermark background image and it's setting
-    //                extra (Optional): Extra parameters
+    //                    content: Content of QR Code
+    //            size (Optional): Width and height of image
+    // backgroundColor (Optional): Background color of QRCode
+    // foregroundColor (Optional): Foreground color of QRCode
+    //       watermark (Optional): Background image of QRCode

     :::swift
     if let tryImage = EFQRCode.generate(
         content: "https://github.com/EyreFree/EFQRCode",
-        magnification: EFIntSize(width: 9, height: 9),
-        watermark: EFWatermark(image: UIImage(named: "WWF")?.toCGImage(), mode: .scaleAspectFill, isColorful: false)
+        watermark: UIImage(named: "WWF")?.toCGImage()
     ) {
         print("Create QRCode image success: \(tryImage)")
     } else {
@@ -73,7 +62,7 @@
 Or

     :::swift
-    EFQRCodeRecognizer(image: CGImage).contents
+    EFQRCodeRecognizer(image: CGImage).recognize()

 Two way before is exactly the same, because of the possibility of more than one two-dimensional code in the same iamge, so the return value is `[String]? ', if the return is nil means that the input data is incorrect or null. If the return array is empty, it means we can not recognize  any two-dimensional code at the image.

@@ -82,17 +71,114 @@
     :::swift
     EFQRCode.generate(
         content: String,
-        inputCorrectionLevel: EFInputCorrectionLevel,
         size: EFIntSize,
-        magnification: EFIntSize?,
         backgroundColor: CIColor,
         foregroundColor: CIColor,
-        icon: EFIcon?,
-        watermark: EFWatermark?,
-        extra: EFExtra?
+        watermark: CGImage?
     )

 Or
+
+    :::swift
+    let generator = EFQRCodeGenerator(content: String, size: EFIntSize)
+    generator.setContent(content: String)
+    generator.setMode(mode: EFQRCodeMode)
+    generator.setInputCorrectionLevel(inputCorrectionLevel: EFInputCorrectionLevel)
+    generator.setSize(size: EFIntSize)
+    generator.setMagnification(magnification: EFIntSize?)
+    generator.setColors(backgroundColor: CIColor, foregroundColor: CIColor)
+    generator.setIcon(icon: CGImage?, size: EFIntSize?)
+    generator.setWatermark(watermark: CGImage?, mode: EFWatermarkMode)
+    generator.setForegroundPointOffset(foregroundPointOffset: CGFloat)
+    generator.setAllowTransparent(allowTransparent: Bool)
+    generator.setPointShape(pointShape: EFPointShape)
+    generator.setBinarizationThreshold(binarizationThreshold: CGFloat)
+    
+    // Final two-dimensional code image we get
+    generator.generate()
+
+Two way before is exactly the same, the return value is `CGImage?`, if the return is nil means that there is some wrong during the generation.
+
+#### Parameters Explaination
+
+* **content: String?**
+
+Content, compulsive, capacity is limited, 1273 character most, the density of the two-dimensional lattice increases with the increase of the content. Comparison of different capacity is as follows:
+
+10 characters | 250 characters
+:-------------------------:|:-------------------------:
+![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/compareContent1.jpg)|![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/compareContent2.jpg)
+
+* **mode: EFQRCodeMode**
+
+Mode of QR Code, the definition of EFQRCodeMode:
+
+    :::swift
+    public enum EFQRCodeMode: Int {
+        case none           = 0;
+        case grayscale      = 1;
+        case binarization   = 2;
+    }
+
+none | grayscale | binarization
+:-------------------------:|:-------------------------:|:-------------------------:
+![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/mode1.jpg)|![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/mode2.jpg)|![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/mode3.jpg)
+
+* **inputCorrectionLevel: EFInputCorrectionLevel**
+
+Error-tolerant rate, optional, 4 different level, L: 7% / M 15% / Q 25% / H 30%, default is H, the definition of EFInputCorrectionLevel:
+
+    :::swift
+    // EFInputCorrectionLevel
+    public enum EFInputCorrectionLevel: Int {
+        case l = 0;     // L 7%
+        case m = 1;     // M 15%
+        case q = 2;     // Q 25%
+        case h = 3;     // H 30%
+    }
+
+Comparison of different inputCorrectionLevel:
+
+L | M | Q | H
+:-------------------------:|:-------------------------:|:-------------------------:|:-------------------------:
+![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/compareInputCorrectionLevel1.jpg)|![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/compareInputCorrectionLevel2.jpg)|![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/compareInputCorrectionLevel3.jpg)|![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/compareInputCorrectionLevel4.jpg)
+
+* **size: EFIntSize**
+
+Two-dimensional code length, optional, default is 256 (PS: if magnification is not nil, size will be ignored), the definition of EFIntSize:
+
+    :::swift
+    public class EFIntSize {
+        public private(set) var width: Int = 0
+        public private(set) var height: Int = 0
+    
+        public init(width: Int, height: Int) {
+            self.width = width
+            self.height = height
+        }
+    
+        public func toCGSize() -> CGSize {
+            return CGSize(width: self.width, height: self.height)
+        }
+    
+        public func widthCGFloat() -> CGFloat {
+            return CGFloat(width)
+        }
+    
+        public func heightCGFloat() -> CGFloat {
+            return CGFloat(height)
+        }
+    }
+
+234*234 | 312*234
+:-------------------------:|:-------------------------:
+![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/size1.jpg)|![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/size2.jpg)
+
+* **magnification: EFIntSize?**
+
+Magnification, optional, default is nil.
+
+Because by the existence of size scaling two-dimensional code clarity is not high, if you want to get a more clear two-dimensional code, you can use magnification to set the size of the final generation of two-dimensional code. Here is the smallest ratio relative to the two-dimensional code matrix is concerned, if there is a wanted size but I hope to have a clear and size and have size approximation of the two-dimensional code by using magnification, through `maxMagnificationLessThanOrEqualTo (size: CGFloat), and `minMagnificationGreaterThanOrEqualTo (size: CGFloat), want to get magnification these two functions the specific value, the use of specific methods are as follows:

     :::swift
     let generator = EFQRCodeGenerator(
@@ -103,96 +189,6 @@
         backgroundColor: CIColor,
         foregroundColor: CIColor
     )
-    if let tryIcon = icon {
-        generator.setIcon(icon: EFIcon?)
-    }
-    if let tryWatermark = watermark {
-        generator.setWatermark(watermark: EFWatermark?)
-    }
-    if let tryExtra = extra {
-        generator.setExtra(extra: EFExtra?)
-    }
-    
-    // Final two-dimensional code image we get
-    generator.image
-
-Two way before is exactly the same, the return value is `CGImage?`, if the return is nil means that there is some wrong during the generation.
-
-#### Parameters Explaination
-
-* **content: String?**
-
-Content, compulsive, capacity is limited, 1273 character most, the density of the two-dimensional lattice increases with the increase of the content. Comparison of different capacity is as follows:
-
-10 characters | 250 characters
-:-------------------------:|:-------------------------:
-![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/compareContent1.jpg)|![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/compareContent2.jpg)
-
-* **inputCorrectionLevel: EFInputCorrectionLevel**
-
-Error-tolerant rate, optional, 4 different level, L: 7% / M 15% / Q 25% / H 30%, default is H, the definition of EFInputCorrectionLevel:
-
-    :::swift
-    // EFInputCorrectionLevel
-    public enum EFInputCorrectionLevel: Int {
-        case l = 0;     // L 7%
-        case m = 1;     // M 15%
-        case q = 2;     // Q 25%
-        case h = 3;     // H 30%
-    }
-
-Comparison of different inputCorrectionLevel:
-
-L | M | Q | H
-:-------------------------:|:-------------------------:|:-------------------------:|:-------------------------:
-![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/compareInputCorrectionLevel1.jpg)|![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/compareInputCorrectionLevel2.jpg)|![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/compareInputCorrectionLevel3.jpg)|![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/compareInputCorrectionLevel4.jpg)
-
-* **size: EFIntSize**
-
-Two-dimensional code length, optional, default is 256 (PS: if magnification is not nil, size will be ignored), the definition of EFIntSize:
-
-    :::swift
-    public class EFIntSize {
-        public private(set) var width: Int = 0
-        public private(set) var height: Int = 0
-    
-        public init(width: Int, height: Int) {
-            self.width = width
-            self.height = height
-        }
-    
-        public func toCGSize() -> CGSize {
-            return CGSize(width: self.width, height: self.height)
-        }
-    
-        public func widthCGFloat() -> CGFloat {
-            return CGFloat(width)
-        }
-    
-        public func heightCGFloat() -> CGFloat {
-            return CGFloat(height)
-        }
-    }
-
-234*234 | 312*234
-:-------------------------:|:-------------------------:
-![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/size1.jpg)|![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/size2.jpg)
-
-* **magnification: EFIntSize?**
-
-Magnification, optional, default is nil.
-
-Because by the existence of size scaling two-dimensional code clarity is not high, if you want to get a more clear two-dimensional code, you can use magnification to set the size of the final generation of two-dimensional code. Here is the smallest ratio relative to the two-dimensional code matrix is concerned, if there is a wanted size but I hope to have a clear and size and have size approximation of the two-dimensional code by using magnification, through `maxMagnificationLessThanOrEqualTo (size: CGFloat), and `minMagnificationGreaterThanOrEqualTo (size: CGFloat), want to get magnification these two functions the specific value, the use of specific methods are as follows:
-
-    :::swift
-    let generator = EFQRCodeGenerator(
-        content: String,
-        inputCorrectionLevel: EFInputCorrectionLevel,
-        size: EFIntSize,
-        magnification: EFIntSize?,
-        backgroundColor: CIColor,
-        foregroundColor: CIColor
-    )

     // Want to get max magnification when size is less than or equalTo 600
     if let magnification = generator.maxMagnificationLessThanOrEqualTo(size: 600) {
@@ -237,10 +233,6 @@
   Default 20% size | Set to 64  
 :-------------------------:|:-------------------------:
 ![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/compareIcon.jpg)|![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/compareIconSize.jpg)
-
-* **isIconColorful: Bool**
-
-Is icon colorful, optional, default is `true`.

 * **watermark: CGImage?**

@@ -271,10 +263,6 @@
         case bottomRight        = 11;
     }

-* **isWatermarkColorful: Bool**
-
-Is watermark colorful, optional, default is `true`.
-
 * **foregroundPointOffset: CGFloat**

 Foreground point offset, optional, default is 0, is not recommended to use, may make the two-dimensional code broken:
@@ -291,47 +279,24 @@
 :-------------------------:|:-------------------------:
 ![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/compareAllowTransparent1.jpg)|![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/compareAllowTransparent2.jpg)

-* Other
-
-EFIcon is consist of icon, iconSize and isIconColorful, the definition is:
-
-    :::swift
-    public struct EFIcon {
-        public var image: CGImage?
-        public var size: EFIntSize?
-        public var isColorful: Bool = true
-    
-        public init(image: CGImage?, size: EFIntSize?, isColorful: Bool = true) {
-            self.image = image
-            self.size = size
-            self.isColorful = isColorful
-        }
-    }
-
-EFWatermark is consist of watermark, watermarkMode and isWatermarkColorful, the definition is:
-
-    :::swift
-    public struct EFWatermark {
-        public var image: CGImage?
-        public var mode: EFWatermarkMode = .scaleToFill
-        public var isColorful: Bool = true
-    
-        public init(image: CGImage?, mode: EFWatermarkMode = .scaleToFill, isColorful: Bool = true) {
-            self.image = image
-            self.mode = mode
-            self.isColorful = isColorful
-        }
-    }
-
-EFExtra is consist of foregroundPointOffset and allowTransparent, the definition is:
-
-    :::swift
-    public struct EFExtra {
-        public var foregroundPointOffset: CGFloat = 0
-        public var allowTransparent: Bool = true
-    
-        public init(foregroundPointOffset: CGFloat = 0, allowTransparent: Bool = true) {
-            self.foregroundPointOffset = foregroundPointOffset
-            self.allowTransparent = allowTransparent
-        }
-    }
+* **pointShape: EFPointShape**
+
+Shape of foreground point, default is `.square`, the definition of UIViewContentMode:
+
+    :::swift
+    public enum EFPointShape: Int {
+        case square         = 0;
+        case circle         = 1;
+    }
+
+square | circle
+:-------------------------:|:-------------------------:
+![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/compareAllowTransparent1.jpg)|![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/pointShape.jpg)
+
+* **binarizationThreshold: CGFloat**
+
+Threshold for binarization (Only for mode binarization).
+
+Origin | 0.3 | 0.5 | 0.8
+:-------------------------:|:-------------------------:|:-------------------------:|:-------------------------:
+![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/binarizationThreshold0.jpg)|![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/binarizationThreshold1.jpg)|![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/binarizationThreshold2.jpg)|![](https://raw.githubusercontent.com/EyreFree/EFQRCode/assets/binarizationThreshold3.jpg)

Cheat Sheet modified by EyreFree

EyreFree — Mon, 07 Jun 2021 13:37:49 -0000

--- v1
+++ v2
@@ -1,3 +1,5 @@
+## Fast Start
+
 #### 1. Import EFQRCode

 Import EFQRCode module where you want to use it:

Cheat Sheet modified by EyreFree

EyreFree — Mon, 07 Jun 2021 13:37:48 -0000

1. Import EFQRCode

Import EFQRCode module where you want to use it:

import EFQRCode

2. Recognition

Get QR Codes from CGImage, maybe there are several codes in a image, so it will return an array:

if let testImage = UIImage(named: "test.png")?.toCGImage() {
    if let tryCodes = EFQRCode.recognize(image: testImage) {
        if tryCodes.count > 0 {
            print("There are \(tryCodes.count) codes in testImage.")
            for (index, code) in tryCodes.enumerated() {
                print("The content of \(index) QR Code is: \(code).")
            }
        } else {
            print("There is no QR Codes in testImage.")
        }
    } else {
        print("Recognize failed, check your input image!")
    }
}

3. Generation

Create QR Code image, quick usage:

// Common parameters:
//                         content: Content of QR Code
// inputCorrectionLevel (Optional): error-tolerant rate
//                                  L 7%
//                                  M 15%
//                                  Q 25%
//                                  H 30%(Default)
//                 size (Optional): Width and height of image
//        magnification (Optional): Magnification of QRCode compare with the minimum size
//                                  (Parameter size will be ignored if magnification is not nil)
//      backgroundColor (Optional): Background color of QRCode
//      foregroundColor (Optional): Foreground color of QRCode
//                 icon (Optional): Icon in the middle of QR Code Image and it's setting
//            watermark (Optional): Watermark background image and it's setting
//                extra (Optional): Extra parameters

:::swift
if let tryImage = EFQRCode.generate(
    content: "https://github.com/EyreFree/EFQRCode",
    magnification: EFIntSize(width: 9, height: 9),
    watermark: EFWatermark(image: UIImage(named: "WWF")?.toCGImage(), mode: .scaleAspectFill, isColorful: false)
) {
    print("Create QRCode image success: \(tryImage)")
} else {
    print("Create QRCode image failed!")
}

Result:

User Guide

1. Recognition

EFQRCode.recognize(image: CGImage)

EFQRCodeRecognizer(image: CGImage).contents

Two way before is exactly the same, because of the possibility of more than one two-dimensional code in the same iamge, so the return value is `[String]? ', if the return is nil means that the input data is incorrect or null. If the return array is empty, it means we can not recognize any two-dimensional code at the image.

2. Generation

EFQRCode.generate(
    content: String,
    inputCorrectionLevel: EFInputCorrectionLevel,
    size: EFIntSize,
    magnification: EFIntSize?,
    backgroundColor: CIColor,
    foregroundColor: CIColor,
    icon: EFIcon?,
    watermark: EFWatermark?,
    extra: EFExtra?
)

let generator = EFQRCodeGenerator(
    content: String,
    inputCorrectionLevel: EFInputCorrectionLevel,
    size: EFIntSize,
    magnification: EFIntSize?,
    backgroundColor: CIColor,
    foregroundColor: CIColor
)
if let tryIcon = icon {
    generator.setIcon(icon: EFIcon?)
}
if let tryWatermark = watermark {
    generator.setWatermark(watermark: EFWatermark?)
}
if let tryExtra = extra {
    generator.setExtra(extra: EFExtra?)
}

// Final two-dimensional code image we get
generator.image

Two way before is exactly the same, the return value is CGImage?, if the return is nil means that there is some wrong during the generation.

Parameters Explaination

content: String?

Content, compulsive, capacity is limited, 1273 character most, the density of the two-dimensional lattice increases with the increase of the content. Comparison of different capacity is as follows:

10 characters	250 characters

inputCorrectionLevel: EFInputCorrectionLevel

Error-tolerant rate, optional, 4 different level, L: 7% / M 15% / Q 25% / H 30%, default is H, the definition of EFInputCorrectionLevel:

// EFInputCorrectionLevel
public enum EFInputCorrectionLevel: Int {
    case l = 0;     // L 7%
    case m = 1;     // M 15%
    case q = 2;     // Q 25%
    case h = 3;     // H 30%
}

Comparison of different inputCorrectionLevel:

L	M	Q	H

size: EFIntSize

Two-dimensional code length, optional, default is 256 (PS: if magnification is not nil, size will be ignored), the definition of EFIntSize:

public class EFIntSize {
    public private(set) var width: Int = 0
    public private(set) var height: Int = 0

    public init(width: Int, height: Int) {
        self.width = width
        self.height = height
    }

    public func toCGSize() -> CGSize {
        return CGSize(width: self.width, height: self.height)
    }

    public func widthCGFloat() -> CGFloat {
        return CGFloat(width)
    }

    public func heightCGFloat() -> CGFloat {
        return CGFloat(height)
    }
}

234*234	312*234

magnification: EFIntSize?

Magnification, optional, default is nil.

Because by the existence of size scaling two-dimensional code clarity is not high, if you want to get a more clear two-dimensional code, you can use magnification to set the size of the final generation of two-dimensional code. Here is the smallest ratio relative to the two-dimensional code matrix is concerned, if there is a wanted size but I hope to have a clear and size and have size approximation of the two-dimensional code by using magnification, through maxMagnificationLessThanOrEqualTo (size: CGFloat), andminMagnificationGreaterThanOrEqualTo (size: CGFloat), want to get magnification these two functions the specific value, the use of specific methods are as follows:

let generator = EFQRCodeGenerator(
    content: String,
    inputCorrectionLevel: EFInputCorrectionLevel,
    size: EFIntSize,
    magnification: EFIntSize?,
    backgroundColor: CIColor,
    foregroundColor: CIColor
)

// Want to get max magnification when size is less than or equalTo 600
if let magnification = generator.maxMagnificationLessThanOrEqualTo(size: 600) {
    generator.magnification = EFIntSize(width: magnification, height: magnification)
}

// Or

// Want to get min magnification when width is greater than or equalTo 600 and height is greater than or equalTo 800
// if let magnificationWidth = generator.minMagnificationGreaterThanOrEqualTo(size: 600),
//     let magnificationHeight = generator.minMagnificationGreaterThanOrEqualTo(size: 600) {
//     generator.magnification = EFIntSize(width: magnificationWidth, height: magnificationHeight)
// }

// Final two-dimensional code image
generator.image

size 300	magnification 9

backgroundColor: CIColor

BackgroundColor, optional, default is white.

foregroundColor: CIColor

ForegroundColor, optional, color of code point, default is black.

ForegroundColor set to red	BackgroundColor set to gray

icon: CGImage?

Icon image in the center of code image, optional, default is nil.

iconSize: CGFloat?

Size of icon image, optional, default is 20% of size:

Default 20% size	Set to 64

isIconColorful: Bool

Is icon colorful, optional, default is true.

watermark: CGImage?

Watermark image, optional, default is nil, for example:

1	2

watermarkMode: EFWatermarkMode

The watermark placed in two-dimensional code position, optional, default is scaleAspectFill, refer to UIViewContentMode, you can treat the two-dimensional code as UIImageView, the definition of UIViewContentMode:

// Like UIViewContentMode
public enum EFWatermarkMode: Int {
    case scaleToFill        = 0;
    case scaleAspectFit     = 1;
    case scaleAspectFill    = 2;
    case center             = 3;
    case top                = 4;
    case bottom             = 5;
    case left               = 6;
    case right              = 7;
    case topLeft            = 8;
    case topRight           = 9;
    case bottomLeft         = 10;
    case bottomRight        = 11;
}

isWatermarkColorful: Bool

Is watermark colorful, optional, default is true.

foregroundPointOffset: CGFloat

Foreground point offset, optional, default is 0, is not recommended to use, may make the two-dimensional code broken:

0	0.5

allowTransparent: Bool

Allow watermark image transparent, optional, default is true:

true	false

Other

EFIcon is consist of icon, iconSize and isIconColorful, the definition is:

public struct EFIcon {
    public var image: CGImage?
    public var size: EFIntSize?
    public var isColorful: Bool = true

    public init(image: CGImage?, size: EFIntSize?, isColorful: Bool = true) {
        self.image = image
        self.size = size
        self.isColorful = isColorful
    }
}

EFWatermark is consist of watermark, watermarkMode and isWatermarkColorful, the definition is:

public struct EFWatermark {
    public var image: CGImage?
    public var mode: EFWatermarkMode = .scaleToFill
    public var isColorful: Bool = true

    public init(image: CGImage?, mode: EFWatermarkMode = .scaleToFill, isColorful: Bool = true) {
        self.image = image
        self.mode = mode
        self.isColorful = isColorful
    }
}

EFExtra is consist of foregroundPointOffset and allowTransparent, the definition is:

public struct EFExtra {
    public var foregroundPointOffset: CGFloat = 0
    public var allowTransparent: Bool = true

    public init(foregroundPointOffset: CGFloat = 0, allowTransparent: Bool = true) {
        self.foregroundPointOffset = foregroundPointOffset
        self.allowTransparent = allowTransparent
    }
}