Prism

A lightweight 3D renderer for SwiftUI.

• Works with any SwiftUI View.
• Fully interactive and animatable.
• Compatible with all SwiftUI modifiers.
• No positioning side effects, unlike GeometryReader.
• 100% SwiftUI — no SceneKit, SpriteKit, etc.
• Powered by perspective transforms, so it's fast.
• Supports sizing, extrusion, levitation, and more.
• Compose complex scenes with a familiar API.

Installation

Requires iOS 13+ or macOS Catalina and up. Prism can be installed through the Swift Package Manager.

https://github.com/aheze/Prism

Usage

Prism is designed to be easy to use. First, define a PrismConfiguration for customization. Then add a PrismCanvas, which can contain as many PrismViews as you'd like.

struct ContentView: View {
    @State var configuration = PrismConfiguration(
        tilt: 0.5, /// A value from 0 to 1, representing the perspective.
        size: CGSize(width: 200, height: 200), /// How big the prism is.
        extrusion: 100, /// The z height.
        levitation: 20, /// How far the prism is from the ground.
        shadowColor: Color.black, /// A dynamic shadow that's rendered underneath the prism.
        shadowOpacity: 0.25 /// The strength of the shadow.
    )

    var body: some View {
        PrismCanvas(tilt: configuration.tilt) {
            PrismView(configuration: configuration) {
                Color.blue
            } left: {
                Color.red
            } right: {
                Color.green
            }
        }
    }
}

Example

The example app includes a bunch of samples to play with. Download it here!

Customization

Prism supports extensive customization through the PrismConfiguration struct. Check out the example app for an editor!

Customization.mp4

Community

Author	Contributing	Need Help?
Prism is made by aheze.	All contributions are welcome. Just fork the repo, then make a pull request.	Open an issue or join the Discord server. You can also ping me on Twitter. Or read the source code — there's lots of comments.

Apps Using Prism

SwiftUICraft is Minecraft but made with Prism. You can move, add blocks, add water, switch worlds, and more. Thanks to Prism it's 100% SwiftUI with literally nothing else!

SwiftUICraft.mp4

Find is an app for browsing photos. Prism is used in the onboarding screen — download to check it out!

Find.mp4

If you have an app that uses Prism, just make a PR or message me.

License

MIT License

Copyright (c) 2023 A. Zheng

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.