Skip to content

Commit

Permalink
docs: update SplashKit Online test results
Browse files Browse the repository at this point in the history
  • Loading branch information
@WhyPenguins
WhyPenguins committed May 20, 2024
1 parent 4070dd7 commit 4ad8cfb
Showing 1 changed file with 27 additions and 27 deletions.
54 changes: 27 additions & 27 deletions ...lashkit/documentation/splashkit-online/research-and-findings/APISupportTests.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ description:

### Overview

While much of the SplashKit API already works in the browsers thanks to Emscripten, there are still
While much of the SplashKit API already works in browsers thanks to Emscripten, there are still
areas of functionality that do not. This report will outline what is working, what isn't, and the
general reason why.

Expand All @@ -27,7 +27,7 @@ for reproducibility. Here are the results grouped by API category.
| Field | JavaScript | C++ | Details |
| ---------------- | ----------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Animations | Full Support | Full Support | |
| Audio | Near Full Support | Near Full Support | No FLAC support or MOD support. C++ backend doesn't support playing audio while `delay`ing. |
| Audio | Near Full Support | Near Full Support | No FLAC support or MOD support. |
| Camera | Full Support | Full Support | |
| Color | Full Support | Full Support | |
| Geometry | Full Support | Full Support | |
Expand All @@ -43,33 +43,33 @@ for reproducibility. Here are the results grouped by API category.
| Sprites | Full Support | Full Support | |
| Terminal | Partial Support | Limited Support | **JavaScript**: it all _works_, but no terminal input bar. 'Input' _popup_ appears, that has confusing behaviour of only sending data once _cancelled_. This may be fixed very shortly however. <br/>**C++**: all the _read_ functions return immediately with no input. |
| Timers | Full Support | Full Support | |
| Utilities | Near Full Support | Near Full Support | [Display Dialog](http://localhost:4321/api/utilities/#display-dialog) does not work, as it enters a busy loop that freezes the page. |
| Utilities | Near Full Support | Full Support | [Display Dialog](https://splashkit.io/api/utilities/#display-dialog) does not work in JavaScript backend, as it enters a busy loop that freezes the page. |
| Windows | Partial Support | Partial Support | No support for multiple windows, or for moving the window. No way to close the current window. |

And here are the results specific to each test - some tests test multiple things unfortunately, so
some of these results aren't very helpful.

| Test | JavaScript | C++ | Details |
| ------------------- | ---------------- | ------------------ | -------------------------------------------------------------- |
| Animations | Works fully | Works fully | |
| Audio | Partially works | Partially works | Cannot download test audio. |
| Bundles | Works fully | works mostly | |
| Camera | Works fully | Works fully | |
| Geometry | Works fully | Works fully (Note) | Cannot close the first screen - replaced with delay |
| Graphics | Fails | Fails | |
| Input | Partially works | Partially works | Only support for one window currently |
| Logging | Works fully | Works fully | |
| Physics | Works fully | Fails | Due to use of read pixel |
| Resources | Works fully | Works fully | |
| Shape drawing | Works fully | Mostly works | Have to disable `take_screenshot` usage for C++ backend |
| Sprite tests | Works fully | Works fully | |
| Terminal | Possible failure | Possible failure | Slightly unsure what the behaviour should be |
| Text | Mostly Works | Mostly Works | Just fails to download font |
| Timers | works | Works fully | |
| Windows | Fails | Fails | Fails due to use of unpatched process events in Display Dialog |
| Cave Escape | Works fully | Works fully | |
| Web Server | Fails | Fails | |
| RESTful Web Service | Fails | Fails | |
| UDP Networking Test | Fails | Fails | |
| TCP Networking Test | Fails | Fails | |
| JSON Unit Test | Works fully | Works fully | |
| Test | JavaScript | C++ | Details |
| ------------------- | ---------------- | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Animations | Works fully | Works fully | |
| Audio | Partially works | Partially works | Cannot download test audio. |
| Bundles | Works fully | works mostly | |
| Camera | Works fully | Works fully | |
| Geometry | Works fully | Works fully (Note) | Cannot close the first screen - replaced with delay |
| Graphics | Fails | Fails | |
| Input | Partially works | Partially works | Only support for one window currently |
| Logging | Works fully | Works fully | |
| Physics | Works fully | Fails | Due to use of read pixel |
| Resources | Works fully | Works fully | |
| Shape drawing | Works fully | Mostly works | Have to disable `take_screenshot` usage for C++ backend |
| Sprite tests | Works fully | Works fully | |
| Terminal | Possible failure | Possible failure | Slightly unsure what the behaviour should be |
| Text | Mostly Works | Mostly Works | Just fails to download font |
| Timers | works | Works fully | |
| Windows | Fails | Fails | JavaScript backend freezes (due to Display Dialog). C++ fails after clicking okay, with `Cannot read properties of null (reading 'createTexture')` in console - works if `display_dialog(...)` line is removed. |
| Cave Escape | Works fully | Works fully | |
| Web Server | Fails | Fails | |
| RESTful Web Service | Fails | Fails | |
| UDP Networking Test | Fails | Fails | |
| TCP Networking Test | Fails | Fails | |
| JSON Unit Test | Works fully | Works fully | |

0 comments on commit 4ad8cfb

Please sign in to comment.