EFQRCode

https://efprefix.github.io/EFQRCode/
Admin
EFQRCode is a lightweight, pure-Swift library for generating stylized QR codes with watermarks or...
Tokens:39,879
Snippets:531
Trust Score:9.7
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install EFQRCode with CocoaPods

Source: https://efprefix.github.io/EFQRCode/index.html

Add EFQRCode to your Podfile and run 'pod install' to integrate it into your project.

```bash
pod 'EFQRCode', '~> 7.0.3'
```

```bash
$ pod install
```

--------------------------------

### Initialize 2.5D Style

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyle25DParams.html

Example of configuring parameters and applying them to an EFQRCodeStyle.

```Swift
 let params = EFStyle25DParams(
     icon: icon,
     backdrop: backdrop,
     dataHeight: 1.0,
     positionHeight: 1.0,
     topColor: .black,
     leftColor: .darkGray,
     rightColor: .lightGray
 )

 let style = EFQRCodeStyle.style25D(params)
```

--------------------------------

### Initialize EFQRCodeStyleDSJ

Source: https://efprefix.github.io/EFQRCode/Classes/EFQRCodeStyleDSJ.html

Example of configuring parameters and initializing the style object.

```Swift
 let params = EFStyleDSJParams(
     position: position,
     data: dataParams
 )

 let style = EFQRCodeStyleDSJ(params: params)
```

--------------------------------

### Initialize DSJ Style Parameters

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleDSJParams.html

Example showing how to configure data parameters and initialize the DSJ style for a QR code.

```Swift
 let dataParams = EFStyleDSJParamsData(
     lineSize: 0.7,
     xSize: 0.7,
     horizontalLineColor: .yellow,
     verticalLineColor: .red,
     xColor: .blue
 )

 let params = EFStyleDSJParams(
     icon: icon,
     backdrop: backdrop,
     position: position,
     data: dataParams
 )

 let style = EFQRCodeStyle.dsj(params)
```

--------------------------------

### Initialize Bubble Style QR Code

Source: https://efprefix.github.io/EFQRCode/Classes/EFQRCodeStyleBubble.html

Example showing how to configure parameters and instantiate the bubble style.

```Swift
 let params = EFStyleBubbleParams(
     dataColor: .blue,
     dataCenterColor: .white,
     position: position
 )

 let style = EFQRCodeStyleBubble(params: params)
```

--------------------------------

### Initialize EFStyleImageParamsData

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleImageParamsData.html

Example of creating an instance of the styling parameters.

```Swift
 let data = EFStyleImageParamsData(
     style: .rectangle,
     scale: 1.0,
     colorDark: .black,
     colorLight: .white
 )
```

--------------------------------

### Initialize resample image QR code style

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleResampleImageParams.html

Example showing how to configure image parameters and apply them to a QR code style.

```Swift
 let imageParams = EFStyleResampleImageParamsImage(
     image: myImage,
     mode: .scaleAspectFill
 )

 let params = EFStyleResampleImageParams(
     icon: icon,
     backdrop: backdrop,
     image: imageParams,
     align: align,
     timing: timing,
     position: position,
     dataColor: .black
 )

 let style = EFQRCodeStyle.resampleImage(params)
```

--------------------------------

### Basic QR Code Generation Example

Source: https://efprefix.github.io/EFQRCode/Classes/EFQRCode/Generator.html

Demonstrates the basic usage of the EFQRCode Generator to create a QR code from text and generate an image and PNG data.

```swift
// Create a generator with text
 let generator = try EFQRCode.Generator("Hello World")

 // Generate an image
 let image = try generator.toImage(width: 200)

 // Generate PNG data
 let pngData = try generator.toPNGData(width: 200)
```

--------------------------------

### Initialize EFStyleImageParamsTiming

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleImageParamsTiming.html

Example of creating an instance of the timing parameters.

```Swift
 let timing = EFStyleImageParamsTiming(
     style: .rectangle,
     size: 1.0,
     colorDark: .black,
     colorLight: .white
 )
```

--------------------------------

### Usage Example for EFStyleImageParams

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleImageParams.html

Demonstrates how to create and apply image-based QR code styling parameters. This involves configuring image parameters and then passing them to the main EFStyleImageParams initializer.

```swift
 let imageParams = EFStyleImageParamsImage(
     image: myImage,
     mode: .scaleAspectFill
 )

 let params = EFStyleImageParams(
     icon: icon,
     backdrop: backdrop,
     align: align,
     timing: timing,
     position: position,
     data: data,
     image: imageParams
 )

 let style = EFQRCodeStyle.image(params)
```

--------------------------------

### Initialize EFQRCodeStyleRandomRectangle

Source: https://efprefix.github.io/EFQRCode/Classes.html

Usage example for initializing the random rectangle QR code renderer.

```Swift
 let params = EFStyleRandomRectangleParams(
     color: .green
 )

 let style = EFQRCodeStyleRandomRectangle(params: params)
```

--------------------------------

### Configure EFStyleParamIcon

Source: https://efprefix.github.io/EFQRCode/Enums/EFImageMode.html

Example of using EFImageMode within an EFStyleParamIcon configuration.

```Swift
 let icon = EFStyleParamIcon(
     image: .static(myImage),
     mode: .scaleAspectFill,  // Use aspect fill mode
     alpha: 1.0,
     borderColor: .black,
     percentage: 0.2
 )
```

--------------------------------

### Initialize QR Code with Error Correction

Source: https://efprefix.github.io/EFQRCode/Enums/EFCorrectionLevel.html

Example of setting the error correction level during QR code generation.

```Swift
 // Create a QR code with high error correction
 let generator = try EFQRCode.Generator(
     "Hello World",
     errorCorrectLevel: .h,
     style: .basic()
 )
```

--------------------------------

### Configure and Apply Random Rectangle Style

Source: https://efprefix.github.io/EFQRCode/Classes.html

Usage example for configuring random rectangle parameters and applying them to a QR code style.

```Swift
 let params = EFStyleRandomRectangleParams(
     icon: icon,
     backdrop: backdrop,
     color: .green
 )

 let style = EFQRCodeStyle.randomRectangle(params)
```

--------------------------------

### Create and Use QR Code Recognizer

Source: https://efprefix.github.io/EFQRCode/Classes/EFQRCode/Recognizer.html

Instantiate the Recognizer with an image and then call recognize() to get QR code contents. Check if the returned array is empty to determine if any QR codes were found.

```swift
// Create a recognizer with an image
 let recognizer = EFQRCode.Recognizer(image: qrCodeImage)

 // Recognize QR code content
 let contents = recognizer.recognize()

 // Check if any QR codes were found
 if !contents.isEmpty {
     print("Found QR code: \(contents[0])")
 }

```

--------------------------------

### Initialize EFQRCode Class

Source: https://efprefix.github.io/EFQRCode/Classes/EFQRCode.html

The main entry point for the library.

```Swift
public class EFQRCode
```

--------------------------------

### Constructor: init(icon:backdrop:image:align:timing:position:dataColor:)

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleResampleImageParams.html

Initializes a new instance of EFStyleResampleImageParams to define how a QR code should be styled using image resampling.

```APIDOC
## Constructor: init(icon:backdrop:image:align:timing:position:dataColor:)

### Description
Creates resample image QR code styling parameters, allowing customization of icons, backdrops, image resampling settings, and pattern configurations.

### Parameters
#### Request Body
- **icon** (EFStyleParamIcon?) - Optional - The icon to display in the center of the QR code. Defaults to nil.
- **backdrop** (EFStyleParamBackdrop) - Optional - The backdrop configuration. Defaults to defaultBackdrop.
- **image** (EFStyleResampleImageParamsImage?) - Optional - The image configuration for resampling. Defaults to nil.
- **align** (EFStyleResampleImageParamsAlign) - Optional - The alignment pattern configuration. Defaults to defaultAlign.
- **timing** (EFStyleResampleImageParamsTiming) - Optional - The timing pattern configuration. Defaults to defaultTiming.
- **position** (EFStyleResampleImageParamsPosition) - Optional - The position detection pattern configuration. Defaults to defaultPosition.
- **dataColor** (CGColor) - Optional - The fallback color for data modules. Defaults to defaultDataColor.
```

--------------------------------

### Initialize EFStyleLineParams

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleLineParams.html

Demonstrates how to configure line parameters and initialize the style object for a QR code.

```Swift
 let lineParams = EFStyleLineParamsLine(
     direction: .x,
     thickness: 0.5,
     color: .black
 )

 let params = EFStyleLineParams(
     icon: icon,
     backdrop: backdrop,
     position: position,
     line: lineParams
 )

 let style = EFQRCodeStyle.line(params)
```

--------------------------------

### Constructor: init(icon:backdrop:align:timing:position:data:image:)

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleImageParams.html

Initializes a new instance of EFStyleImageParams to define how an image-based QR code should be rendered.

```APIDOC
## Constructor: init(icon:backdrop:align:timing:position:data:image:)

### Description
Creates image-based QR code styling parameters, allowing customization of various QR code components including icons, backdrops, and module filling patterns.

### Parameters
- **icon** (EFStyleParamIcon?) - Optional - The icon to display in the center of the QR code. Defaults to nil.
- **backdrop** (EFStyleParamBackdrop) - Optional - The backdrop configuration. Defaults to defaultBackdrop.
- **align** (EFStyleImageParamsAlign) - Optional - The alignment pattern configuration. Defaults to defaultAlign.
- **timing** (EFStyleImageParamsTiming) - Optional - The timing pattern configuration. Defaults to defaultTiming.
- **position** (EFStyleImageParamsPosition) - Optional - The position detection pattern configuration. Defaults to defaultPosition.
- **data** (EFStyleImageParamsData) - Optional - The data module configuration. Defaults to defaultData.
- **image** (EFStyleImageParamsImage?) - Optional - The image configuration for module filling. Defaults to nil.
```

--------------------------------

### Initialize EFQRCodeStyle25D with Parameters

Source: https://efprefix.github.io/EFQRCode/Classes/EFQRCodeStyle25D.html

The initializer declaration for creating a 2.5D QR code style instance.

```Swift
public init(params: EFStyle25DParams)
```

--------------------------------

### EFStyleParamIcon Initialization

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleParamIcon.html

Demonstrates how to initialize EFStyleParamIcon to customize the icon in a QR code.

```APIDOC
## EFStyleParamIcon Initialization

### Description
Initializes an icon configuration for QR code customization, specifying the image, scaling mode, transparency, border color, and size relative to the QR code.

### Method
`init(image:mode:alpha:borderColor:percentage:)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```swift
let icon = EFStyleParamIcon(
    image: .static(myLogoImage),
    mode: .scaleAspectFill,
    alpha: 0.9,
    borderColor: .white,
    percentage: 0.25
)
```

### Response
None (This is an initializer, not an API endpoint)

#### Success Response (200)
None

#### Response Example
None
```

--------------------------------

### Get File Extension for Video Format

Source: https://efprefix.github.io/EFQRCode/Enums/EFVideoFormat.html

Retrieves the standard file extension for a given EFVideoFormat, useful for saving video files correctly. This property is available for all video format cases.

```swift
public var fileExtension: String { get }
```

--------------------------------

### EFStyle25DParams Initialization

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyle25DParams.html

Demonstrates how to initialize EFStyle25DParams to create a 2.5D QR code style.

```APIDOC
## EFStyle25DParams Initialization

### Description
Initializes parameters for 2.5D QR code styling, allowing customization of depth, colors, and included elements like icons and backdrops.

### Method
`init(icon:backdrop:dataHeight:positionHeight:topColor:leftColor:rightColor:)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **icon** (EFStyleParamIcon?) - Optional - The icon to display in the center of the QR code. Defaults to nil.
- **backdrop** (EFStyleParamBackdrop) - Optional - The backdrop configuration. Defaults to `EFStyle25DParams.defaultBackdrop`.
- **dataHeight** (CGFloat) - Optional - The height of data modules for 3D effect. Defaults to 1.0.
- **positionHeight** (CGFloat) - Optional - The height of position detection patterns for 3D effect. Defaults to 1.0.
- **topColor** (CGColor) - Optional - The color of the top face of modules. Defaults to `EFStyle25DParams.defaultTopColor`.
- **leftColor** (CGColor) - Optional - The color of the left face of modules. Defaults to `EFStyle25DParams.defaultLeftColor`.
- **rightColor** (CGColor) - Optional - The color of the right face of modules. Defaults to `EFStyle25DParams.defaultRightColor`.

### Request Example
```swift
let params = EFStyle25DParams(
    icon: icon,
    backdrop: backdrop,
    dataHeight: 1.0,
    positionHeight: 1.0,
    topColor: .black,
    leftColor: .darkGray,
    rightColor: .lightGray
)
let style = EFQRCodeStyle.style25D(params)
```

### Response
This is an initializer, so no direct response body is applicable. The result is a configured `EFStyle25DParams` object used to create a QR code style.
```

--------------------------------

### Initialize Styling Parameters

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleImageParamsData.html

Initializer for setting custom styles, scales, and colors for data modules.

```Swift
public init(
    style: EFStyleParamsDataStyle = .rectangle,
    scale: CGFloat = 1,
    colorDark: CGColor = EFStyleImageParamsData.defaultColorDark,
    colorLight: CGColor = EFStyleImageParamsData.defaultColorLight
)
```

--------------------------------

### Initialize Line Styling Parameters

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleLineParamsLine.html

Creates an instance of line styling parameters with configurable direction, thickness, and color.

```Swift
public init(
    direction: EFStyleLineParamsLineDirection = .x,
    thickness: CGFloat = 0.5, color: CGColor = EFStyleLineParamsLine.defaultColor
)
```

--------------------------------

### Initialize EFQRCodeStyleBasic

Source: https://efprefix.github.io/EFQRCode/Classes/EFQRCodeStyleBasic.html

Creates a new instance of the basic QR code style using the provided parameters.

```Swift
public init(params: EFStyleBasicParams)
```

--------------------------------

### Initialize Basic QR Code Styling Parameters

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleBasicParams.html

Use this initializer to create basic QR code styling parameters. It allows customization of the icon, backdrop, position, data, alignment, and timing patterns. Defaults are provided for most parameters if not explicitly set.

```swift
public init(
    icon: EFStyleParamIcon? = nil,
    backdrop: EFStyleParamBackdrop = EFStyleBasicParams.defaultBackdrop,
    position: EFStyleBasicParamsPosition = EFStyleBasicParams.defaultPosition,
    data: EFStyleBasicParamsData = EFStyleBasicParams.defaultData,
    align: EFStyleBasicParamsAlign = EFStyleBasicParams.defaultAlign,
    timing: EFStyleBasicParamsTiming = EFStyleBasicParams.defaultTiming
)
```

--------------------------------

### Initialize timing pattern parameters

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleImageParamsTiming.html

Initializer for setting style, size, and colors for timing patterns.

```Swift
public init(
    style: EFStyleImageParamTimingStyle = .rectangle,
    size: CGFloat = 1,
    colorDark: CGColor = EFStyleImageParamsTiming.defaultColorDark,
    colorLight: CGColor = EFStyleImageParamsTiming.defaultColorLight
)
```

--------------------------------

### EFQRCodeStyleImageFill Initialization

Source: https://efprefix.github.io/EFQRCode/Classes/EFQRCodeStyleImageFill.html

Documentation for initializing the image fill style for QR code generation.

```APIDOC
## init(params:)

### Description
Creates an image fill QR code with the specified parameters.

### Parameters
#### Path Parameters
- **params** (EFStyleImageFillParams) - Required - The image fill styling parameters.

### Request Example
let params = EFStyleImageFillParams(
    image: imageParams,
    backgroundColor: .white,
    maskColor: .black
)

let style = EFQRCodeStyleImageFill(params: params)
```

--------------------------------

### Clone EFQRCode Repository

Source: https://efprefix.github.io/EFQRCode/index.html

Clone the EFQRCode repository and open the workspace to run demo projects.

```bash
git clone git@github.com:EFPrefix/EFQRCode.git; cd EFQRCode; open 'EFQRCode.xcworkspace'
```

--------------------------------

### Initialize EFQRCodeStyle25D

Source: https://efprefix.github.io/EFQRCode/Classes/EFQRCodeStyle25D.html

Configures the 2.5D style parameters and initializes the style object.

```Swift
 let params = EFStyle25DParams(
     dataHeight: 1.0,
     positionHeight: 1.0,
     topColor: .black,
     leftColor: .darkGray,
     rightColor: .lightGray
 )

 let style = EFQRCodeStyle25D(params: params)
```

--------------------------------

### Initialize EFQRCodeStyleLine with Parameters

Source: https://efprefix.github.io/EFQRCode/Classes/EFQRCodeStyleLine.html

Use this to create a line-style QR code. Requires EFStyleLineParams which specifies line styling.

```swift
 let params = EFStyleLineParams(
     position: position,
     line: lineParams
 )

 let style = EFQRCodeStyleLine(params: params)
```

--------------------------------

### Initialize EFQRCodeStyleImage

Source: https://efprefix.github.io/EFQRCode/Classes/EFQRCodeStyleImage.html

Creates an image-based QR code style with specified parameters. Use this initializer to set up the styling for your QR code.

```swift
public init(params: EFStyleImageParams)
```

--------------------------------

### Configure EFStyleParams

Source: https://efprefix.github.io/EFQRCode/Classes.html

Sets up styling parameters including icon and backdrop configurations.

```Swift
 let icon = EFStyleParamIcon(
     image: .static(myIconImage),
     mode: .scaleAspectFill,
     alpha: 0.8,
     borderColor: .black,
     percentage: 0.2
 )

 let params = EFStyleParams(
     icon: icon,
     backdrop: .clear
 )
```

--------------------------------

### Initialize EFQRCodeStyleImage

Source: https://efprefix.github.io/EFQRCode/Classes/EFQRCodeStyleImage.html

Initializes a new instance of the EFQRCodeStyleImage class with the provided styling parameters.

```APIDOC
## Initialization

### Description
Creates an image-based QR code style with specified parameters.

### Parameters
#### Path Parameters
- **params** (EFStyleImageParams) - Required - The styling parameters.

### Request Example
```swift
let style = EFQRCodeStyleImage(params: myParams)
```
```

--------------------------------

### Constructor: init(icon:backdrop:position:data:)

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleFunctionParams.html

Initializes a new instance of EFStyleFunctionParams to define the styling parameters for function-based QR codes.

```APIDOC
## Constructor: init(icon:backdrop:position:data:)

### Description
Creates function-based QR code styling parameters.

### Parameters
- **icon** (EFStyleParamIcon?) - Optional - The icon to display in the center of the QR code. Defaults to nil.
- **backdrop** (EFStyleParamBackdrop) - Optional - The backdrop configuration. Defaults to default backdrop.
- **position** (EFStyleFunctionParamsPosition) - Optional - The position detection pattern configuration. Defaults to default position.
- **data** (EFStyleFunctionParamsData) - Optional - The data module configuration. Defaults to default data.
```

--------------------------------

### EFStyleLineParams Initialization

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleLineParams.html

Demonstrates how to initialize EFStyleLineParams with custom or default values for line-style QR code styling.

```APIDOC
## EFStyleLineParams Initialization

### Description
Initializes `EFStyleLineParams` with customizable parameters for line-style QR code styling.

### Method
`init(icon:backdrop:position:line:)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **icon** (EFStyleParamIcon?) - Optional - The icon to display in the center of the QR code. Defaults to nil.
- **backdrop** (EFStyleParamBackdrop) - Optional - The backdrop configuration. Defaults to `EFStyleLineParams.defaultBackdrop`.
- **position** (EFStyleLineParamsPosition) - Optional - The position detection pattern configuration. Defaults to `EFStyleLineParams.defaultPosition`.
- **line** (EFStyleLineParamsLine) - Optional - The line configuration. Defaults to `EFStyleLineParams.defaultLine`.

### Request Example
```swift
let lineParams = EFStyleLineParamsLine(
    direction: .x,
    thickness: 0.5,
    color: .black
)

let params = EFStyleLineParams(
    icon: icon,
    backdrop: backdrop,
    position: position,
    line: lineParams
)

let style = EFQRCodeStyle.line(params)
```

### Response
#### Success Response (200)
N/A (This is an initializer)

#### Response Example
N/A
```

--------------------------------

### Initialize EFStyleLineParams Instance

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleLineParams.html

Constructor for creating line-style QR code parameters with optional icon, backdrop, position, and line settings.

```Swift
public init(
    icon: EFStyleParamIcon? = nil,
    backdrop: EFStyleParamBackdrop = EFStyleLineParams.defaultBackdrop,
    position: EFStyleLineParamsPosition = EFStyleLineParams.defaultPosition,
    line: EFStyleLineParamsLine = EFStyleLineParams.defaultLine
)
```

--------------------------------

### Initialization

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleImageParamsAlign.html

Initializes EFStyleImageParamsAlign with specified styling parameters.

```APIDOC
## Initialization

### `init(style:size:colorDark:colorLight:)`

Creates alignment pattern styling parameters.

#### Declaration
Swift
```swift
public init(
    style: EFStyleImageParamAlignStyle = .rectangle,
    size: CGFloat = 1,
    colorDark: CGColor = EFStyleImageParamsAlign.defaultColorDark,
    colorLight: CGColor = EFStyleImageParamsAlign.defaultColorLight
)
```

#### Parameters

| Parameter     | Description                                                 |
|---------------|-------------------------------------------------------------|
| `_style_`     | The style of the alignment pattern. Defaults to .rectangle. |
| `_size_`      | The size of the alignment pattern. Defaults to 1.           |
| `_colorDark_` | The color for dark alignment pattern modules. Defaults to default color dark. |
| `_colorLight_`| The color for light alignment pattern modules. Defaults to default color light. |
```

--------------------------------

### EFQRCodeStyle25D Initialization

Source: https://efprefix.github.io/EFQRCode/Classes/EFQRCodeStyle25D.html

Initializes a 2.5D QR code with specified styling parameters.

```APIDOC
## EFQRCodeStyle25D init(params:)

### Description
Creates a 2.5D QR code with the specified parameters.

### Method
`init` (Constructor)

### Parameters
#### Request Body
- **params** (EFStyle25DParams) - Required - The 2.5D styling parameters.

### Request Example
```swift
let params = EFStyle25DParams(
    dataHeight: 1.0,
    positionHeight: 1.0,
    topColor: .black,
    leftColor: .darkGray,
    rightColor: .lightGray
)
let style = EFQRCodeStyle25D(params: params)
```

### Response
This is a constructor, so there is no direct response body. The `style` object is created.

#### Success Response (200)
N/A (Constructor)

#### Response Example
N/A (Constructor)
```

--------------------------------

### EFQRCodeStyleBubble Initialization

Source: https://efprefix.github.io/EFQRCode/Classes/EFQRCodeStyleBubble.html

Initializes a new instance of the bubble-style QR code renderer with specific styling parameters.

```APIDOC
## Initialization: EFQRCodeStyleBubble

### Description
Creates a bubble-style QR code with the specified parameters, allowing for rounded data modules and custom color configurations.

### Method
Initializer

### Parameters
#### Path Parameters
- **params** (EFStyleBubbleParams) - Required - The bubble styling parameters including dataColor, dataCenterColor, and position.

### Request Example
```swift
let params = EFStyleBubbleParams(
    dataColor: .blue,
    dataCenterColor: .white,
    position: position
)

let style = EFQRCodeStyleBubble(params: params)
```
```

--------------------------------

### Initialize EFStyleParamIcon

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleParamIcon.html

Use this initializer to create an icon configuration for QR code customization. Specify the image, scaling mode, transparency, border color, and size percentage.

```swift
let icon = EFStyleParamIcon(
    image: .static(myLogoImage),
    mode: .scaleAspectFill,
    alpha: 0.9,
    borderColor: .white,
    percentage: 0.25
)
```

```swift
public init(
    image: EFStyleParamImage,
    mode: EFImageMode = .scaleAspectFill,
    alpha: CGFloat = 1,
    borderColor: CGColor,
    percentage: CGFloat = 0.2
)
```

--------------------------------

### Initialize EFStyleImageParamsAlign with parameters

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleImageParamsAlign.html

Constructor for defining alignment pattern styling with optional parameters for style, size, and colors.

```Swift
public init(
    style: EFStyleImageParamAlignStyle = .rectangle,
    size: CGFloat = 1,
    colorDark: CGColor = EFStyleImageParamsAlign.defaultColorDark,
    colorLight: CGColor = EFStyleImageParamsAlign.defaultColorLight
)
```

--------------------------------

### Initialize EFStyleBasicParamsData

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleBasicParamsData.html

Creates an instance of the styling parameters with customizable style, scale, and color.

```Swift
public init(
    style: EFStyleBasicParamsDataStyle = .rectangle,
    scale: CGFloat = 1,
    color: CGColor = EFStyleBasicParamsData.defaultColor
)
```

--------------------------------

### Initialize EFStyleParamBackdropImage

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleParamBackdropImage.html

Creates a new instance of the backdrop image configuration for QR codes.

```APIDOC
## init(image:alpha:mode:)

### Description
Creates a backdrop image configuration for QR codes.

### Parameters
#### Request Body
- **image** (CGImage) - Required - The image to use as backdrop.
- **alpha** (CGFloat) - Optional - The alpha transparency. Defaults to 1.
- **mode** (EFImageMode) - Optional - The image mode for scaling and positioning. Defaults to scaleAspectFill.

### Request Example
```swift
let backdrop = EFStyleParamBackdropImage(image: myCGImage, alpha: 0.8, mode: .scaleAspectFill)
```
```

--------------------------------

### Initialize EFStyleParamBackdropImage

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleParamBackdropImage.html

Creates a backdrop image configuration for QR codes. Use this to set a custom image, its transparency, and scaling mode.

```swift
public init(
    image: CGImage,
    alpha: CGFloat = 1,
    mode: EFImageMode = .scaleAspectFill
)
```

--------------------------------

### EFStyleLineParamsLine Initialization

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleLineParamsLine.html

Documentation for the initializer and default properties of the EFStyleLineParamsLine class.

```APIDOC
## EFStyleLineParamsLine Initialization

### Description
Creates line styling parameters for line QR codes, including direction, thickness, and color.

### Parameters
#### Initializer Parameters
- **direction** (EFStyleLineParamsLineDirection) - Optional - The direction of the lines. Defaults to .x.
- **thickness** (CGFloat) - Optional - The thickness of the lines (0-1]. Defaults to 0.5.
- **color** (CGColor) - Optional - The color of the lines. Defaults to black.

### Properties
- **defaultColor** (CGColor) - The default color used for lines (black).
```

--------------------------------

### Initialize EFStyleImageParamsImage in Swift

Source: https://efprefix.github.io/EFQRCode/Classes.html

Configure how an image is used to fill QR code modules. Specify the image and the scaling mode.

```swift
 let imageParams = EFStyleImageParamsImage(
     image: myImage,
     mode: .scaleAspectFill
 )
```

--------------------------------

### EFQRCodeStyleDSJ Initialization

Source: https://efprefix.github.io/EFQRCode/Classes/EFQRCodeStyleDSJ.html

Initializes a new instance of the DSJ-style QR code generator with specific styling parameters.

```APIDOC
## init(params:)

### Description
Creates a DSJ-style QR code with the specified parameters, enabling custom position detection patterns and data module styling.

### Method
Initializer

### Parameters
#### Path Parameters
- **params** (EFStyleDSJParams) - Required - The DSJ styling parameters including position and data module configurations.

### Request Example
```swift
let params = EFStyleDSJParams(
    position: position,
    data: dataParams
)

let style = EFQRCodeStyleDSJ(params: params)
```
```

--------------------------------

### Create Basic QR Code Style

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleBasicParams.html

Instantiate EFStyleBasicParams with your desired configuration and then use it to create a basic QR code style. This is useful for applying custom visual elements to your QR codes.

```swift
 let params = EFStyleBasicParams(
     icon: icon,
     backdrop: backdrop,
     position: position,
     data: data,
     align: align,
     timing: timing
 )

 let style = EFQRCodeStyle.basic(params)
```

--------------------------------

### Initialize EFStyleDSJParams Instance

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleDSJParams.html

Constructor for creating a new instance of DSJ-style QR code parameters with optional configurations.

```Swift
public init(
    icon: EFStyleParamIcon? = nil,
    backdrop: EFStyleParamBackdrop = EFStyleDSJParams.defaultBackdrop,
    position: EFStyleDSJParamsPosition = EFStyleDSJParams.defaultPosition,
    data: EFStyleDSJParamsData = EFStyleDSJParams.defaultData
)
```

--------------------------------

### Initialize EFQRCodeStyleImageFill

Source: https://efprefix.github.io/EFQRCode/Classes/EFQRCodeStyleImageFill.html

Creates an image fill QR code with the specified parameters. Use this to set up the image, background color, and mask color for your QR code.

```swift
 let params = EFStyleImageFillParams(
     image: imageParams,
     backgroundColor: .white,
     maskColor: .black
 )

 let style = EFQRCodeStyleImageFill(params: params)
```

--------------------------------

### Initialize EFStyle25DParams

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyle25DParams.html

Constructor for creating 2.5D styling parameters with customizable heights and face colors.

```Swift
public init(
    icon: EFStyleParamIcon? = nil,
    backdrop: EFStyleParamBackdrop = EFStyle25DParams.defaultBackdrop,
    dataHeight: CGFloat = 1,
    positionHeight: CGFloat = 1,
    topColor: CGColor = EFStyle25DParams.defaultTopColor,
    leftColor: CGColor = EFStyle25DParams.defaultLeftColor,
    rightColor: CGColor = EFStyle25DParams.defaultRightColor
)
```

--------------------------------

### EFQRCodeStyleBasic Initialization

Source: https://efprefix.github.io/EFQRCode/Classes/EFQRCodeStyleBasic.html

This snippet covers the initializer for the EFQRCodeStyleBasic class, used to create a new basic QR code style with specified parameters.

```APIDOC
## EFQRCodeStyleBasic

Basic QR code style implementation. This class implements the rendering logic for traditional QR codes with customizable alignment, timing, data, and position patterns, as well as icon and backdrop support.

### Initializer: `init(params:)`

Creates a new basic QR code style with the given parameters.

#### Declaration
Swift
```swift
public init(params: EFStyleBasicParams)
```

#### Parameters
- **params** (EFStyleBasicParams) - Required - The parameters for the basic style.
```

--------------------------------

### Initialize EFStyleBubbleParams

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleBubbleParams.html

Constructor for creating bubble QR code styling parameters with optional configurations.

```Swift
public init(
    icon: EFStyleParamIcon? = nil,
    backdrop: EFStyleParamBackdrop = EFStyleBubbleParams.defaultBackdrop,
    dataColor: CGColor = EFStyleBubbleParams.defaultDataColor,
    dataCenterColor: CGColor = EFStyleBubbleParams.defaultDataCenterColor,
    position: EFStyleBubbleParamsPosition = EFStyleBubbleParams.defaultPosition
)
```

--------------------------------

### Initialize EFStyleImageParamsImage

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleImageParamsImage.html

Use this to create image configuration for module filling in QR codes. Specify the image, scaling mode, alpha, and transparency allowance.

```swift
let imageParams = EFStyleImageParamsImage(
    image: myImage,
    mode: .scaleAspectFill
)
```

```swift
public init(
    image: EFStyleParamImage,
    mode: EFImageMode = .scaleAspectFill,
    alpha: CGFloat = 1,
    allowTransparent: Bool = false
)
```

--------------------------------

### EFQRCodeStyleLine Initialization

Source: https://efprefix.github.io/EFQRCode/Classes/EFQRCodeStyleLine.html

Initializes a line-style QR code with the specified parameters.

```APIDOC
## EFQRCodeStyleLine.init(params:)

### Description
Creates a line-style QR code with the specified parameters.

### Method
`init`

### Parameters
#### Request Body
- **params** (EFStyleLineParams) - Required - The line styling parameters.
```

--------------------------------

### Create QR Code Generator with Data

Source: https://efprefix.github.io/EFQRCode/Classes/EFQRCode/Generator.html

Initializes a QR code generator with raw data. The data size must be compatible with QR code capacity. Defaults to high error correction level.

```swift
public init(
    _ data: Data,
    errorCorrectLevel: EFCorrectionLevel = .h,
    style: EFQRCodeStyle
) throws
```

--------------------------------

### Initialize EFStyleResampleImageParamsImage

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleResampleImageParamsImage.html

Creates an image configuration for resampling. Use this to set the image, resampling mode, contrast, and exposure.

```swift
public init(
    image: EFStyleParamImage,
    mode: EFImageMode = .scaleAspectFill,
    contrast: CGFloat = 0,
    exposure: CGFloat = 0
)
```

--------------------------------

### Initialize EFStyleResampleImageParams

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleResampleImageParams.html

Constructor for creating resample image QR code styling parameters with optional configurations.

```Swift
public init(
    icon: EFStyleParamIcon? = nil,
    backdrop: EFStyleParamBackdrop = EFStyleResampleImageParams.defaultBackdrop,
    image: EFStyleResampleImageParamsImage?,
    align: EFStyleResampleImageParamsAlign = EFStyleResampleImageParams.defaultAlign,
    timing: EFStyleResampleImageParamsTiming = EFStyleResampleImageParams.defaultTiming,
    position: EFStyleResampleImageParamsPosition = EFStyleResampleImageParams.defaultPosition,
    dataColor: CGColor = EFStyleResampleImageParams.defaultDataColor
)
```

--------------------------------

### Initialize Image-Based QR Code Styling Parameters

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleImageParams.html

Use this initializer to create custom styling for image-based QR codes. It allows for detailed control over icons, backdrops, alignment, timing, position, data modules, and the filling image.

```swift
public init(
    icon: EFStyleParamIcon? = nil,
    backdrop: EFStyleParamBackdrop = EFStyleImageParams.defaultBackdrop,
    align: EFStyleImageParamsAlign = EFStyleImageParams.defaultAlign,
    timing: EFStyleImageParamsTiming = EFStyleImageParams.defaultTiming,
    position: EFStyleImageParamsPosition = EFStyleImageParams.defaultPosition,
    data: EFStyleImageParamsData = EFStyleImageParams.defaultData,
    image: EFStyleImageParamsImage?
)
```

--------------------------------

### EFStyleParamBackdrop - Initializer

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleParamBackdrop.html

Initializes a backdrop configuration for QR codes with customizable properties.

```APIDOC
## EFStyleParamBackdrop - Initializer

### Description
Creates a backdrop configuration for QR codes.

### Method
`init`

### Parameters
#### Parameters
- **cornerRadius** (CGFloat) - Optional - The corner radius of the backdrop. Defaults to 0.
- **color** (CGColor) - Optional - The color of the backdrop. Defaults to white.
- **image** (EFStyleParamBackdropImage?) - Optional - The image to use as backdrop. Defaults to nil.
- **quietzone** (EFEdgeInsets?) - Optional - The quiet zone insets around the QR code. Defaults to nil.

### Declaration
Swift
```swift
public init(
    cornerRadius: CGFloat = 0,
    color: CGColor = EFStyleParamBackdrop.defaultColor,
    image: EFStyleParamBackdropImage? = nil,
    quietzone: EFEdgeInsets? = nil
)
```
```

--------------------------------

### Initialize EFQRCodeStyleResampleImage

Source: https://efprefix.github.io/EFQRCode/Classes/EFQRCodeStyleResampleImage.html

Constructor for creating a new instance of the resample image style.

```Swift
public init(params: EFStyleResampleImageParams)
```

--------------------------------

### Initialize EFQRCodeStyleFunction

Source: https://efprefix.github.io/EFQRCode/Classes/EFQRCodeStyleFunction.html

Creates a function-based QR code with the specified parameters. Use this to initialize the QR code generator with custom styling functions.

```swift
public init(params: EFStyleFunctionParams)
```

--------------------------------

### Default Line Configuration

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleLineParams.html

The default line configuration.

```Swift
public static let defaultLine: EFStyleLineParamsLine
```

--------------------------------

### Initialize EFStyleDSJParamsData

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleDSJParamsData.html

Creates data module styling parameters for DSJ QR codes. Allows customization of line size, X size, and colors.

```Swift
public init(
    lineSize: CGFloat = 0.7,
    xSize: CGFloat = 0.7,
    horizontalLineColor: CGColor = EFStyleDSJParamsData.defaultHorizontalLineColor,
    verticalLineColor: CGColor = EFStyleDSJParamsData.defaultVerticalLineColor,
    xColor: CGColor = EFStyleDSJParamsData.defaultXColor
)
```

--------------------------------

### Initialize EFStyleImageFillParamsImage

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleImageFillParams.html

Use this to configure the image parameters for an image fill QR code. Specify the image, scaling mode, and transparency.

```swift
let imageParams = EFStyleImageFillParamsImage(
    image: myImage,
    mode: .scaleAspectFill,
    alpha: 1.0
)
```

--------------------------------

### Initialize Alignment Pattern Styling Parameters

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleResampleImageParamsAlign.html

Creates alignment pattern styling parameters with customizable options for style, color, size, and whether to use only white. Defaults are provided for convenience.

```swift
public init(
    style: EFStyleResampleImageParamAlignStyle = .rectangle,
    onlyWhite: Bool = false,
    size: CGFloat = 1,
    color: CGColor = EFStyleResampleImageParamsAlign.defaultColor
)
```

--------------------------------

### EFStyleDSJParams Initialization

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleDSJParams.html

Initializes DSJ-style QR code styling parameters with optional icon, backdrop, position, and data configurations.

```APIDOC
## `init(icon:backdrop:position:data:)`

### Description
Creates DSJ-style QR code styling parameters.

### Method
`init`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```swift
let params = EFStyleDSJParams(
    icon: icon,
    backdrop: backdrop,
    position: position,
    data: dataParams
)
```

### Response
#### Success Response (200)
None

#### Response Example
None
```

--------------------------------

### Initialize EFStyleResampleImageParamsTiming

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleResampleImageParamsTiming.html

Creates timing pattern styling parameters with customizable options for style, color, and size. Defaults are provided for convenience.

```swift
public init(
    style: EFStyleResampleImageParamTimingStyle = .rectangle,
    onlyWhite: Bool = false,
    size: CGFloat = 1,
    color: CGColor = EFStyleResampleImageParamsTiming.defaultColor
)
```

--------------------------------

### EFQRCodeStyleFunction Initialization

Source: https://efprefix.github.io/EFQRCode/Classes/EFQRCodeStyleFunction.html

Initializes a new instance of the function-based QR code style using specified parameters.

```APIDOC
## init(params:)

### Description
Creates a function-based QR code with the specified parameters.

### Method
Initializer

### Parameters
#### Path Parameters
- **params** (EFStyleFunctionParams) - Required - The function styling parameters.

### Request Example
let params = EFStyleFunctionParams(
    position: position,
    data: dataParams
)

let style = EFQRCodeStyleFunction(params: params)
```

--------------------------------

### EFStyleImageFillParamsImage Initialization

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleImageFillParamsImage.html

Initializes an image configuration for image fill QR codes with specified image, mode, and alpha.

```APIDOC
## EFStyleImageFillParamsImage Initialization

### Description
Creates an image configuration for image fill QR codes.

### Method
`init(image:mode:alpha:)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None

## Parameters
- **image** (EFStyleParamImage) - Required - The image to be used as background.
- **mode** (EFImageMode) - Optional - The image mode for scaling and positioning. Defaults to scaleAspectFill.
- **alpha** (CGFloat) - Optional - The alpha transparency value. Defaults to 1.0.
```

--------------------------------

### Initialize Position Detection Pattern Styling Parameters

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleBasicParamsPosition.html

Initializes EFStyleParamsPosition with customizable style, size, and color for QR code position detection patterns. Defaults are provided for each parameter.

```swift
public init(
    style: EFStyleParamsPositionStyle = .rectangle,
    size: CGFloat = 1,
    color: CGColor = EFStyleBasicParamsPosition.defaultColor
)
```

--------------------------------

### Initialize EFStyleImageFillParams with Defaults

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleImageFillParams.html

Initializes image fill QR code styling parameters using default values for backdrop, background color, and mask color. You must provide an icon and image configuration.

```swift
public init(
    icon: EFStyleParamIcon? = nil,
    backdrop: EFStyleParamBackdrop = EFStyleImageFillParams.defaultBackdrop,
    image: EFStyleImageFillParamsImage?,
    backgroundColor: CGColor = EFStyleImageFillParams.defaultBackgroundColor,
    maskColor: CGColor = EFStyleImageFillParams.defaultMaskColor
)
```

--------------------------------

### EFStyleImageParamsData Initialization

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleImageParamsData.html

Documentation for the initializer and default properties of the EFStyleImageParamsData class.

```APIDOC
## EFStyleImageParamsData Initialization

### Description
Creates data module styling parameters for image-based QR codes, allowing customization of module shape, scale, and colors.

### Parameters
#### Initializer Parameters
- **style** (EFStyleParamsDataStyle) - Optional - The style of the data module. Defaults to .rectangle.
- **scale** (CGFloat) - Optional - The scale of the data module. Defaults to 1.
- **colorDark** (CGColor) - Optional - The color for dark data modules. Defaults to EFStyleImageParamsData.defaultColorDark.
- **colorLight** (CGColor) - Optional - The color for light data modules. Defaults to EFStyleImageParamsData.defaultColorLight.

### Request Example
let data = EFStyleImageParamsData(
    style: .rectangle,
    scale: 1.0,
    colorDark: .black,
    colorLight: .white
)

### Constants
- **defaultColorDark** (CGColor) - Default color for dark data modules (black).
- **defaultColorLight** (CGColor) - Default color for light data modules (white).
```

--------------------------------

### EFQRCodeStyleResampleImage Initializer

Source: https://efprefix.github.io/EFQRCode/Classes/EFQRCodeStyleResampleImage.html

Initializes a new EFQRCodeStyleResampleImage object with specified parameters for creating QR codes with resampled image effects.

```APIDOC
## EFQRCodeStyleResampleImage

QR code style implementation for resample image effect. This class implements the rendering logic for QR codes that use a resampled image to color the modules, supporting advanced artistic effects.

### Initializer

#### `init(params: EFStyleResampleImageParams)`

Creates a new resample image style with the given parameters.

##### Declaration
Swift
```swift
public init(params: EFStyleResampleImageParams)
```

##### Parameters
- **params** (EFStyleResampleImageParams) - Required - The parameters for the resample image style.
```

--------------------------------

### Add EFQRCode as a Carthage Dependency

Source: https://efprefix.github.io/EFQRCode/index.html

Specify EFQRCode in your Cartfile and run 'carthage update' to build the framework.

```bash
github "EFPrefix/EFQRCode" ~> 7.0.3
```

--------------------------------

### EFStyleBasicParams Initialization

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleBasicParams.html

Initializes a new instance of EFStyleBasicParams to define the visual appearance of a QR code.

```APIDOC
## init(icon:backdrop:position:data:align:timing:)

### Description
Creates basic QR code styling parameters with customizable patterns and modules.

### Parameters
- **icon** (EFStyleParamIcon?) - Optional - The icon to display in the center of the QR code. Defaults to nil.
- **backdrop** (EFStyleParamBackdrop) - Optional - The backdrop configuration. Defaults to defaultBackdrop.
- **position** (EFStyleBasicParamsPosition) - Optional - The position detection pattern configuration. Defaults to defaultPosition.
- **data** (EFStyleBasicParamsData) - Optional - The data module configuration. Defaults to defaultData.
- **align** (EFStyleBasicParamsAlign) - Optional - The alignment pattern configuration. Defaults to defaultAlign.
- **timing** (EFStyleBasicParamsTiming) - Optional - The timing pattern configuration. Defaults to defaultTiming.

### Request Example
let params = EFStyleBasicParams(
    icon: icon,
    backdrop: backdrop,
    position: position,
    data: data,
    align: align,
    timing: timing
)
```

--------------------------------

### Initialize EFStyleBubbleParamsPosition

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleBubbleParamsPosition.html

Creates a new instance with customizable style, size, and color parameters.

```Swift
public init(
    style: EFStyleParamsPositionStyle = .round,
    size: CGFloat = 1,
    color: CGColor = EFStyleBasicParamsPosition.defaultColor
)
```

--------------------------------

### Initialize EFStyleFunctionParamsPosition

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleFunctionParamsPosition.html

Creates a new instance with specified style, size, and color parameters.

```Swift
public init(
    style: EFStyleParamsPositionStyle = .round,
    size: CGFloat = 1,
    color: CGColor = EFStyleFunctionParamsPosition.defaultColor
)
```

--------------------------------

### EFStyleRandomRectangleParams Initialization

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleRandomRectangleParams.html

Demonstrates how to initialize EFStyleRandomRectangleParams with custom icon, backdrop, and color.

```APIDOC
## EFStyleRandomRectangleParams Initialization

### Description
Initializes random rectangle QR code styling parameters.

### Method
`init(icon:backdrop:color:)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```swift
 let params = EFStyleRandomRectangleParams(
     icon: icon,
     backdrop: backdrop,
     color: .green
 )

 let style = EFQRCodeStyle.randomRectangle(params)
```

### Response
#### Success Response (200)
None

#### Response Example
None
```

--------------------------------

### Initialize EFStyleResampleImageParamsImage

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleResampleImageParamsImage.html

Creates an image configuration instance for resampling with specified image, mode, contrast, and exposure settings.

```APIDOC
## init(image:mode:contrast:exposure:)

### Description
Creates an image configuration for resampling.

### Parameters
- **image** (EFStyleParamImage) - Required - The image to be used for resampling.
- **mode** (EFImageMode) - Optional - The image mode for resampling. Defaults to scaleAspectFill.
- **contrast** (CGFloat) - Optional - The contrast adjustment. Defaults to 0.
- **exposure** (CGFloat) - Optional - The exposure adjustment. Defaults to 0.

### Request Example
```swift
let config = EFStyleResampleImageParamsImage(
    image: myImage,
    mode: .scaleAspectFill,
    contrast: 0.0,
    exposure: 0.0
)
```
```

--------------------------------

### EFStyleImageParamsImage Initialization

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleImageParamsImage.html

This snippet shows how to initialize EFStyleImageParamsImage to configure image filling for QR code modules.

```APIDOC
## EFStyleImageParamsImage

Image configuration for module filling in image-based QR codes.
This class defines how an image is used to fill QR code modules.

### Usage
```swift
 let imageParams = EFStyleImageParamsImage(
     image: myImage,
     mode: .scaleAspectFill
 )
```

### Initializer: `init(image:mode:alpha:allowTransparent:)`
Creates image configuration for module filling.

#### Declaration
Swift
```swift
public init(
    image: EFStyleParamImage,
    mode: EFImageMode = .scaleAspectFill,
    alpha: CGFloat = 1,
    allowTransparent: Bool = false
)
```

#### Parameters
- **image** (EFStyleParamImage) - Required - The image to use.
- **mode** (EFImageMode) - Optional - The scaling mode. Defaults to .scaleAspectFill.
- **alpha** (CGFloat) - Optional - The opacity of the image. Defaults to 1.
- **allowTransparent** (Bool) - Optional - Whether to allow transparent pixels. Defaults to false.
```

--------------------------------

### Create QR Code Generator with Existing QRCode and Style Implementation

Source: https://efprefix.github.io/EFQRCode/Classes/EFQRCode/Generator.html

Initializes a QR code generator with an existing QRCode object and a specific style implementation.

```swift
public init(
    _ qrcode: QRCode,
    styleImplementation: EFQRCodeStyleBase
)
```

--------------------------------

### Default Configurations

Source: https://efprefix.github.io/EFQRCode/Classes/EFStyleLineParams.html

Provides access to default configurations for backdrop, position, and line styles.

```APIDOC
## Default Configurations

### Description
Provides access to default configurations for various aspects of line-style QR code styling.

### Method
- `defaultBackdrop`: `EFStyleParamBackdrop`
- `defaultPosition`: `EFStyleLineParamsPosition`
- `defaultLine`: `EFStyleLineParamsLine`

### Endpoint
N/A (Static properties)

### Parameters
None

### Request Example
```swift
let defaultBackdrop = EFStyleLineParams.defaultBackdrop
let defaultPosition = EFStyleLineParams.defaultPosition
let defaultLine = EFStyleLineParams.defaultLine
```

### Response
#### Success Response (200)
Returns the respective default configuration object.

#### Response Example
```json
{
  "example": "Default configuration object"
}
```
```
Tokens:
Raw