Mod API: Rename dusk::mods -> mods

This commit is contained in:
Luke Street
2026-07-15 12:04:26 -06:00
parent 5ea7f7ca9a
commit 5db55c508b
16 changed files with 66 additions and 70 deletions
+10 -10
View File
@@ -752,7 +752,7 @@ ModResult register_bool_option(
cvarDesc.type = CONFIG_VAR_BOOL;
cvarDesc.default_bool = defaultValue;
if (svc_config->register_var(mod_ctx, &cvarDesc, &outHandle) != MOD_OK) {
return dusk::mods::set_error(error, MOD_ERROR, "failed to register AO option");
return mods::set_error(error, MOD_ERROR, "failed to register AO option");
}
return MOD_OK;
}
@@ -764,7 +764,7 @@ ModResult register_int_option(
cvarDesc.type = CONFIG_VAR_INT;
cvarDesc.default_int = defaultValue;
if (svc_config->register_var(mod_ctx, &cvarDesc, &outHandle) != MOD_OK) {
return dusk::mods::set_error(error, MOD_ERROR, "failed to register AO option");
return mods::set_error(error, MOD_ERROR, "failed to register AO option");
}
return MOD_OK;
}
@@ -785,7 +785,7 @@ MOD_EXPORT ModResult mod_initialize(ModError* error) {
result = svc_resource->load(mod_ctx, "composite.wgsl", &g_compositeSource);
}
if (result != MOD_OK) {
return dusk::mods::set_error(error, result, "failed to load AO shaders");
return mods::set_error(error, result, "failed to load AO shaders");
}
result = register_bool_option("effectEnabled", false, g_cvarEnabled, error);
@@ -814,7 +814,7 @@ MOD_EXPORT ModResult mod_initialize(ModError* error) {
}
if (svc_gfx->get_device_info(mod_ctx, &g_deviceInfo) != MOD_OK) {
return dusk::mods::set_error(error, MOD_ERROR, "failed to query device info");
return mods::set_error(error, MOD_ERROR, "failed to query device info");
}
if (!build_compute_pipeline("AO preprocess depth", g_preprocessSource, "preprocess_depth",
g_preprocessPipeline, g_preprocessLayout) ||
@@ -824,35 +824,35 @@ MOD_EXPORT ModResult mod_initialize(ModError* error) {
!build_compute_pipeline(
"AO denoise", g_denoiseSource, "spatial_denoise", g_denoisePipeline, g_denoiseLayout))
{
return dusk::mods::set_error(error, MOD_ERROR, "failed to create AO compute pipelines");
return mods::set_error(error, MOD_ERROR, "failed to create AO compute pipelines");
}
if (!build_composite_pipeline(true, g_compositePipeline, g_compositeLayout) ||
!build_composite_pipeline(false, g_compositeDebugPipeline, g_compositeDebugLayout))
{
return dusk::mods::set_error(error, MOD_ERROR, "failed to create AO composite pipeline");
return mods::set_error(error, MOD_ERROR, "failed to create AO composite pipeline");
}
if (!build_hilbert_lut()) {
return dusk::mods::set_error(error, MOD_ERROR, "failed to create AO noise LUT");
return mods::set_error(error, MOD_ERROR, "failed to create AO noise LUT");
}
GfxComputeTypeDesc computeDesc = GFX_COMPUTE_TYPE_DESC_INIT;
computeDesc.label = "AO chain";
computeDesc.callback = on_compute;
if (svc_gfx->register_compute_type(mod_ctx, &computeDesc, &g_computeType) != MOD_OK) {
return dusk::mods::set_error(error, MOD_ERROR, "failed to register compute type");
return mods::set_error(error, MOD_ERROR, "failed to register compute type");
}
GfxDrawTypeDesc drawDesc = GFX_DRAW_TYPE_DESC_INIT;
drawDesc.label = "AO composite";
drawDesc.draw = on_draw;
if (svc_gfx->register_draw_type(mod_ctx, &drawDesc, &g_drawType) != MOD_OK) {
return dusk::mods::set_error(error, MOD_ERROR, "failed to register draw type");
return mods::set_error(error, MOD_ERROR, "failed to register draw type");
}
GfxStageHookDesc stageDesc = GFX_STAGE_HOOK_DESC_INIT;
stageDesc.callback = on_scene_after_opaque;
if (svc_gfx->register_stage_hook(
mod_ctx, GFX_STAGE_SCENE_AFTER_OPAQUE, &stageDesc, &g_afterOpaqueHook) != MOD_OK)
{
return dusk::mods::set_error(error, MOD_ERROR, "failed to register stage hook");
return mods::set_error(error, MOD_ERROR, "failed to register stage hook");
}
UiModsPanelDesc panelDesc = UI_MODS_PANEL_DESC_INIT;
+18 -18
View File
@@ -945,7 +945,7 @@ ModResult register_bool_option(
cvarDesc.type = CONFIG_VAR_BOOL;
cvarDesc.default_bool = defaultValue;
if (svc_config->register_var(mod_ctx, &cvarDesc, &outHandle) != MOD_OK) {
return dusk::mods::set_error(error, MOD_ERROR, "failed to register shadow option");
return mods::set_error(error, MOD_ERROR, "failed to register shadow option");
}
return MOD_OK;
}
@@ -957,7 +957,7 @@ ModResult register_int_option(
cvarDesc.type = CONFIG_VAR_INT;
cvarDesc.default_int = defaultValue;
if (svc_config->register_var(mod_ctx, &cvarDesc, &outHandle) != MOD_OK) {
return dusk::mods::set_error(error, MOD_ERROR, "failed to register shadow option");
return mods::set_error(error, MOD_ERROR, "failed to register shadow option");
}
return MOD_OK;
}
@@ -969,7 +969,7 @@ extern "C" {
MOD_EXPORT ModResult mod_initialize(ModError* error) {
ModResult result = svc_resource->load(mod_ctx, "shadow.wgsl", &g_shaderSource);
if (result != MOD_OK || g_shaderSource.data == nullptr) {
return dusk::mods::set_error(error, result, "failed to load shadow.wgsl");
return mods::set_error(error, result, "failed to load shadow.wgsl");
}
result = register_bool_option("effectEnabled", false, g_cvarEnabled, error);
@@ -1014,56 +1014,56 @@ MOD_EXPORT ModResult mod_initialize(ModError* error) {
}
if (svc_gfx->get_device_info(mod_ctx, &g_deviceInfo) != MOD_OK) {
return dusk::mods::set_error(error, MOD_ERROR, "failed to query device info");
return mods::set_error(error, MOD_ERROR, "failed to query device info");
}
if (!build_composite_pipeline(true, g_compositePipeline, g_compositeLayout) ||
!build_composite_pipeline(false, g_compositeDebugPipeline, g_compositeDebugLayout))
{
return dusk::mods::set_error(error, MOD_ERROR, "failed to create composite pipeline");
return mods::set_error(error, MOD_ERROR, "failed to create composite pipeline");
}
GfxDrawTypeDesc drawDesc = GFX_DRAW_TYPE_DESC_INIT;
drawDesc.label = "shadow composite";
drawDesc.draw = on_draw;
if (svc_gfx->register_draw_type(mod_ctx, &drawDesc, &g_drawType) != MOD_OK) {
return dusk::mods::set_error(error, MOD_ERROR, "failed to register draw type");
return mods::set_error(error, MOD_ERROR, "failed to register draw type");
}
GfxStageHookDesc stageDesc = GFX_STAGE_HOOK_DESC_INIT;
stageDesc.callback = on_scene_begin;
if (svc_gfx->register_stage_hook(
mod_ctx, GFX_STAGE_SCENE_BEGIN, &stageDesc, &g_sceneBeginHook) != MOD_OK)
{
return dusk::mods::set_error(error, MOD_ERROR, "failed to register stage hook");
return mods::set_error(error, MOD_ERROR, "failed to register stage hook");
}
stageDesc.callback = on_scene_after_terrain;
if (svc_gfx->register_stage_hook(
mod_ctx, GFX_STAGE_SCENE_AFTER_TERRAIN, &stageDesc, &g_sceneAfterTerrainHook) != MOD_OK)
{
return dusk::mods::set_error(error, MOD_ERROR, "failed to register stage hook");
return mods::set_error(error, MOD_ERROR, "failed to register stage hook");
}
stageDesc.callback = on_frame_before_hud;
if (svc_gfx->register_stage_hook(
mod_ctx, GFX_STAGE_FRAME_BEFORE_HUD, &stageDesc, &g_frameBeforeHudHook) != MOD_OK)
{
return dusk::mods::set_error(error, MOD_ERROR, "failed to register stage hook");
return mods::set_error(error, MOD_ERROR, "failed to register stage hook");
}
// Skip the game's own shadow rendering while the dynamic pass is active: the
// shadowControl pair covers the actor real/blob shadows, drawCloudShadow the weather
// cloud shadows.
if (dusk::mods::hook_add_pre<GameShadowImageDraw>(svc_hook, on_game_shadow_pre) != MOD_OK ||
dusk::mods::hook_add_pre<GameShadowDraw>(svc_hook, on_game_shadow_pre) != MOD_OK ||
dusk::mods::hook_add_pre<CloudShadowDraw>(svc_hook, on_game_shadow_pre) != MOD_OK)
if (mods::hook_add_pre<GameShadowImageDraw>(svc_hook, on_game_shadow_pre) != MOD_OK ||
mods::hook_add_pre<GameShadowDraw>(svc_hook, on_game_shadow_pre) != MOD_OK ||
mods::hook_add_pre<CloudShadowDraw>(svc_hook, on_game_shadow_pre) != MOD_OK)
{
return dusk::mods::set_error(error, MOD_ERROR, "failed to hook game shadow rendering");
return mods::set_error(error, MOD_ERROR, "failed to hook game shadow rendering");
}
if (dusk::mods::hook_add_pre<ClipperSphereClip>(svc_hook, on_frustum_clip_pre) != MOD_OK ||
dusk::mods::hook_add_pre<ClipperBoxClip>(svc_hook, on_frustum_clip_pre) != MOD_OK)
if (mods::hook_add_pre<ClipperSphereClip>(svc_hook, on_frustum_clip_pre) != MOD_OK ||
mods::hook_add_pre<ClipperBoxClip>(svc_hook, on_frustum_clip_pre) != MOD_OK)
{
return dusk::mods::set_error(error, MOD_ERROR, "failed to hook frustum clipping");
return mods::set_error(error, MOD_ERROR, "failed to hook frustum clipping");
}
if (dusk::mods::hook_add_pre<CopyTex>(svc_hook, on_copy_tex_pre) != MOD_OK) {
return dusk::mods::set_error(error, MOD_ERROR, "failed to hook GXCopyTex");
if (mods::hook_add_pre<CopyTex>(svc_hook, on_copy_tex_pre) != MOD_OK) {
return mods::set_error(error, MOD_ERROR, "failed to hook GXCopyTex");
}
UiModsPanelDesc panelDesc = UI_MODS_PANEL_DESC_INIT;
panelDesc.build = build_panel;
+9 -10
View File
@@ -9,7 +9,7 @@
#include <memory>
#include <type_traits>
namespace dusk::mods {
namespace mods {
template <class T>
T arg(void* argsRaw, int n) noexcept {
@@ -133,7 +133,7 @@ struct NamedHook<Name, R(A...)> : HookImpl<detail::NameTag<Name>, R, A...> {};
* DEFINE_HOOK_SYMBOL("daAlink_hookshotAtHitCallBack",
* void(fopAc_ac_c*, dCcD_GObjInf*, fopAc_ac_c*, dCcD_GObjInf*), HookshotHit);
*
* dusk::mods::hook_add_pre<LinkExecute>(svc_hook, on_link_execute);
* mods::hook_add_pre<LinkExecute>(svc_hook, on_link_execute);
*
* DEFINE_HOOK_SYMBOL names may be the platform mangled name (dlopen convention, no Mach-O
* leading underscore) or the demangled qualified display name; overloaded display names are
@@ -141,19 +141,18 @@ struct NamedHook<Name, R(A...)> : HookImpl<detail::NameTag<Name>, R, A...> {};
*/
#define DEFINE_HOOK(target, alias) \
[[maybe_unused]] static const void* const mod_meta_hook_##alias = \
&::dusk::mods::detail::HookRecordFor<(target), \
::dusk::mods::FixedString{#target}>::Holder::record; \
struct alias : ::dusk::mods::Hook<(target)> { \
&::mods::detail::HookRecordFor<(target), ::mods::FixedString{#target}>::Holder::record; \
struct alias : ::mods::Hook<(target)> { \
static void* resolved_target() { \
return ::dusk::mods::detail::HookRecordFor<(target), \
::dusk::mods::FixedString{#target}>::Holder::record.resolved; \
return ::mods::detail::HookRecordFor<(target), \
::mods::FixedString{#target}>::Holder::record.resolved; \
} \
}
#define DEFINE_HOOK_SYMBOL(name, sig, alias) \
MOD_META_RECORD static constinit auto mod_meta_hook_##alias = \
::dusk::mods::detail::make_hook_name_record<::dusk::mods::FixedString{name}>(); \
struct alias : ::dusk::mods::NamedHook<::dusk::mods::FixedString{name}, sig> { \
::mods::detail::make_hook_name_record<::mods::FixedString{name}>(); \
struct alias : ::mods::NamedHook<::mods::FixedString{name}, sig> { \
static void* resolved_target() { return mod_meta_hook_##alias.resolved; } \
}
@@ -208,4 +207,4 @@ ModResult hook_replace(
return hooks->replace(mod_ctx, Entry::target, callback, options);
}
} // namespace dusk::mods
} // namespace mods
+4 -6
View File
@@ -52,7 +52,7 @@ extern "C" const unsigned char __stop_modmeta[];
#define MOD_META_BOUNDS_END (__stop_modmeta)
#endif
namespace dusk::mods {
namespace mods {
/* A string usable as a template argument: carries a symbol/target name into record builders
* and makes each hook declaration's static state unique. */
@@ -254,8 +254,7 @@ struct HookFnHolder {
{sizeof(HookFnRecord<F>), MOD_META_HOOK_FN, 0}, 0, Target, nullptr};
};
template <auto Target, FixedString Disp,
bool = std::is_member_function_pointer_v<decltype(Target)>>
template <auto Target, FixedString Disp, bool = std::is_member_function_pointer_v<decltype(Target)>>
struct HookRecordFor {
using Holder = HookFnHolder<Target>;
};
@@ -268,8 +267,7 @@ struct HookRecordFor<Target, Disp, true> {
struct Bind<std::index_sequence<Is...>> {
using Type = HookMemHolder<Target, make_hook_mem_names<Target, Disp>().chars[Is]...>;
};
using Holder =
Bind<std::make_index_sequence<make_hook_mem_names<Target, Disp>().len>>::Type;
using Holder = Bind<std::make_index_sequence<make_hook_mem_names<Target, Disp>().len>>::Type;
};
template <FixedString Name>
@@ -284,4 +282,4 @@ consteval auto make_hook_name_record() {
}
} // namespace detail
} // namespace dusk::mods
} // namespace mods
+13 -14
View File
@@ -7,7 +7,7 @@
#include <cstdio>
#include <type_traits>
namespace dusk::mods {
namespace mods {
template <class Service>
struct ServiceTraits;
@@ -23,14 +23,14 @@ inline ModResult set_error(ModError* outError, ModResult code, const char* messa
return code;
}
} // namespace dusk::mods
} // namespace mods
#define DEFINE_MOD() \
extern "C" { \
MOD_EXPORT ModContext* mod_ctx = nullptr; \
} \
MOD_META_RECORD static constinit ModMetaHeader mod_meta_header_record = \
::dusk::mods::detail::make_header(); \
::mods::detail::make_header(); \
MOD_META_BOUNDS_DEFN \
extern "C" { \
MOD_EXPORT constinit const ModMeta mod_meta = { \
@@ -52,26 +52,26 @@ inline ModResult set_error(ModError* outError, ModResult code, const char* messa
static_cast<uint16_t>(major_value), \
static_cast<uint16_t>(min_minor_value), \
&(variable), \
::dusk::mods::detail::make_service_id(service_id_value), \
::mods::detail::make_service_id(service_id_value), \
}
#define IMPORT_SERVICE_VERSION(service_type, variable, min_minor_value) \
IMPORT_SERVICE_EX(service_type, variable, ::dusk::mods::ServiceTraits<service_type>::id, \
::dusk::mods::ServiceTraits<service_type>::major_version, min_minor_value, \
IMPORT_SERVICE_EX(service_type, variable, ::mods::ServiceTraits<service_type>::id, \
::mods::ServiceTraits<service_type>::major_version, min_minor_value, \
SERVICE_IMPORT_REQUIRED)
#define IMPORT_SERVICE(service_type, variable) \
IMPORT_SERVICE_VERSION( \
service_type, variable, ::dusk::mods::ServiceTraits<service_type>::minor_version)
service_type, variable, ::mods::ServiceTraits<service_type>::minor_version)
#define IMPORT_OPTIONAL_SERVICE_VERSION(service_type, variable, min_minor_value) \
IMPORT_SERVICE_EX(service_type, variable, ::dusk::mods::ServiceTraits<service_type>::id, \
::dusk::mods::ServiceTraits<service_type>::major_version, min_minor_value, \
IMPORT_SERVICE_EX(service_type, variable, ::mods::ServiceTraits<service_type>::id, \
::mods::ServiceTraits<service_type>::major_version, min_minor_value, \
SERVICE_IMPORT_OPTIONAL)
#define IMPORT_OPTIONAL_SERVICE(service_type, variable) \
IMPORT_OPTIONAL_SERVICE_VERSION( \
service_type, variable, ::dusk::mods::ServiceTraits<service_type>::minor_version)
service_type, variable, ::mods::ServiceTraits<service_type>::minor_version)
#define EXPORT_SERVICE_AS(instance, service_id_value) \
MOD_META_RECORD static constinit ModMetaExport mod_meta_export_##instance = { \
@@ -79,12 +79,11 @@ inline ModResult set_error(ModError* outError, ModResult code, const char* messa
(instance).header.major_version, \
(instance).header.minor_version, \
&(instance), \
::dusk::mods::detail::make_service_id(service_id_value), \
::mods::detail::make_service_id(service_id_value), \
}
#define EXPORT_SERVICE(instance) \
EXPORT_SERVICE_AS( \
instance, ::dusk::mods::ServiceTraits<std::remove_cv_t<decltype(instance)>>::id)
EXPORT_SERVICE_AS(instance, ::mods::ServiceTraits<std::remove_cv_t<decltype(instance)>>::id)
#define EXPORT_DEFERRED_SERVICE(token, service_id_value, major_value, minor_value) \
MOD_META_RECORD static constinit ModMetaExport mod_meta_export_##token = { \
@@ -92,5 +91,5 @@ inline ModResult set_error(ModError* outError, ModResult code, const char* messa
static_cast<uint16_t>(major_value), \
static_cast<uint16_t>(minor_value), \
nullptr, \
::dusk::mods::detail::make_service_id(service_id_value), \
::mods::detail::make_service_id(service_id_value), \
}
+1 -1
View File
@@ -57,7 +57,7 @@ typedef struct CameraService {
#include "mods/service.hpp"
template <>
struct dusk::mods::ServiceTraits<CameraService> {
struct mods::ServiceTraits<CameraService> {
static constexpr const char* id = CAMERA_SERVICE_ID;
static constexpr uint16_t major_version = CAMERA_SERVICE_MAJOR;
static constexpr uint16_t minor_version = CAMERA_SERVICE_MINOR;
+1 -1
View File
@@ -100,7 +100,7 @@ typedef struct ConfigService {
#include "mods/service.hpp"
template <>
struct dusk::mods::ServiceTraits<ConfigService> {
struct mods::ServiceTraits<ConfigService> {
static constexpr const char* id = CONFIG_SERVICE_ID;
static constexpr uint16_t major_version = CONFIG_SERVICE_MAJOR;
static constexpr uint16_t minor_version = CONFIG_SERVICE_MINOR;
+1 -1
View File
@@ -23,7 +23,7 @@ typedef struct GameService {
#include <mods/service.hpp>
template <>
struct dusk::mods::ServiceTraits<GameService> {
struct mods::ServiceTraits<GameService> {
static constexpr const char* id = GAME_SERVICE_ID;
static constexpr uint16_t major_version = GAME_SERVICE_MAJOR;
static constexpr uint16_t minor_version = GAME_SERVICE_MINOR;
+1 -1
View File
@@ -206,7 +206,7 @@ typedef struct GfxService {
#include "mods/service.hpp"
template <>
struct dusk::mods::ServiceTraits<GfxService> {
struct mods::ServiceTraits<GfxService> {
static constexpr const char* id = GFX_SERVICE_ID;
static constexpr uint16_t major_version = GFX_SERVICE_MAJOR;
static constexpr uint16_t minor_version = GFX_SERVICE_MINOR;
+2 -2
View File
@@ -46,7 +46,7 @@ typedef enum HookReplacePolicy {
/*
* Hook callbacks. `args` is an array of pointers to the call's arguments (index 0 is `this`
* for member functions); `retval` points at the return slot (NULL for void). Read and write
* them through dusk::mods::arg<T> / arg_ref<T> from mods/hook.hpp. `userdata` is the pointer
* them through mods::arg<T> / arg_ref<T> from mods/hook.hpp. `userdata` is the pointer
* from HookOptions. All run on the game thread, in the hooked call's own stack frame.
*/
typedef HookAction (*HookPreFn)(ModContext* ctx, void* args, void* retval, void* userdata);
@@ -118,7 +118,7 @@ typedef struct HookService {
#include "mods/service.hpp"
template <>
struct dusk::mods::ServiceTraits<HookService> {
struct mods::ServiceTraits<HookService> {
static constexpr const char* id = HOOK_SERVICE_ID;
static constexpr uint16_t major_version = HOOK_SERVICE_MAJOR;
static constexpr uint16_t minor_version = HOOK_SERVICE_MINOR;
+1 -1
View File
@@ -107,7 +107,7 @@ typedef struct HostService {
#include "mods/service.hpp"
template <>
struct dusk::mods::ServiceTraits<HostService> {
struct mods::ServiceTraits<HostService> {
static constexpr const char* id = HOST_SERVICE_ID;
static constexpr uint16_t major_version = HOST_SERVICE_MAJOR;
static constexpr uint16_t minor_version = HOST_SERVICE_MINOR;
+1 -1
View File
@@ -40,7 +40,7 @@ typedef struct LogService {
#include "mods/service.hpp"
template <>
struct dusk::mods::ServiceTraits<LogService> {
struct mods::ServiceTraits<LogService> {
static constexpr const char* id = LOG_SERVICE_ID;
static constexpr uint16_t major_version = LOG_SERVICE_MAJOR;
static constexpr uint16_t minor_version = LOG_SERVICE_MINOR;
+1 -1
View File
@@ -50,7 +50,7 @@ typedef struct OverlayService {
#include "mods/service.hpp"
template <>
struct dusk::mods::ServiceTraits<OverlayService> {
struct mods::ServiceTraits<OverlayService> {
static constexpr const char* id = OVERLAY_SERVICE_ID;
static constexpr uint16_t major_version = OVERLAY_SERVICE_MAJOR;
static constexpr uint16_t minor_version = OVERLAY_SERVICE_MINOR;
+1 -1
View File
@@ -45,7 +45,7 @@ typedef struct ResourceService {
#include "mods/service.hpp"
template <>
struct dusk::mods::ServiceTraits<ResourceService> {
struct mods::ServiceTraits<ResourceService> {
static constexpr const char* id = RESOURCE_SERVICE_ID;
static constexpr uint16_t major_version = RESOURCE_SERVICE_MAJOR;
static constexpr uint16_t minor_version = RESOURCE_SERVICE_MINOR;
+1 -1
View File
@@ -81,7 +81,7 @@ typedef struct TextureService {
#include "mods/service.hpp"
template <>
struct dusk::mods::ServiceTraits<TextureService> {
struct mods::ServiceTraits<TextureService> {
static constexpr const char* id = TEXTURE_SERVICE_ID;
static constexpr uint16_t major_version = TEXTURE_SERVICE_MAJOR;
static constexpr uint16_t minor_version = TEXTURE_SERVICE_MINOR;
+1 -1
View File
@@ -277,7 +277,7 @@ typedef struct UiService {
#include "mods/service.hpp"
template <>
struct dusk::mods::ServiceTraits<UiService> {
struct mods::ServiceTraits<UiService> {
static constexpr const char* id = UI_SERVICE_ID;
static constexpr uint16_t major_version = UI_SERVICE_MAJOR;
static constexpr uint16_t minor_version = UI_SERVICE_MINOR;