Use updated CADisplayLink API for macOS 14+

Adds support for the updated `CADisplayLink` API available on macOS 14+, which allows for setting preferred fps / frame rate range. This also moves the `DisplayLinkProxy` into a protocol with concrete types for all platforms.

## Changes

- [ ] Update `DisplayLinkProxy` to `RiveDisplayLink` protocol
  - Replace usage of proxy with new protocol
- [ ] On macOS 14+, use `CADisplayLink`
  - Additionally adds support for preferred fps / frame rate range

## Notes

While this is not "breaking", it appropriately changes the availability of some setters to match the API availability of the display link used. Some developers may find that there are errors - for example, setting FPS was unavailable on macOS, since `CVDisplayLink` didn't support it. Instead of no-oping, this function is now unavailable if the OS doesn't support it.

Diffs=
34820199f2 Use updated CADisplayLink API for macOS 14+ (#8899)

Co-authored-by: David Skuza <david@rive.app>

Author: dskuza

.rive_head

@@ -1 +1 @@
-63642c62d46f41939545609dd151b68d0f4f67fe
+34820199f2bb9bee7b4e9d7284cbbd89a2816808

RiveRuntime.xcodeproj/project.pbxproj

@@ -96,6 +96,7 @@
 		F21F08142C66526D00FFA205 /* RiveFallbackFontDescriptor.swift in Sources */ = {isa = PBXBuildFile; fileRef = F21F08132C66526D00FFA205 /* RiveFallbackFontDescriptor.swift */; };
 		F23626AA2C8F90FA00727D9A /* nested_text_run.riv in Resources */ = {isa = PBXBuildFile; fileRef = F23626A92C8F90FA00727D9A /* nested_text_run.riv */; };
 		F23992E72CB9C1C60021EF61 /* RenderContextTests.m in Sources */ = {isa = PBXBuildFile; fileRef = F23992E62CB9C1C60021EF61 /* RenderContextTests.m */; };
+		F23B2B802D2DCD70007AA53E /* RiveDisplayLink.swift in Sources */ = {isa = PBXBuildFile; fileRef = F23B2B7F2D2DCD70007AA53E /* RiveDisplayLink.swift */; };
 		F2610DD22CA5B4C40090D50B /* RiveLogger+StateMachine.swift in Sources */ = {isa = PBXBuildFile; fileRef = F2610DD12CA5B4C40090D50B /* RiveLogger+StateMachine.swift */; };
 		F2610DD42CA5B5460090D50B /* RiveLogger+Artboard.swift in Sources */ = {isa = PBXBuildFile; fileRef = F2610DD32CA5B5460090D50B /* RiveLogger+Artboard.swift */; };
 		F2610DD62CA5B5DD0090D50B /* RiveLogger+ViewModel.swift in Sources */ = {isa = PBXBuildFile; fileRef = F2610DD52CA5B5DD0090D50B /* RiveLogger+ViewModel.swift */; };
@@ -217,6 +218,7 @@
 		F21F08132C66526D00FFA205 /* RiveFallbackFontDescriptor.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = RiveFallbackFontDescriptor.swift; sourceTree = "<group>"; };
 		F23626A92C8F90FA00727D9A /* nested_text_run.riv */ = {isa = PBXFileReference; lastKnownFileType = file; path = nested_text_run.riv; sourceTree = "<group>"; };
 		F23992E62CB9C1C60021EF61 /* RenderContextTests.m */ = {isa = PBXFileReference; explicitFileType = sourcecode.cpp.objcpp; path = RenderContextTests.m; sourceTree = "<group>"; };
+		F23B2B7F2D2DCD70007AA53E /* RiveDisplayLink.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = RiveDisplayLink.swift; sourceTree = "<group>"; };
 		F2610DD12CA5B4C40090D50B /* RiveLogger+StateMachine.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "RiveLogger+StateMachine.swift"; sourceTree = "<group>"; };
 		F2610DD32CA5B5460090D50B /* RiveLogger+Artboard.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "RiveLogger+Artboard.swift"; sourceTree = "<group>"; };
 		F2610DD52CA5B5DD0090D50B /* RiveLogger+ViewModel.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "RiveLogger+ViewModel.swift"; sourceTree = "<group>"; };
@@ -401,6 +403,7 @@
 				C3468E5727EB9887008652FD /* RiveView.swift */,
 				C3468E5927ECC7C6008652FD /* RiveViewModel.swift */,
 				C3468E5B27ED4C41008652FD /* RiveModel.swift */,
+				F23B2B7F2D2DCD70007AA53E /* RiveDisplayLink.swift */,
 				F21F08152C66527B00FFA205 /* Fonts */,
 				C9BD3927263B64B100696C37 /* Renderer */,
 				C3468E5627EB9858008652FD /* Utils */,
@@ -650,6 +653,7 @@
 				046FB7F5264EAA60000129B1 /* RiveSMIInput.mm in Sources */,
 				043026002AFA915B00320F2E /* RiveFileAsset.mm in Sources */,
 				F2FD94042CC9492B00C1FC85 /* RiveFont.m in Sources */,
+				F23B2B802D2DCD70007AA53E /* RiveDisplayLink.swift in Sources */,
 				C3468E5A27ECC7C6008652FD /* RiveViewModel.swift in Sources */,
 				C3745FD3282BFAB90087F4AF /* FPSCounterView.swift in Sources */,
 				F2ECC2312C666824008B20E5 /* RiveFallbackFontDescriptor+Extensions.swift in Sources */,

Source/Renderer/include/rive_renderer_view.hh

@@ -18,6 +18,8 @@ NS_ASSUME_NONNULL_BEGIN
 
 @interface RiveRendererView : RiveMTKView
 
+@property(nullable, nonatomic, strong) id<CAMetalDrawable>currentDrawableOverride;
+
 - (instancetype)initWithFrame:(CGRect)frameRect;
 /// Deprecated. Use `alignWithRect:contentRect:alignment:fit:scaleFactor:` instead.
 /// This is equivalent to calling the new function with a scale factor of 1.

Source/Renderer/rive_renderer_view.mm

@@ -349,7 +349,7 @@ - (void)drawInRect:(CGRect)rect
         return;
     }
 
-    if (![[self currentDrawable] texture])
+    if (!self.currentDrawable.texture)
     {
         return;
     }

Source/RiveDisplayLink.swift

@@ -0,0 +1,180 @@
+//
+//  RiveDisplayLink.swift
+//  RiveRuntime
+//
+//  Created by David Skuza on 1/7/25.
+//  Copyright © 2025 Rive. All rights reserved.
+//
+
+import Foundation
+
+protocol RiveDisplayLink {
+    var isPaused: Bool { get set }
+    var targetTimestamp: TimeInterval? { get }
+
+    func set(preferredFramesPerSecond: Int) -> Void
+
+    @available(iOS 15, macOS 14, tvOS 15, visionOS 1, *)
+    func set(preferredFrameRateRange: CAFrameRateRange) -> Void
+
+    func start()
+    func stop()
+}
+
+#if !os(macOS)
+class RiveCADisplayLink: RiveDisplayLink {
+    typealias Tick = () -> Void
+
+    private lazy var displayLink: CADisplayLink = {
+        return CADisplayLink(target: self, selector: #selector(_tick))
+    }()
+
+    var isPaused: Bool {
+        get { displayLink.isPaused }
+        set { displayLink.isPaused = newValue }
+    }
+
+    var targetTimestamp: TimeInterval? {
+        displayLink.targetTimestamp
+    }
+
+    private let tick: Tick
+    private var isActive = false
+
+    init(tick: @escaping () -> Void) {
+        self.tick = tick
+    }
+
+    deinit {
+        displayLink.invalidate()
+    }
+
+    func set(preferredFramesPerSecond fps: Int) {
+        if #available(iOS 15, tvOS 15, visionOS 1, *) {
+            let range = CAFrameRateRange(minimum: Float(fps), maximum: Float(fps), preferred: Float(fps))
+            displayLink.preferredFrameRateRange = range
+        } else {
+            displayLink.preferredFramesPerSecond = fps
+        }
+    }
+
+    @available(iOS 15, tvOS 15, visionOS 1, *)
+    func set(preferredFrameRateRange range: CAFrameRateRange) {
+        displayLink.preferredFrameRateRange = range
+    }
+
+    func start() {
+        guard isActive == false else { return }
+        displayLink.add(to: .main, forMode: .common)
+        isActive = true
+    }
+
+    func stop() {
+        guard isActive == true else { return }
+        displayLink.invalidate()
+        isActive = false
+    }
+
+    @objc private func _tick() {
+        tick()
+    }
+}
+#else
+@available(macOS 14, *)
+class RiveCADisplayLink: RiveDisplayLink {
+    typealias Tick = () -> Void
+
+    private let view: NSView
+
+    private lazy var displayLink: CADisplayLink = {
+        return view.displayLink(target: self, selector: #selector(_tick))
+    }()
+
+    var isPaused: Bool {
+        get { displayLink.isPaused }
+        set { displayLink.isPaused = newValue }
+    }
+
+    var targetTimestamp: TimeInterval? {
+        displayLink.targetTimestamp
+    }
+
+    private let tick: Tick
+    private var isActive = false
+
+    init(view: NSView, tick: @escaping Tick) {
+        self.view = view
+        self.tick = tick
+    }
+
+    deinit {
+        displayLink.invalidate()
+    }
+
+    func set(preferredFramesPerSecond fps: Int) {
+        let range = CAFrameRateRange(minimum: Float(fps), maximum: Float(fps), preferred: Float(fps))
+        displayLink.preferredFrameRateRange = range
+    }
+
+    func set(preferredFrameRateRange range: CAFrameRateRange) {
+        displayLink.preferredFrameRateRange = range
+    }
+
+    func start() {
+        guard isActive == false else { return }
+        displayLink.add(to: .main, forMode: .common)
+        isActive = true
+    }
+
+    func stop() {
+        guard isActive == true else { return }
+        displayLink.invalidate()
+        isActive = false
+    }
+
+    @objc private func _tick() {
+        tick()
+    }
+}
+
+class RiveCVDisplaySync: RiveDisplayLink {
+    typealias Tick = () -> Void
+    
+    private let tick: Tick
+    
+    private var displayLink: CVDisplayLink?
+
+    var isPaused: Bool = false
+
+    let targetTimestamp: TimeInterval? = nil
+
+    init(tick: @escaping Tick) {
+        self.tick = tick
+    }
+
+    func set(preferredFramesPerSecond: Int) { }
+
+    func set(preferredFrameRateRange: CAFrameRateRange) { }
+
+    func start() {
+        guard displayLink == nil else { return }
+        
+        let result = CVDisplayLinkCreateWithActiveCGDisplays(&displayLink)
+        guard result == kCVReturnSuccess, let displayLink else { return }
+
+        CVDisplayLinkSetOutputHandler(displayLink) { _, _, _, _, _ in
+            DispatchQueue.main.async { [weak self] in
+                self?.tick()
+            }
+            return kCVReturnSuccess
+        }
+        CVDisplayLinkStart(displayLink)
+    }
+
+    func stop() {
+        guard let displayLink else { return }
+        CVDisplayLinkStop(displayLink)
+        self.displayLink = nil
+    }
+}
+#endif