关于 swift：在 Swift3 中使用带有 CGPattern 的回调时出现问题


Trouble using callbacks with CGPattern in Swift3

我正在尝试在 Swift 中使用 CGPattern 创建彩色图案。 Apple 在 Quartz 2D Programming Guide 的绘制彩色图案部分提供了一个很好的 Objective-C 示例。但是从 Objective-C 转换所有这些语法并不是直截了当的。另外，我想在绘图回调中使用 info 参数，并且没有这样做的示例。

这是我的第一次尝试：

1
2
3
4
5
6
7
8
9
10
11
class SomeShape {
    func createPattern() -> CGPattern? {
        let bounds = CGRect(x: 0, y: 0, width: someWidth, height: someHeight)
        let matrix = CGAffineTransform.identity
        var callbacks = CGPatternCallbacks(version: 0, drawPattern: nil, releaseInfo: nil)

        let res = CGPattern(info: nil, bounds: bounds, matrix: matrix, xStep: bounds.width, yStep: bounds.height, tiling: .noDistortion, isColored: true, callbacks: &callbacks)

        return res
    }
}

显然，这需要为 CGPatternCallbacks 的 drawPattern 参数设置一个合适的值，并且我需要将 self 作为 info 参数传递给 CGPattern 初始化程序。

完成这个的正确语法是什么？

相关讨论

正如您在回答中所说，CGPatternDrawPatternCallback 定义为：

1
2
typealias CGPatternDrawPatternCallback =
                               @convention(c) (UnsafeMutableRawPointer?, CGContext) -> Void

@convention(c) 属性(仅出现在生成的标头中)意味着使用的函数值必须与 C 兼容，因此无法捕获任何上下文(因为 C 函数值只不过是指向一个函数，并且不存储额外的上下文对象)。

所以如果你想在函数中有可用的上下文，你需要将你自己的UnsafeMutableRawPointer?传递给CGPattern的初始化器的info:参数。然后，这将在被调用时作为给定绘图模式函数的第一个参数传递。

为了将self传递给这个参数，你可以使用Unmanaged。这允许您在引用和不透明指针之间进行转换，并且与 unsafeBitCast 不同，还允许您在执行此操作时控制引用的内存管理。

鉴于我们不能保证 createPattern() 的调用者会保留 self，我们不能只将它传递给 info: 参数而不自己保留它。如果它在没有保留的情况下被传递(例如使用 unsafeBitCast)，然后在绘制模式之前被释放 - 当您尝试在绘图回调中使用悬空指针时，您将获得未定义的行为。

使用 Unmanaged:

  • 您可以使用 passRetained(_:).toOpaque()

    将引用作为 1 保留的不透明指针传递

  • 您可以使用 fromOpaque(_:).takeUnretainedValue() 从此指针取回引用(并且实例将保持保留)

  • 然后您可以使用 fromOpaque(_:).release() 使用 1 保留。当 CGPattern 被释放时，你会想要这样做。

例如：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
class SomeShape {
    // the bounds of the shape to draw
    let bounds = CGRect(x: 0, y: 0, width: 40, height: 40)

    func createPattern() -> CGPattern? {

        var callbacks = CGPatternCallbacks(version: 0, drawPattern: { info, ctx in

            // cast the opaque pointer back to a SomeShape reference.
            let shape = Unmanaged<SomeShape>.fromOpaque(info!).takeUnretainedValue()

            // The code to draw a single tile of the pattern into"ctx"...
            // (in this case, two vertical strips)
            ctx.saveGState()
            ctx.setFillColor(UIColor.red.cgColor)
            ctx.fill(CGRect(x: 0, y: 0,
                            width: shape.bounds.width / 2, height: shape.bounds.height))

            ctx.setFillColor(UIColor.blue.cgColor)
            ctx.fill(CGRect(x: 20, y: 0,
                            width: shape.bounds.width / 2, height: shape.bounds.height))
            ctx.restoreGState()

        }, releaseInfo: { info in
            // when the CGPattern is freed, release the info reference,
            // consuming the +1 retain when we originally passed it to the CGPattern.
            Unmanaged<SomeShape>.fromOpaque(info!).release()
        })

        // retain self before passing it off to the info: parameter as an opaque pointer.
        let unsafeSelf = Unmanaged.passRetained(self).toOpaque()

        return CGPattern(info: unsafeSelf, bounds: bounds, matrix: .identity,
                         xStep: bounds.width, yStep: bounds.height,
                         tiling: .noDistortion, isColored: true, callbacks: &callbacks)
    }
}

或者，如果您想要 SomeShape 的值语义，一个更好的解决方案，您可以将其设为 struct。然后在创建模式时，您可以将其package在 Context 堆分配的盒子中，然后将其传递给 info: 参数：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
struct SomeShape {

    // the bounds of the shape to draw
    let bounds = CGRect(x: 0, y: 0, width: 40, height: 40)

    func createPattern() -> CGPattern? {

        final class Context {
            let shape: SomeShape
            init(_ shape: SomeShape) { self.shape = shape }
        }

        var callbacks = CGPatternCallbacks(version: 0, drawPattern: { info, ctx in

            // cast the opaque pointer back to a Context reference,
            // and get the wrapped shape instance.
            let shape = Unmanaged<Context>.fromOpaque(info!).takeUnretainedValue().shape

            // ...

        }, releaseInfo: { info in
            // when the CGPattern is freed, release the info reference,
            // consuming the +1 retain when we originally passed it to the CGPattern.
            Unmanaged<Context>.fromOpaque(info!).release()
        })

        // wrap self in our Context box before passing it off to the info: parameter as a
        // +1 retained opaque pointer.
        let unsafeSelf = Unmanaged.passRetained(Context(self)).toOpaque()

        return CGPattern(info: unsafeSelf, bounds: bounds, matrix: .identity,
                         xStep: bounds.width, yStep: bounds.height,
                         tiling: .noDistortion, isColored: true, callbacks: &callbacks)
    }
}

现在这也解决了任何保留周期问题。

相关讨论

让我们从 CGPatternDrawPatternCallback 开始。定义为：

1
typealias CGPatternDrawPatternCallback = (UnsafeMutableRawPointer?, CGContext) -> Void

所以它是一个带有两个参数的闭包 - info 和绘图上下文。

使用该信息，您可以按如下方式创建 CGPatternCallback：

1
2
3
4
5
var callbacks = CGPatternCallbacks(version: 0, drawPattern: { (info, ctx) in
    // Drawing code here
}, releaseInfo: { (info) in {
    // Cleanup code here
})

但是这里有一些重要的事情需要注意。这些闭包的主体不能捕获块之外的任何东西。如果您尝试这样做，您将收到以下错误：

A C function point cannot be formed from a closure that captures context

这就是为什么需要使用 info 参数的原因。您可以在创建模式时将 self 或其他一些对象作为 info 参数传递，并在绘图回调中使用它。但这不是一项简单的任务，因为您不能简单地将 self 作为 info 参数传递。您需要将其转换为所需的 UnsafeMutableRawPointer ，然后将其从绘图回调中的指针转换回来。

这里是所有设置的完整代码：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
class SomeShape {
    func createPattern() -> CGPattern? {
        let bounds = CGRect(x: 0, y: 0, width: someWidth, height: someHeight) // The size of each tile in the pattern
        let matrix = CGAffineTransform.identity // adjust as needed
        var callbacks = CGPatternCallbacks(version: 0, drawPattern: { (info, ctx) in
            let shape = unsafeBitCast(info, to: SomeShape.self)

            // The needed drawing code to draw one tile of the pattern into"ctx"
        }, releaseInfo: { (info) in
            // Any cleanup if needed
        })

        let unsafeSelf = unsafeBitCast(self, to: UnsafeMutableRawPointer.self)

        let res = CGPattern(info: unsafeSelf, bounds: bounds, matrix: matrix, xStep: bounds.width, yStep: bounds.height, tiling: .noDistortion, isColored: true, callbacks: &callbacks)

        return res
    }
}

要使用 CGPattern，你可以这样做：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
func draw(_ ctx: CGContext) {
    // Any other needed setup

    let path = CGPath(....) // some path

    // Code to fill a path with the pattern
    ctx.saveGState()
    ctx.addPath(path) // The path to fill

    // Setup the pattern color space for the colored pattern
    if let cs = CGColorSpace(patternBaseSpace: nil) {
        ctx.setFillColorSpace(cs)
    }

    // Create and apply the pattern and its opacity
    if let fillPattern = someShapeInstance.createPattern() {
        var fillOpacity = CGFloat(1.0)
        ctx.setFillPattern(fillPattern, colorComponents: &strokeOpacity)
    }

    ctx.fillPath(using: theDesiredFillRule)
    ctx.restoreGState()

    // Any other drawing
}

当使用彩色图案(相对于模板、非彩色图案)时，您必须在设置填充图案之前设置填充颜色空间。

您还可以使用图案来描边路径。只需使用 setStrokeColorSpace 和 setStrokePattern.

相关讨论