javier
c5037dd716
This PR contains the work done to update the library and the attached example project to use the Swift 6.4 computer as a minimum supported version and also, to use the latest features introduced in it. Reviewed-on: #1 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
59 lines
1007 B
Markdown
59 lines
1007 B
Markdown
# ``PlaydateKit``
|
|
|
|
Swift bindings to the Playdate C API.
|
|
|
|
## Overview
|
|
|
|
The firmware hands your game a `PlaydateAPI*`: a struct of function
|
|
pointers. This module wraps it with per-subsystem namespaces, wrapper types
|
|
that own their C objects, closures instead of function-pointer/userdata
|
|
pairs, `OptionSet`s and `enum`s instead of raw constants, and typed `throws`.
|
|
|
|
Call ``Playdate/initialize(with:)`` from your game's `eventHandler` before
|
|
anything else; see <doc:GettingStarted>.
|
|
|
|
The module uses only the Embedded Swift subset, so the same code compiles
|
|
for the Playdate Simulator and the device (`armv7em-none-none-eabi`).
|
|
|
|
## Topics
|
|
|
|
### Essentials
|
|
|
|
- <doc:GettingStarted>
|
|
- ``Playdate``
|
|
- ``SystemEvent``
|
|
- ``PlaydateError``
|
|
|
|
### System and display
|
|
|
|
- ``System``
|
|
- ``Display``
|
|
|
|
### Drawing
|
|
|
|
- ``Graphics``
|
|
- ``Rect``
|
|
|
|
### Sprites
|
|
|
|
- ``Sprite``
|
|
|
|
### Audio
|
|
|
|
- ``Sound``
|
|
|
|
### Storage
|
|
|
|
- ``File``
|
|
- ``JSON``
|
|
|
|
### Connectivity
|
|
|
|
- ``Network``
|
|
- ``Scoreboards``
|
|
- ``AccessReply``
|
|
|
|
### Lua interop
|
|
|
|
- ``Lua``
|