Swift включает металлический шейдер в библиотеку [Используя менеджер пакетов Swift]

В Xcode 12 (swift-tools-version:5.3) файл .metal можно использовать из пакета Swift с помощью метода MTLDevice.makeDefaultLibrary(bundle:).

Пакет Swift должен иметь структуру, похожую на:

-Sources
    -MetalShaders
        -MetalShaders.metal
        -MetalShaders.swift
-Tests
    -MetalShadersTests
        -MetalShadersTests.swift

Файл MetalShaders.metal должен содержать исходный код Metal, а файл MetalShaders.swift должен содержать необходимый код установки. Одним из примеров начального содержимого MetalShaders.swift является следующее:

// A metal device for access to the GPU.
public var metalDevice: MTLDevice!

// A metal library.
public var packageMetalLibrary: MTLLibrary!

// Function to perform the initial setup for Metal processing on the GPU
public func setupMetal() {
    // Create metal device for the default GPU:
    metalDevice = MTLCreateSystemDefaultDevice()
    
    // Create the library of metal functions
    // Note: Need to use makeDefaultLibrary(bundle:) as the "normal"
    //       call makeDefaultLibrary() returns nil.
    packageMetalLibrary = try? metalDevice.makeDefaultLibrary(bundle: Bundle.module)

    // List the available Metal shader functions
    print(packageMetalLibrary.functionNames)

    //
    // ... add additional setup code here ...
    // 

}

При таком подходе к переменной packageMetalLibrary можно получить доступ из проекта Xcode, который зависит от пакета Swift, путем импорта цели из пакета swift таким же образом, как импортируются другие платформы или пакеты.

import MetalShaders

Возможно, этот подход можно использовать с более ранними версиями Xcode, поскольку метод MTLDevice.makeDefaultLibrary(bundle:) доступен, начиная с iOS 10/macOS 10.12, но необходимо реализовать расширение Bundle.module, и неясно, будет ли это работать.

Поместите файл Shaders.metal в каталог Metal. Затем добавьте ресурсы к вашей цели в Package.swift

.target(
   name: "TargetName",
   dependencies: [
     .product(name: "AnotherModule", package: "AnotherPackage")
   ],
   resources: [
     .copy("Metal/")
   ]
)

Теперь вы можете получить доступ к своей библиотеке:

let url = Bundle.module.url(forResource: "Shaders", withExtension: "metal", subdirectory: "Metal")!
let source = try String(contentsOf: url)
let library = try device.makeLibrary(source: source, options: nil)

Или даже лучше (но только для одного файла шейдера):

.target(
   name: "TargetName",
   dependencies: [
     .product(name: "AnotherModule", package: "AnotherPackage")
   ],
   resources: [
     .process("Metal/Shaders.metal")
   ]
)

Теперь вы можете получить доступ к своей библиотеке:

let library = try device.makeDefaultLibrary(bundle: Bundle.module)

let source = """

    #include <metal_stdlib>
    using namespace metal;

    struct Vertex {...
"""
let library = try device.makeLibrary(source: source options: nil)
print(library.functionNames)

Класс Metal позволяет создавать библиотеку шейдеров из String во время выполнения. https://developer.apple.com/documentation/metal/libraries Надеюсь, это поможет .

Кажется, что сейчас это невозможно сделать. Я обновлю это, когда найду обходной путь или Apple решит эту проблему.

https://bugs.swift.org/browse/SR-2866

Редактировать: временным решением, которое я нашел, было создание скрипта bash которые редактируют настройки рабочей области, чтобы изменить путь сборки, а затем скомпилировать/скопировать файл metallib в исполняемый путь (еще не пробовал, чтобы увидеть, как работает распространение библиотеки через SPM или что-то в этом роде, сейчас работает только с кодом в той же папке (т.е. Sources/MyEngine ‹- (эта папка содержит шейдер металла), Sources/MyGame).