Skip to content

Latest commit

 

History

History
62 lines (41 loc) · 2.47 KB

README.md

File metadata and controls

62 lines (41 loc) · 2.47 KB

SDL3-for-Pascal

Unit files for building Free Pascal / Delphi applications using the SDL3 library.

Installation

Simply add the units to your include path. You can achieve this by:

  • (FPC) using the {$UNITPATH XXX} directive in your source code;
  • (FPC) using the -FuXXX command-line argument to the compiler;
  • just copying & pasting the units into the same directory as your main source code.

Use the SDL3 unit for the main SDL3 library (should be always needed). Units for the other SDL3 libraries are (or will be) also provided:

Documentation

  • ToDo: Implement GitHub Pages

Bugs / Contributions / ToDos

If you have any contributions or bugfixes, feel free to drop a pull request or send in a patch. Please use the GitHub issue tracker.

ToDos

  • implement GitHub Pages documentation via GitHub Actions
  • implement GitHub Actions CI for testing + adapt tests (FPCUnit?)
  • improve units (search for "#todo" to find specific tasks)
  • adapt comments to PasDoc format (later)

Code style guidelines

The main principle is to stay as tight as possible at the names in the C headers. These guidelines aim to have better consistency in this community project and make it easier to find certain code parts in the C headers/Pascal includes. Feel free to discuss or extend these guidelines, use the issue tracker.

For details please refer to our Translation Code Style Sheet.

Versions

The version number/tag (see tags) refers to the version of this unit package SDL3 for Pascal, not the SDL3 Library.

v0.x (work in progress)

  • adds SDL3_ttf unit

v0.4 (15/03/2025)

  • adds working SDL3 unit (rather complete)
  • adds working SDL3_image unit
  • units seem stable

License

The units are licensed under the zlib license.