Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/juniperphoton/photonmetaldisplaycore

A Swift Package to help you render CIImage from Core Image in a MTKView in SwiftUI, supporting some other features like HDR rendering.
https://github.com/juniperphoton/photonmetaldisplaycore

metal swiftdocc swiftui

Last synced: about 1 month ago
JSON representation

A Swift Package to help you render CIImage from Core Image in a MTKView in SwiftUI, supporting some other features like HDR rendering.

Awesome Lists containing this project

README

        

# PhotonMetalDisplayCore

A simple Swift Package to help you render CIImage from Core Image in a MTKView in SwiftUI, supporting some other features like HDR rendering.

The generated documentation can be accessed via:

https://juniperphoton.github.io/PhotonMetalDisplayCore/documentation/photonmetaldisplaycore

## Generate the Swift DocC

### Using Swift DocC plugin:

```
swift package --allow-writing-to-directory ./docs \
generate-documentation --target PhotonMetalDisplayCore \
--disable-indexing \
--transform-for-static-hosting \
--hosting-base-path PhotonMetalDisplayCore \
--output-path './docs'
```

### Using Xcode build

```
xcodebuild docbuild -scheme PhotonMetalDisplayCore -derivedDataPath ./.build/derived-data -destination 'generic/platform=iOS' DOCC_HOSTING_BASE_PATH='PhotonMetalDisplayCore'
```

Then find the docarchived:

```
find './.build/derived-data' -type d -name '*.doccarchive'
```

Copy the *.doccarchive to the root dir and change its name to `docs` (Configure the page settings in the repo settings first).

## Preview the documentation locally

```
swift package --disable-sandbox preview-documentation --target PhotonMetalDisplayCore
```