API v1 by WSSDude · Pull Request #178 · wopss/RED4ext.SDK

WSSDude · 2025-02-01T09:44:51Z

promote v0 to v1
swap to references instead of pointers
update GameState hooks
update documentation
fix incorrect naming of IGameState::OnUpdate to OnTick
rename GameStates::Add to AddHook
split GameState hooks to before/after hooks for more granular control and better verbosity
add EMainReason::Run for notifying plugins about entry to CRunningState
add NOMINMAX preprocessor define
fix incorrect naming of EGameStateStatus enum values
fix members of CGameApplication
simpler vendor exclusion in pre-commit

WSSDude · 2025-02-02T09:58:21Z

Practically same as wopss/RED4ext#94 (comment), would like to have a more proper look over the Present again if something might not be useful to expose, even if it may not be intresting now due to missing structs (already pre-exposed index into monitors structure that is used with HDR and contains curves for various supported modes by the monitor in the ResizeBuffers...)

But those are for the next PR, this was supposed to be about API primarily...

wopss

Thanks for the PR.

I saw some changes that include STL structs, which I would not prefer in the API, since it might be used in other code than C++ or compiled with a different C++ version.

include/RED4ext/Api/PluginHandle.hpp

include/RED4ext/Api/v1/GameState.hpp

include/RED4ext/Api/v1/PluginInfo.hpp

include/RED4ext/Api/v1/Render.hpp

include/RED4ext/Api/v1/Scripts.hpp

include/RED4ext/Api/v1/Sdk.hpp

include/RED4ext/Api/EMainReason.hpp

WSSDude · 2025-02-05T00:17:51Z

Just some update on why nothing gets posted for a bit - I found various issues trying to use this, trying to find some better hooks for initialize/deinitialize or some combination that should be reliable enough. Initialize only does base initialization of devices, not swapchain and some other systems that I had plan to hook. Same for shutdown - is just absolute last step of shutdown as I found out and not shutdown for all systems as I thought at first.

Found something already and got a bit sidetracked by it, should hopefully post some updates soon...

Also considering swapping the ResizeBackbuffer for some more upper-level function as it may get called twice a frame for no good reason as I found out, leading to some suboptimal things on hooked side.

* promote v0 to v1 * swap to references instead of pointers * update `GameState` hooks * update documentation * fix incorrect naming of `IGameState::OnUpdate` to `OnTick` * rename `GameStates::Add` to `AddHook` * split `GameState` hooks to before/after hooks for more granular control and better verbosity * add `EMainReason::Run` for notifying plugins about entry to `CRunningState` * add NOMINMAX preprocessor define * fix incorrect naming of `EGameStateStatus` enum values * fix members of `CGameApplication` * simpler `vendor` exclusion in pre-commit

WSSDude · 2025-02-18T18:55:20Z

I just quickly removed changes to SSwapChainData that I left in on accident and noticed just now trying to work on another PR... No other changes done.

WSSDude · 2025-02-19T16:41:24Z

Ill try to add something which wraps the newer API, should be doable I believe... Something to emulate v1 via v0 iface.

WSSDude · 2025-02-19T17:07:11Z

Or does it make sense even when it will break compat nonetheless without recompilation? Kinda going off the Discord discussion... @psiberx @wopss ?

psiberx · 2025-03-16T15:15:59Z

include/RED4ext/Api/Sdk.hpp

 namespace RED4ext
 {
 /**
 * @brief The latest plugin info type.


I'd delete "the latest" from all comments.

psiberx · 2025-03-16T15:20:36Z

include/RED4ext/Api/v1/GameState.hpp

+ */
+enum class EGameStateResult : uint8_t
+{
+    Running,  /**< Hook has not yet finished. Until the state changes, hook continues to operate. */


I think this comment is missing the most important part: "Running" prevents game state transition.

psiberx · 2025-03-16T15:22:23Z

include/RED4ext/Api/v1/GameState.hpp

+{
+    Running,  /**< Hook has not yet finished. Until the state changes, hook continues to operate. */
+    Finished, /**< Hook has finished. When signaled, hook is detached. */
+    Observing /**< Hook is observing, not running a task. Hook won't get detached until shutdown. */


Similar to "Running", the most important property of "Observing" is that it doesn't prevent game state transition (while still executing).

psiberx · 2025-03-16T15:31:00Z

include/RED4ext/Api/v1/GameState.hpp

+/**
+ * @brief Result type for game state hooks.
+ */
+enum class EGameStateResult : uint8_t


Proposal: rename it to EGameStateHookResult.

psiberx · 2025-03-16T15:31:08Z

include/RED4ext/Api/v1/GameState.hpp

+    Observing /**< Hook is observing, not running a task. Hook won't get detached until shutdown. */
+};
+
+struct GameState


Proposal: rename it to GameStateHooks.

WSSDude force-pushed the features/api-update branch 3 times, most recently from caa8d5d to ae4f1c3 Compare February 1, 2025 13:26

WSSDude changed the title ~~Promote v0 to v1~~ Promote v0 to v1, extend v1 and extend GpuApi Feb 1, 2025

WSSDude force-pushed the features/api-update branch from caa50b4 to b4f0e57 Compare February 2, 2025 09:34

WSSDude marked this pull request as ready for review February 2, 2025 09:56

WSSDude marked this pull request as draft February 2, 2025 09:56

wopss requested changes Feb 2, 2025

View reviewed changes

wopss reviewed Feb 2, 2025

View reviewed changes

include/RED4ext/Api/EMainReason.hpp Show resolved Hide resolved

WSSDude force-pushed the features/api-update branch 2 times, most recently from 9099004 to d66f101 Compare February 2, 2025 23:01

WSSDude force-pushed the features/api-update branch from d66f101 to 14258bc Compare February 16, 2025 00:13

WSSDude changed the title ~~Promote v0 to v1, extend v1 and extend GpuApi~~ API v1 Feb 16, 2025

WSSDude force-pushed the features/api-update branch from 14258bc to 1cd1cd6 Compare February 16, 2025 00:18

WSSDude marked this pull request as ready for review February 16, 2025 00:23

WSSDude requested review from psiberx and wopss February 16, 2025 00:23

WSSDude mentioned this pull request Feb 16, 2025

API v1 wopss/RED4ext#94

Draft

WSSDude force-pushed the features/api-update branch from 1cd1cd6 to 1934055 Compare February 16, 2025 01:46

wopss previously approved these changes Feb 17, 2025

View reviewed changes

WSSDude dismissed wopss’s stale review via d9d953e February 18, 2025 18:52

WSSDude force-pushed the features/api-update branch from 1934055 to d9d953e Compare February 18, 2025 18:52

WSSDude requested a review from wopss February 18, 2025 18:56

wopss previously approved these changes Feb 19, 2025

View reviewed changes

WSSDude marked this pull request as draft February 19, 2025 16:40

WSSDude marked this pull request as ready for review February 19, 2025 22:06

Fix CMakeLists install for header-only builds

0d3f1b1

WSSDude dismissed wopss’s stale review via 0d3f1b1 February 20, 2025 23:00

psiberx requested changes Mar 16, 2025

View reviewed changes

Conversation

WSSDude commented Feb 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

WSSDude commented Feb 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

wopss left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

WSSDude commented Feb 5, 2025

Uh oh!

WSSDude commented Feb 18, 2025

Uh oh!

WSSDude commented Feb 19, 2025

Uh oh!

WSSDude commented Feb 19, 2025

Uh oh!

psiberx Mar 16, 2025

Choose a reason for hiding this comment

Uh oh!

psiberx Mar 16, 2025

Choose a reason for hiding this comment

Uh oh!

psiberx Mar 16, 2025

Choose a reason for hiding this comment

Uh oh!

psiberx Mar 16, 2025

Choose a reason for hiding this comment

Uh oh!

psiberx Mar 16, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

WSSDude commented Feb 1, 2025 •

edited

Loading

WSSDude commented Feb 2, 2025 •

edited

Loading