https://github.com/dehesa/sample-metal

Examples for Apple's Metal APIs (rendering and compute).
https://github.com/dehesa/sample-metal

apple metal shaders swift xcode

Last synced: about 4 hours ago
JSON representation

Examples for Apple's Metal APIs (rendering and compute).

• Host: GitHub
• URL: https://github.com/dehesa/sample-metal
• Owner: dehesa
• License: mit
• Created: 2017-08-18T23:54:58.000Z (about 7 years ago)
• Default Branch: main
• Last Pushed: 2024-05-07T19:29:16.000Z (6 months ago)
• Last Synced: 2024-11-09T20:52:07.975Z (8 days ago)
• Topics: apple, metal, shaders, swift, xcode
• Language: Swift
• Homepage:
• Size: 4.84 MB
• Stars: 269
• Watchers: 13
• Forks: 21
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


   





    

    

    

    



This repo contains code with examples on how to use Apple's Metal GPU APIs. Some sample code has been created entirely by [me](https://github.com/dehesa), while others have been picked from Github. The latter ones are in this repo because they have been heavily modified, not only to support the latest version of Swift and SwiftUI, but also to add support to macOS, iOS, and tvOS. Links to the source Github repos or websites are provided.

## Projects

-   Playgrounds.

    - Memory size, stride, and alignment.

    - `MTKView` as a Playground live view.

-   Command-Line apps.

    


    GPU Inspector.


    Prints on `stdout` a brief description of all your available GPUs. For example:

    ```

    Apple M1 Max

      Built-in GPU

      Unified memory (shared with CPU)

        max recommended working set: 48 GB

      Feature set support

        family: apple 1, apple 2, apple 3, apple 4, apple 5, apple 6, apple 7, metal 3

      General Purpose Computing

        max threadgroup memory: 32 kB

        max threads per threadgroup: [1024, 1024, 1024]

        threads execution width: 32

    

    Intel(R) HD Graphics 530

      Built-in GPU (low power)

      Unified memory (shared with CPU)

        max recommended working set: 1.61 GB

      Feature set support

        family: common 1, common 2, common 3, apple 1, apple 2, apple 3, apple 4

      General Purpose Computing

        max threadgroup memory: 64 KB

        max threads per threadgroup: [1024, 1024, 1024]

        threads execution width: 32

    AMD Radeon Pro 460

      Built-in GPU

      Discrete memory

        max recommended working set: 4.29 GB

      Feature set support

        family: common 1, common 2, common 3, apple 1, apple 2, apple 3, apple 4

      General Purpose Computing

        max threadgroup memory: 64 KB

        max threads per threadgroup: [1024, 1024, 1024]

        threads execution width: 64

    ```

    

    Gray converter.


    

    Transform an image into its gray-scale version.

    

    This command-line utitily expects a single argument indicating the location of the image to transform and outputs the gray scale version to the `~/Desktop` with name `out.png`.

    You can run it from Xcode by pressing ⌘ + R. This project scheme has an argument where you can specify a different image from the default image.

    This utility is based on [Safx](https://github.com/safx)' gray converter [compute sample](https://github.com/safx/Metal-CommandLine-Sample-Swift).

    

    


-   [Apple's sample code](https://developer.apple.com/metal/sample-code).

    Basic Tessellation.


    [This sample](https://developer.apple.com/library/content/samplecode/MetalBasicTessellation/Introduction/Intro.html) shows how to tessellate a triangle or quad patch with adjustable per-patch tessellation factors.

    


        

    


-   [Metal by Example](https://metalbyexample.com).

    
[Warren Moore](https://warrenmoore.net) wrote this book in 2015. It was and it remains one of the best introductions to Metal I have found.

    I've migrated most chapters to the latest Swift and I've added support to macOS.

    - Clear Screen.

    - Draw 2D triangle.

    - Draw spinning 3D cube.

    - Draw spinning _teapot_ with manual lighting.

    - Draw spinning _cow_ with manual lighting and custom texture.

-   [**Shader Exam**](https://github.com/leon196/SIGExam).

    
[Leon Denise](http://leon196.github.io) wrote a [tweet](https://twitter.com/leondenise/status/953716696161882114) with a typical shader exam he gives to his students on [SupInfo.com](https://rubika-edu.com).

    -   [Page 1](Shader%20Exam/Exam/Page1.png):

        [pass](Shader%20Exam/Page%201/SecondPass.metal#L35),

        [mirror](Shader%20Exam/Page%201/SecondPass.metal#L47),

        [symmetry](Shader%20Exam/Page%201/SecondPass.metal#L57),

        [rotation](Shader%20Exam/Page%201/SecondPass.metal#L67),

        [zoom](Shader%20Exam/Page%201/SecondPass.metal#L91),

        [zoomDistortion](Shader%20Exam/Page%201/SecondPass.metal#L103),

        [repetition](Shader%20Exam/Page%201/SecondPass.metal#L116),

        [spiral](Shader%20Exam/Page%201/SecondPass.metal#L128),

        [thunder](Shader%20Exam/Page%201/SecondPass.metal#L145).

    -   [Page 2](Shader%20Exam/Exam/Page2.png): clamp, pli, color direction, pixelated, vague, column, crash, scanline, double frequency.

    -   [Page 3](Shader%20Exam/Exam/Page3.png): black & white, threshold, thresholds, sonar, grill, stamp, local negative, chromatic aberration, chroma key

    -   [Page 4](Shader%20Exam/Exam/Page4.png): vague, chubby, skinny, twist, glitch, voxel glitch, basic shading, toon shading, cell shading

    -   [Page 5](Shader%20Exam/Exam/Page5.png): sphere, sphere repeat, pyramid, polar module, tube twist, tube web, volumetric cloud, strangler fig, kirby