https://github.com/aaronjsutton/OverlayComposite

An image compositing framework written in Swift.
https://github.com/aaronjsutton/OverlayComposite

framework image-processing ios swift swift-library swift4

Last synced: about 1 month ago
JSON representation

An image compositing framework written in Swift.

• Host: GitHub
• URL: https://github.com/aaronjsutton/OverlayComposite
• Owner: aaronjsutton
• License: apache-2.0
• Created: 2017-11-24T14:08:52.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2017-12-05T06:53:30.000Z (almost 7 years ago)
• Last Synced: 2024-04-25T23:22:37.813Z (5 months ago)
• Topics: framework, image-processing, ios, swift, swift-library, swift4
• Language: Swift
• Homepage:
• Size: 8.33 MB
• Stars: 11
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-ios - OverlayComposite - An asynchronous, multithreaded, image compositing framework written in Swift. (Media / Image)
• awesome-ios-star - OverlayComposite - An asynchronous, multithreaded, image compositing framework written in Swift. (Media / Image)

README

        
![Logo](https://docs.aaronjsutton.com/overlay/img/logo.png)

[![Build Status](https://travis-ci.org/aaronjsutton/OverlayComposite.svg?branch=master)](https://travis-ci.org/aaronjsutton/OverlayComposite)

[![CocoaPods](https://img.shields.io/cocoapods/v/OverlayComposite.svg)]()

An asynchronous, multithreaded, image compositing framework written in Swift.

## Installation

### [CocoaPods](http://cocoapods.org)

Add Overlay to your Podfile:

```ruby

pod 'OverlayComposite'

```

And run `pod install`

## Usage

### Quick Start

#### Creating Layers

Overlay works using the concept of _layered images_. Each layer represents an individual image that can then be added atop another layer. You can think of this like layers in Photoshop, or similar image editor.

For example, take the following model:

![Layer 0](https://docs.aaronjsutton.com/overlay/img/example.png)

- Layer 0: A large blue square

- Layer 1: A medium orange triangle

- Layer 2: A small green polygon

_Technical Note:_ For this guide, we will assume that these images are named "Square", "Triangle", and "Polygon" in our app's Asset Catalog, and they are all formatted as PNG images with a transparent background.

A collection of images organized into layers is represented in code using the `Layers` class.

```swift

// Create a dictionary of all the images and layers we want to create.

// This will then be passed to Layers

let layerDictionary: [Int: String] =

[

  0: "Square",

  1: "Triangle",

  2: "Polygon"

]

// Create the new layers object.

guard let layers = try? Layers(named: layerDictionary) else {

  // Some error occurred

  return

}

```

Alternatively, you could create a dictionary using UIImage objects:

```swift

let layerDictionary: [Int: UIImage]

```

And pass it to `Layers.init(with:)`

_Now we have a layered image represented in Swift!_

#### Rendering Layers

Of course, we want to be able to use our new composite image. To do that we use `OverlayRenderer`

```swift

// Create a new renderer

let renderer = OverlayRenderer()

renderer.composite(from: layers) { result in

  // Here we can access the completed render

}

```

The result:

![Result](https://docs.aaronjsutton.com/overlay/img/result.png)

To see this in action, check out the Sample App included in the source code.

#### Layer Operations

You can insert, append, and remove layers from a `Layers` object.

See the [Layers Guide](https://docs.aaronjsutton.com/overlay/Classes/Layers.html)

### [API Documentation](https://docs.aaronjsutton.com/overlay/)

## Contributing

#### Pull Requests

If you wish to contribute to Overlay, create a new branch, implement your feature or fix, and then submit a pull request.

#### Documentation

Generate documentation with [Jazzy](https://github.com/realm/jazzy)