Files
2026-07-13 12:06:04 +08:00

2.4 KiB

This is the documentation for the iOS OpenCV framework.

Quick Start Tutorial

Follow the steps below to get a simple "Hello World" app running on iOS

  • Open Xcode and create a new project from the File > New > Project... menu

New Project menu

  • From template selection dialog select the iOS tab and then select App

Template selection dialog

  • Enter a name for the project and set Interface to Storyboard and Language to Swift

App settings dialog

  • Choose a location to save the project

Choose project location dialog

  • Create a new folder Framework

Create new folder menu

  • In a Finder window copy the framework file to the newly created folder. The framework should appear in the project navigator as below. (Note: in this case the framework has extension .framework but depending on how you built it or from where you obtained it your framework may have extension .xcframework)

Add framework

  • In the project navigator select the ViewController.swift file

Select ViewController file

  • Add an import for the OpenCV framework below the existing import for UIKit
import opencv2
  • Replace the implementation of the viewDidLoad function with the following code
override func viewDidLoad() {
    super.viewDidLoad()
    let white = Scalar(255, 255, 255, 255)
    let black = Scalar(0, 0, 0, 255)
    let m = Mat(rows: 400, cols: Int32(view.frame.width), type: CvType.CV_8UC4, scalar: white)
    Imgproc.putText(img: m, text: "Hello World", org: Point(x: 10, y: 150), fontFace: HersheyFonts.FONT_HERSHEY_DUPLEX, fontScale: 2, color: black)
    let image = m.toUIImage()
    let imageView = UIImageView(image: image)
    self.view.addSubview(imageView)
}
  • The ViewController.swift file should now look like this

Updated ViewController code

  • Launch the app

Launch app button

  • The app home screen should look like this

App screenshot

If that has all worked well then congratulations. If not then feel free to reach out to the OpenCV community for help. Also feel free to contribute fixes and improvements.