Merge pull request #8 from yukiny0811/texture3d

3D Texture Support

Author: yukiny0811

Examples/ExampleiOS/ExampleiOS.xcodeproj/xcshareddata/xcschemes/ExampleiOS.xcscheme

@@ -0,0 +1,77 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Scheme
+   LastUpgradeVersion = "1510"
+   version = "1.7">
+   <BuildAction
+      parallelizeBuildables = "YES"
+      buildImplicitDependencies = "YES">
+      <BuildActionEntries>
+         <BuildActionEntry
+            buildForTesting = "YES"
+            buildForRunning = "YES"
+            buildForProfiling = "YES"
+            buildForArchiving = "YES"
+            buildForAnalyzing = "YES">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "56C015652B4D748600E51B4A"
+               BuildableName = "ExampleiOS.app"
+               BlueprintName = "ExampleiOS"
+               ReferencedContainer = "container:ExampleiOS.xcodeproj">
+            </BuildableReference>
+         </BuildActionEntry>
+      </BuildActionEntries>
+   </BuildAction>
+   <TestAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      shouldAutocreateTestPlan = "YES">
+   </TestAction>
+   <LaunchAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      launchStyle = "0"
+      useCustomWorkingDirectory = "NO"
+      ignoresPersistentStateOnLaunch = "NO"
+      debugDocumentVersioning = "YES"
+      debugServiceExtension = "internal"
+      allowLocationSimulation = "YES">
+      <BuildableProductRunnable
+         runnableDebuggingMode = "0">
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "56C015652B4D748600E51B4A"
+            BuildableName = "ExampleiOS.app"
+            BlueprintName = "ExampleiOS"
+            ReferencedContainer = "container:ExampleiOS.xcodeproj">
+         </BuildableReference>
+      </BuildableProductRunnable>
+   </LaunchAction>
+   <ProfileAction
+      buildConfiguration = "Release"
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      savedToolIdentifier = ""
+      useCustomWorkingDirectory = "NO"
+      debugDocumentVersioning = "YES">
+      <BuildableProductRunnable
+         runnableDebuggingMode = "0">
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "56C015652B4D748600E51B4A"
+            BuildableName = "ExampleiOS.app"
+            BlueprintName = "ExampleiOS"
+            ReferencedContainer = "container:ExampleiOS.xcodeproj">
+         </BuildableReference>
+      </BuildableProductRunnable>
+   </ProfileAction>
+   <AnalyzeAction
+      buildConfiguration = "Debug">
+   </AnalyzeAction>
+   <ArchiveAction
+      buildConfiguration = "Release"
+      revealArchiveInOrganizer = "YES">
+   </ArchiveAction>
+</Scheme>

README.md

@@ -236,6 +236,11 @@ class MyRender {
 - simd_float4x4
 - MTLTexture (only 2d texture)
 
+### Supported Platforms
+- macOS 11.0~
+- iOS 14.0~
+- iOS Simulator (render shader only works on physical devices)
+
 ### Custom Pipelines
 
 ```.swift

Sources/EasyMetalShader/Macros/EMComputeShader3D.swift

@@ -0,0 +1,27 @@
+//
+//  File.swift
+//  
+//
+//  Created by Yuki Kuwashima on 2024/01/12.
+//
+
+import Foundation
+
+@attached(
+    extension,
+    conformances: EMMetalComputeFunction,
+    names: named(computePipelineState),
+    named(args),
+    named(init()),
+    named(setup())
+)
+@attached(
+    member,
+    conformances: EMMetalComputeFunction,
+    names: named(computePipelineState),
+    named(args),
+    named(init()),
+    named(setup())
+)
+@attached(memberAttribute)
+public macro EMComputeShader3D() = #externalMacro(module: "EasyMetalShaderMacro", type: "EMComputeShader3D")

Sources/EasyMetalShader/Macros/EMTextureArgument.swift

@@ -5,5 +5,7 @@
 //  Created by Yuki Kuwashima on 2024/01/12.
 //
 
+import MetalKit
+
 @attached(accessor, names: named(didSet))
-public macro EMTextureArgument(_ usage: EMMetalTextureUsage) = #externalMacro(module: "EasyMetalShaderMacro", type: "EMTextureArgument")
+public macro EMTextureArgument(_ usage: EMMetalTextureUsage, _ type: MTLTextureType = .type2D) = #externalMacro(module: "EasyMetalShaderMacro", type: "EMTextureArgument")

Sources/EasyMetalShader/Models/EMMetalArgument.swift

@@ -23,5 +23,6 @@ public enum EMMetalArgument {
     case float3x3(simd_float3x3)
     case float4x4(simd_float4x4)
     case texture2d(MTLTexture!, EMMetalTextureUsage)
+    case texture3d(MTLTexture!, EMMetalTextureUsage)
 
 }

Sources/EasyMetalShader/Models/EMMetalTexture.swift

@@ -19,26 +19,74 @@ public class EMMetalTexture: NSObject {
         self.usage = usage
     }
 
-    public static func create(width: Int, height: Int, pixelFormat: MTLPixelFormat, label: String?) -> MTLTexture {
+    public static func create(width: Int, height: Int, pixelFormat: MTLPixelFormat, label: String?, isRenderTarget: Bool = true) -> MTLTexture {
         let descriptor = MTLTextureDescriptor()
         descriptor.pixelFormat = pixelFormat
         descriptor.textureType = .type2D
         descriptor.width = width
         descriptor.height = height
-        descriptor.usage = [.shaderRead, .shaderWrite, .renderTarget]
+        if isRenderTarget {
+            descriptor.usage = [.shaderRead, .shaderWrite, .renderTarget]
+        } else {
+            descriptor.usage = [.shaderRead, .shaderWrite]
+        }
         descriptor.resourceOptions = .storageModePrivate
         let texture = ShaderCore.device.makeTexture(descriptor: descriptor)!
         texture.label = label
         return texture
     }
 
-    public static func createManaged(width: Int, height: Int, pixelFormat: MTLPixelFormat, label: String?) -> MTLTexture {
+    public static func createManaged(width: Int, height: Int, pixelFormat: MTLPixelFormat, label: String?, isRenderTarget: Bool = true) -> MTLTexture {
         let descriptor = MTLTextureDescriptor()
         descriptor.pixelFormat = pixelFormat
         descriptor.textureType = .type2D
         descriptor.width = width
         descriptor.height = height
-        descriptor.usage = [.shaderRead, .shaderWrite, .renderTarget]
+        if isRenderTarget {
+            descriptor.usage = [.shaderRead, .shaderWrite, .renderTarget]
+        } else {
+            descriptor.usage = [.shaderRead, .shaderWrite]
+        }
+        #if os(macOS)
+        descriptor.resourceOptions = .storageModeManaged
+        #elseif os(iOS)
+        descriptor.resourceOptions = .storageModeShared
+        #endif
+        let texture = ShaderCore.device.makeTexture(descriptor: descriptor)!
+        texture.label = label
+        return texture
+    }
+    
+    public static func create3d(width: Int, height: Int, depth: Int, pixelFormat: MTLPixelFormat, label: String?, isRenderTarget: Bool = true) -> MTLTexture {
+        let descriptor = MTLTextureDescriptor()
+        descriptor.pixelFormat = pixelFormat
+        descriptor.textureType = .type3D
+        descriptor.width = width
+        descriptor.height = height
+        descriptor.depth = depth
+        if isRenderTarget {
+            descriptor.usage = [.shaderRead, .shaderWrite, .renderTarget]
+        } else {
+            descriptor.usage = [.shaderRead, .shaderWrite]
+        }
+        descriptor.resourceOptions = .storageModePrivate
+        let texture = ShaderCore.device.makeTexture(descriptor: descriptor)!
+        texture.label = label
+        return texture
+    }
+    
+    public static func createManaged3d(width: Int, height: Int, depth: Int, pixelFormat: MTLPixelFormat, label: String?, isRenderTarget: Bool = true) -> MTLTexture {
+        let descriptor = MTLTextureDescriptor()
+        descriptor.pixelFormat = pixelFormat
+        descriptor.textureType = .type3D
+        descriptor.width = width
+        descriptor.height = height
+        descriptor.depth = depth
+        if isRenderTarget {
+            descriptor.usage = [.shaderRead, .shaderWrite, .renderTarget]
+        } else {
+            descriptor.usage = [.shaderRead, .shaderWrite]
+        }
         #if os(macOS)
         descriptor.resourceOptions = .storageModeManaged
         #elseif os(iOS)

Sources/EasyMetalShader/Pipelines/EMMetalComputeFunction.swift

@@ -74,6 +74,8 @@ extension EMMetalComputeFunction {
                 encoder.setBytes([value], length: MemoryLayout<simd_float4x4>.stride, index: i+1)
             case .texture2d(let value, _):
                 encoder.setTexture(value, index: i+1)
+            case .texture3d(let value, _):
+                encoder.setTexture(value, index: i+1)
             case .none:
                 break
             }

Sources/EasyMetalShader/Pipelines/EMMetalRenderFunction.swift

@@ -75,6 +75,9 @@ extension EMMetalRenderFunction {
             case .texture2d(let value, _):
                 encoder.setVertexTexture(value, index: i+1)
                 encoder.setFragmentTexture(value, index: i+1)
+            case .texture3d(let value, _):
+                encoder.setVertexTexture(value, index: i+1)
+                encoder.setFragmentTexture(value, index: i+1)
             case .none:
                 break
             }

Sources/EasyMetalShaderMacro/EMComputeShader/ComputeFunctionStrings/InitCompute.swift

@@ -8,7 +8,7 @@
 import Foundation
 
 extension ComputeFunctionStrings {
-    static func initFunc(variableInitStrings: [String]) -> String {
+    static func initFunc(variableInitStrings: [String], gidTypeString: String) -> String {
 """
 public func setup() {
 """
@@ -61,12 +61,23 @@ public func setup() {
             case .sample:
                 functionImpl += "texture2d<float, access::sample> \\(key) [[texture(\\(i+1))]]"
             }
+        case .texture3d(_, let usage):
+            switch usage {
+            case .read:
+                functionImpl += "texture3d<float, access::read> \\(key) [[texture(\\(i+1))]]"
+            case .write:
+                functionImpl += "texture3d<float, access::write> \\(key) [[texture(\\(i+1))]]"
+            case .read_write:
+                functionImpl += "texture3d<float, access::read_write> \\(key) [[texture(\\(i+1))]]"
+            case .sample:
+                functionImpl += "texture3d<float, access::sample> \\(key) [[texture(\\(i+1))]]"
+            }
         case .none:
             break
         }
         functionImpl += ","
     }
-    functionImpl += "ushort2 gid [[thread_position_in_grid]]"
+    functionImpl += "\(gidTypeString) gid [[thread_position_in_grid]]"
     functionImpl += "){"
 
     for key in args.keys {
@@ -97,6 +108,8 @@ public func setup() {
             functionImpl += "float4x4 \\(key) = \\(key)_buf[0];"
         case .texture2d(_, _):
             break
+        case .texture3d(_, _):
+            break
         case .none:
             break
         }

Sources/EasyMetalShaderMacro/EMComputeShader/EMComputeShader+MemberAttributeMacro.swift

@@ -63,7 +63,7 @@ extension EMComputeShader: MemberAttributeMacro {
             return [
                 AttributeSyntax(
                     attributeName: IdentifierTypeSyntax(
-                        name: .identifier("EMTextureArgument(.read_write)")
+                        name: .identifier("EMTextureArgument(.read_write, .type2D)")
                     )
                 )
             ]

Sources/EasyMetalShaderMacro/EMComputeShader/EMComputeShader+MemberMacro.swift

@@ -56,21 +56,28 @@ extension EMComputeShader: MemberMacro {
                     if let type = binding.typeAnnotation?.type {
                         if type.trimmedDescription == "MTLTexture?" {
                             var usage: String? = nil
+                            var format: String? = nil
                             for element in variableDecl.attributes {
                                 if let attribute = element.as(AttributeSyntax.self) {
                                     if attribute.attributeName.trimmedDescription == "EMTextureArgument" {
-                                        if let args = attribute.arguments {
-                                            usage = args.trimmedDescription
+                                        if let args = attribute.arguments?.as(LabeledExprListSyntax.self) {
+                                            usage = args.first?.as(LabeledExprSyntax.self)?.expression.as(MemberAccessExprSyntax.self)?.declName.baseName.trimmedDescription
+                                            if args.count >= 2 {
+                                                format = args[args.index(args.startIndex, offsetBy: 1)].as(LabeledExprSyntax.self)?.expression.as(
+                                                    MemberAccessExprSyntax.self
+                                                )?.declName.baseName.trimmedDescription
+                                            }
                                         }
+                                        
                                     }
                                 }
                             }
                             if let usage {
-                                if let setString = Util.textureTypeToArgumentString(textureType: type.trimmedDescription, variableName: variableName, usage: usage) {
+                                if let setString = Util.textureTypeToArgumentString(textureType: type.trimmedDescription, variableName: variableName, usage: usage, format: format) {
                                     initStringList.append("args[\"\(variableName)\"] = \(setString)")
                                 }
                             } else {
-                                if let setString = Util.textureTypeToArgumentString(textureType: type.trimmedDescription, variableName: variableName, usage: ".read_write") {
+                                if let setString = Util.textureTypeToArgumentString(textureType: type.trimmedDescription, variableName: variableName, usage: "read_write", format: format) {
                                     initStringList.append("args[\"\(variableName)\"] = \(setString)")
                                 }
                             }
@@ -126,7 +133,7 @@ extension EMComputeShader: MemberMacro {
         var args: [String: EMMetalArgument] = [:]
         """
 
-        let thisDecl3: DeclSyntax = .init(stringLiteral: ComputeFunctionStrings.initFunc(variableInitStrings: initStringList))
+        let thisDecl3: DeclSyntax = .init(stringLiteral: ComputeFunctionStrings.initFunc(variableInitStrings: initStringList, gidTypeString: "ushort2"))
 
 
         var thisDecl4: DeclSyntax = ""

Sources/EasyMetalShaderMacro/EMComputeShader3D/ComputeFunctionStrings3D/ComputeFunctionStrings3D.swift

@@ -0,0 +1,10 @@
+//
+//  File.swift
+//  
+//
+//  Created by Yuki Kuwashima on 2024/01/12.
+//
+
+import Foundation
+
+enum ComputeFunctionStrings3D {}