Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add documentation for BlurHashEncode #227

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add documentation for BlurHashEncode #227

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions Swift/BlurHashEncode.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
import UIKit

extension UIImage {
/// This returns a string containing the BlurHash for the image, or nil if the image was in a weird format that is not supported.
/// - Parameter components: A Tuple of integers specifying the number of components in the X and Y directions. Both must be between 1 and 9 inclusive, or the function will return nil. 3 to 5 is usually a good range.
/// - Returns: A string containing the BlurHash for the image.
public func blurHash(numberOfComponents components: (Int, Int)) -> String? {
let pixelWidth = Int(round(size.width * scale))
let pixelHeight = Int(round(size.height * scale))
Expand Down