Skip to content

Commit 10cc526

Browse files
committed
Refined readme
1 parent ca381dd commit 10cc526

File tree

5 files changed

+7
-4
lines changed

5 files changed

+7
-4
lines changed

Misc/demo.gif

5.51 MB
Loading

Misc/readme-title.png

9.11 KB
Loading

Package.swift

-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
// swift-tools-version: 5.10
2-
// The swift-tools-version declares the minimum version of Swift required to build this package.
32

43
import PackageDescription
54

README.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
1-
# Doom Wipe transition for SwiftUI
1+
<img src="Misc/readme-title.png" alt="Doom Wipe transition for SwiftUI" width="726px">
22

33
![SwiftUI](https://img.shields.io/github/v/release/frzi/swiftui-doomwipe?style=for-the-badge)
44
[![SwiftUI](https://img.shields.io/badge/SwiftUI-blue.svg?style=for-the-badge&logo=swift&logoColor=black)](https://developer.apple.com/xcode/swiftui)
55
[![Swift](https://img.shields.io/badge/Swift-5.10-orange.svg?style=for-the-badge&logo=swift)](https://swift.org)
6-
[![Xcode](https://img.shields.io/badge/Xcode-15-blue.svg?style=for-the-badge&logo=Xcode&logoColor=white)](https://developer.apple.com/xcode)
76
[![MIT](https://img.shields.io/badge/license-MIT-black.svg?style=for-the-badge)](https://opensource.org/licenses/MIT)
87

9-
A transition for your SwiftUI views that simulates the 1993 classic DOOM screen wipe (the melting effect, you know the one).
8+
A transition for your SwiftUI views that simulates the 1993 classic DOOM screen wipe (the melting effect, you know the one!)
9+
10+
<img src="Misc/demo.gif" alt="Demonstration">
1011

1112
> [!IMPORTANT]
1213
> This transition utilizes SwiftUI 5's [.layerEffect](https://developer.apple.com/documentation/swiftui/view/layereffect(_:maxsampleoffset:isenabled:)). AppKit/UIKit powered views will *not* work. This includes views like `TextField`.

Sources/DoomWipe/DoomWipeShader.swift

+3
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,11 @@
66
import Metal
77
import SwiftUI
88

9+
/// Direction of the wipe effect.
910
public enum WipeDirection: CGFloat {
11+
/// The content flows downwards.
1012
case down = 1
13+
/// The content flows upwards.
1114
case up = -1
1215
}
1316

0 commit comments

Comments
 (0)