muskit/spice2x.github.io
0
0
Fork 0
mirror of https://github.com/spice2x/spice2x.github.io.git synced 2026-10-04 09:18:12 -07:00
Code Issues Packages Projects Releases Wiki Activity

overlay: toast notifications (#704)

Browse Source 
## Link to GitHub Issue or related Pull Request, if one exists
n/a

## Description of change
Adds toast notifications to the overlay.

Toast notifications are transient windows (shown for about 4 seconds).
These are drawn on top of the game even when the overlay is inactive
(i.e., when no window is open), and does not cause any input sink
behavior.

Add toasts for some common user-driven actions that could use a
notification, such as:

* screenshot
* card insert
* PIN macro
* API client connect/disconnect
* virtual printer
* screen resize toggle / scene switch

Add an option to change where the toasts are displayed, or to turn it
off entirely.

Add SDK function for it, and add it to the samples.

## Testing
Tested DDR (shown at bottom right, as is for most games) and RB (shown
top right by default).
This commit is contained in:
bicarus
2026-05-27 00:45:27 -07:00
committed by GitHub
parent d929cdf7c8
commit 311404f56b
20 changed files with 574 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/spice2x/sdk/sdk.cpp
+46
View File
@@ -7,6 +7,7 @@
#include "games/io.h"
#include "launcher/launcher.h"
#include "misc/eamuse.h"
#include "overlay/notifications.h"
#include "sdk/include/spicesdk.h"
#include "touch/touch.h"
#include "util/logging.h"
@@ -29,6 +30,7 @@ static spice_sdk_set_touch_func sdk_set_touch;
static spice_sdk_clear_touch_func sdk_clear_touch;
static spice_sdk_insert_card_func sdk_insert_card;
static spice_sdk_set_keypad_func sdk_set_keypad;
static spice_sdk_add_toast_func sdk_add_toast;
struct SdkModule {
std::string dll;
@@ -169,6 +171,12 @@ sdk_init(
v0->insert_card = sdk_insert_card;
v0->set_keypad = sdk_set_keypad;
// end of 0.1
if (v0->size >= RTL_SIZEOF_THROUGH_FIELD(SPICE_SDK_V0, add_toast)) {
v0->add_toast = sdk_add_toast;
}
// end of 0.2
// any newer minor iterations will need to check the size
{
@@ -594,5 +602,43 @@ sdk_set_keypad(
return SPICE_SDK_STATUS_SUCCESS;
}
SPICE_SDK_STATUS_CODE
__cdecl
sdk_add_toast(
SPICE_SDK_TOAST_SEVERITY severity,
const char *text
)
{
std::shared_lock lock(sdk_global_mutex);
if (!sdk_initialized) {
return SPICE_SDK_STATUS_TOO_LATE;
}
if (!text) {
return SPICE_SDK_STATUS_INVALID_ARGUMENT_2;
}
overlay::notifications::Severity sev;
switch (severity) {
case SPICE_SDK_TOAST_LEVEL_INFO:
sev = overlay::notifications::Severity::Info;
break;
case SPICE_SDK_TOAST_LEVEL_SUCCESS:
sev = overlay::notifications::Severity::Success;
break;
case SPICE_SDK_TOAST_LEVEL_WARNING:
sev = overlay::notifications::Severity::Warning;
break;
case SPICE_SDK_TOAST_LEVEL_ERROR:
sev = overlay::notifications::Severity::Error;
break;
default:
return SPICE_SDK_STATUS_INVALID_ARGUMENT_1;
}
overlay::notifications::add(sev, text);
return SPICE_SDK_STATUS_SUCCESS;
}
} // namespace sdk