More Extensions #8

frankschlegel · 2022-08-08T12:36:42Z

Added a lot more useful extensions that I came up with while working on my EDR test pattern (coming in the next PR).

…n image.

…paces.

…g images.

…ngs.

phjs · 2022-08-08T14:15:04Z

Sources/CIImage+Transformation.swift

+
+    /// Returns a new image that represents the original image after scaling it by the given factors in x- and y-direction.
+    ///
+    /// The interpolation used for the sampling technique used by the image.


Seems to be incomplete or wrong here

phjs · 2022-08-08T14:40:55Z

Sources/CIImage+Text.swift

+    /// Generates an image that contains the given text.
+    /// - Parameters:
+    ///   - text: The string of text to render.
+    ///   - fontName: The name of the font that should be used for rendering the text.


Maybe, add the default values into the doc string

phjs · 2022-08-08T14:45:29Z

Sources/CIColor+Extensions.swift

+    ///   - white: The unpremultiplied component value that should be use for all three color channels.
+    ///   - alpha: The alpha (opacity) component of the color.
+    ///   - colorSpace: The color space in which to create the new color. This color space must conform to the `CGColorSpaceModel.rgb` color space model.
+    convenience init?(white: CGFloat, alpha: CGFloat = 1.0, colorSpace: CGColorSpace? = nil) {


Why is the parameter called white?

Well, it's the amount of white in a gray color. I was actually transferring an API that is available for UIColor and NSColor to CIColor.

phjs · 2022-08-08T14:46:55Z

Sources/CIColor+Extensions.swift

+    ///
+    /// - Parameters:
+    ///   - white: The unpremultiplied component value that should be use for all three color channels.
+    ///            This value can be of the `[0...1]` SDR range to create an EDR color.


missing outside

phjs · 2022-08-08T14:48:05Z

Sources/CIColor+Extensions.swift

+    ///
+    /// - Parameters:
+    ///   - r: The unpremultiplied red component value.
+    ///        This value can be of the `[0...1]` SDR range to create an EDR color.


same as above (here and below)

phjs · 2022-08-08T14:49:01Z

Sources/CIColor+Extensions.swift

+        self.init(red: r, green: g, blue: b, alpha: a, colorSpace: colorSpace)
+    }
+
+    /// Returns a color that provide a high contrast to the receiver.


phjs · 2022-08-08T15:04:44Z

Sources/CIKernel+MetalSource.swift

+    }
+
+    /// Compiles a Core Image kernel at runtime from the given Metal `source` string.
+    /// If this feature is not supported by the OS, the legacy Core Image Kernel Language `ciklSource` are used instead.


is used instead

maikz · 2022-08-08T14:05:42Z

Sources/CIImage+Transformation.swift

+    /// Returns a new image that represents the original image after moving the center of its extent to the given point.
+    /// - Parameter point: The new center point of the image.
+    /// - Returns: A moved image with the new center point.
+    func centered(in point: CGPoint) -> CIImage {


centered(at point: CGPoint )?

maikz · 2022-08-08T14:08:46Z

Sources/CIColor+Extensions.swift

+    ///   - white: The unpremultiplied component value that should be use for all three color channels.
+    ///            This value can be of the `[0...1]` SDR range to create an EDR color.
+    ///   - alpha: The alpha (opacity) component of the color.
+    convenience init?(extendedWhite white: CGFloat, alpha: CGFloat = 1.0) {


That means we have to know the color's range at build time to call the right init. Would it make sense to use the one above that checks if the passed white is out of the range and uses the extended color space then?

This is only a convenience method that inits the color with a specific color space.
I probably could add checks to the above API, but then I'd need to manipulate the passed color space there. And I can't do the same for the RGB initializers since they are built-in. That's why I decided for more explicit initializers here.

maikz · 2022-08-08T14:12:34Z

Sources/CIColor+Extensions.swift

+    ///
+    /// The returned color is either black or white, depending on which has the better visibility
+    /// when put over the receiver color.
+    var contrastColor: CIColor {


It's not exactly the contrast color but a contrast label color, because the result is only either black or white

I actually had it named like that, but then I figured that you can also use that for icons and other graphics that you'd overlay over an image, so I went for the more generic name. Should I change it back?

maybe something like visibleColor or contrastOverlayColor?

maikz · 2022-08-08T14:13:32Z

Sources/CGColorSpace+Convenience.swift

+public extension CGColorSpace {
+
+    /// The standard Red Green Blue (sRGB) color space.
+    static var sRGBColorSpace: CGColorSpace? { CGColorSpace(name: CGColorSpace.sRGB) }


Why not just call this sRGB (and the others accordingly)?

Because there already exist static properties with those names, but they only refer to the name of the color space, not the color spaces themself (like you see here in the implementation of the property).

maikz · 2022-08-08T14:20:28Z

Sources/CGColorSpace+Convenience.swift

+
+    /// The recommendation of the International Telecommunication Union (ITU) Radiocommunication sector for the BT.2100 color space,
+    /// with the HLG transfer function.
+    @available(iOS 12.6, macCatalyst 13.1, macOS 10.15.6, tvOS 12.0, watchOS 5.0, *)


Maybe mention the fallback to 2020 in the docs.

It's actually not a fallback but a misnaming from Apple that they fixed in later OS versions.

You see, BT.2100 HLG is actually just BT.2020 with the HLG transfer function (instead of the sRGB transfer function). That's probably why they had it named itur_2020_HLG before, but itur_2100_HLG is "more" correct and should cause for less confusion.

Sources/CIImage+Text.swift

maikz · 2022-08-08T14:58:39Z

Sources/CIImage+Transformation.swift

+
+    /// Returns a new image that represents the original image after scaling it by the given factors in x- and y-direction.
+    ///
+    /// The interpolation used for the sampling technique used by the image.


Sources/CIKernel+MetalSource.swift

maikz · 2022-08-08T15:12:35Z

Sources/CIImage+Transformation.swift

+    /// Returns a new image that represents the original image after moving its origin within the working space to the given point.
+    /// - Parameter origin: The new origin point of the image.
+    /// - Returns: A moved image with the new origin.
+    func moved(to origin: CGPoint) -> CIImage {


withOrigin(at: )?

Is moved(to:) too confusing?

Now that I think about it, the by and to help

Sources/CIKernel+MetalSource.swift

frankschlegel added 17 commits August 8, 2022 08:01

Added some useful extensions for applying common transformations to a…

f9a7ff1

…n image.

Added some useful extensions for convenience access to common color s…

9e98d97

…paces.

Added some convenience methods for compositing/blending and colorizin…

e8bffc0

…g images.

Added some convenience methods for rendering text into a CIImage.

475588e

Added some useful extensions to CIColor.

35e0e73

Added helper for creating images with rounded corners.

419986f

Fixed availability checks.

c425905

Added helper for centering an image at a given point.

660d8db

Fixed rounded corner compositing.

ddb2e05

Better luminance threshold for contrast color.

5b0e621

Added APIs for runtime compilation of Metal CIKernels from source sti…

028c6b9

…ngs.

Added tests for new color extensions.

a643d30

Added tests for new image transformation extensions.

f223a4c

Better formula for contrast color.

b9ee0bc

Added tests for Metal kernel runtime compilation.

6bcb555

Updated README with new features.

e9bd393

README formatting fixes.

6cf72a7

frankschlegel requested review from maikz and phjs August 8, 2022 12:36

phjs reviewed Aug 8, 2022

View reviewed changes

maikz requested changes Aug 8, 2022

View reviewed changes

Pull request feedback.

11e8810

maikz approved these changes Aug 9, 2022

View reviewed changes

Renaming: contrastColor → contrastOverlayColor.

640efd5

Fixed typo.

d8d2bfd

phjs approved these changes Aug 9, 2022

View reviewed changes

frankschlegel merged commit 7fc76b9 into main Aug 9, 2022

frankschlegel deleted the more-extensions branch March 15, 2023 07:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

More Extensions #8

More Extensions #8

frankschlegel commented Aug 8, 2022

phjs Aug 8, 2022

phjs Aug 8, 2022

phjs Aug 8, 2022

frankschlegel Aug 9, 2022

phjs Aug 8, 2022

phjs Aug 8, 2022

phjs Aug 8, 2022

phjs Aug 8, 2022

maikz Aug 8, 2022

maikz Aug 8, 2022

frankschlegel Aug 9, 2022

maikz Aug 8, 2022

frankschlegel Aug 9, 2022

maikz Aug 9, 2022

maikz Aug 8, 2022

frankschlegel Aug 9, 2022

maikz Aug 8, 2022

frankschlegel Aug 9, 2022

maikz Aug 8, 2022

maikz Aug 8, 2022

frankschlegel Aug 9, 2022

maikz Aug 9, 2022

More Extensions #8

More Extensions #8

Conversation

frankschlegel commented Aug 8, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment