Skip to content
/ reshade Public

Commit 90495eb

Browse files
crosirecrosire
committed
Rename add-on API logging function to match core for consistency in built-in add-on code
1 parent e415974 commit 90495eb

File tree

8 files changed

+113
-92
lines changed

8 files changed

+113
-92
lines changed

‎examples/04-api_trace/api_trace_addon.cpp‎

Lines changed: 38 additions & 38 deletions
Large diffs are not rendered by default.

‎examples/09-depth/generic_depth_addon.cpp‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,7 @@ struct __declspec(uuid("e006e162-33ac-4b9f-b10f-0e15335c7bdb")) generic_depth_de
263263
else
264264
{
265265
depth_stencil_backups.pop_back();
266-
reshade::log_message(reshade::log_level::error, "Failed to create backup depth-stencil texture!");
266+
reshade::log::message(reshade::log::level::error, "Failed to create backup depth-stencil texture!");
267267

268268
return nullptr;
269269
}
@@ -542,7 +542,7 @@ static bool on_create_resource(device *device, resource_desc &desc, subresource_
542542
if (desc.texture.width <= 512)
543543
return false;
544544
if (desc.texture.format == format::d32_float || desc.texture.format == format::d32_float_s8_uint)
545-
reshade::log_message(reshade::log_level::warning, "Replacing high bit depth depth-stencil format with a lower bit depth format");
545+
reshade::log::message(reshade::log::level::warning, "Replacing high bit depth depth-stencil format with a lower bit depth format");
546546
// Replace texture format with special format that supports normal sampling (see https://aras-p.info/texts/D3D9GPUHacks.html#depth)
547547
desc.texture.format = format::intz;
548548
desc.usage |= resource_usage::shader_resource;
@@ -623,7 +623,7 @@ static void on_destroy_resource(device *device, resource resource)
623623
{
624624
lock.unlock();
625625

626-
reshade::log_message(reshade::log_level::warning, "A depth-stencil resource was destroyed while still in use.");
626+
reshade::log::message(reshade::log::level::warning, "A depth-stencil resource was destroyed while still in use.");
627627

628628
// This is bad ... the resource may still be in use by an effect on the GPU and destroying it would crash it
629629
// Try to mitigate that somehow by delaying this thread a little to hopefully give the GPU enough time to catch up before the resource memory is deallocated

‎examples/10-texture_overlay/texture_overlay_addon.cpp‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,12 +68,12 @@ static void on_init_device(device *device)
6868

6969
if (!device->create_resource(resource_desc(1, 1, 1, 1, format::r8g8b8a8_unorm, 1, memory_heap::gpu_only, resource_usage::shader_resource), &initial_data, resource_usage::shader_resource, &data.green_texture))
7070
{
71-
reshade::log_message(reshade::log_level::error, "Failed to create green texture!");
71+
reshade::log::message(reshade::log::level::error, "Failed to create green texture!");
7272
return;
7373
}
7474
if (!device->create_resource_view(data.green_texture, resource_usage::shader_resource, resource_view_desc(format::r8g8b8a8_unorm), &data.green_texture_srv))
7575
{
76-
reshade::log_message(reshade::log_level::error, "Failed to create green texture view!");
76+
reshade::log::message(reshade::log::level::error, "Failed to create green texture view!");
7777
return;
7878
}
7979
}
@@ -299,7 +299,7 @@ static bool save_texture_image(command_queue *queue, resource tex, const resourc
299299

300300
if (!device->create_resource(resource_desc(desc.texture.width, desc.texture.height, 1, 1, format_to_default_typed(desc.texture.format), 1, memory_heap::gpu_to_cpu, resource_usage::copy_dest), nullptr, resource_usage::copy_dest, &intermediate))
301301
{
302-
reshade::log_message(reshade::log_level::error, "Failed to create system memory texture for texture dumping!");
302+
reshade::log::message(reshade::log::level::error, "Failed to create system memory texture for texture dumping!");
303303
return false;
304304
}
305305

‎examples/12-video_capture/video_capture.cpp‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ bool video_capture::init_codec_ctx(const reshade::api::resource_desc &buffer_des
5353

5454
if (codec == nullptr)
5555
{
56-
reshade::log_message(reshade::log_level::error, "Failed to find a H.264 encoder that passes requirements!");
56+
reshade::log::message(reshade::log::level::error, "Failed to find a H.264 encoder that passes requirements!");
5757
return false;
5858
}
5959

@@ -83,7 +83,7 @@ bool video_capture::init_codec_ctx(const reshade::api::resource_desc &buffer_des
8383
break;
8484
default:
8585
destroy_codec_ctx();
86-
reshade::log_message(reshade::log_level::error, "Unsupported texture format!");
86+
reshade::log::message(reshade::log::level::error, "Unsupported texture format!");
8787
return false;
8888
}
8989

@@ -93,7 +93,7 @@ bool video_capture::init_codec_ctx(const reshade::api::resource_desc &buffer_des
9393

9494
char errbuf[32 + AV_ERROR_MAX_STRING_SIZE] = "Failed to initialize encoder: ";
9595
av_make_error_string(errbuf + strlen(errbuf), sizeof(errbuf) - strlen(errbuf), err);
96-
reshade::log_message(reshade::log_level::error, errbuf);
96+
reshade::log::message(reshade::log::level::error, errbuf);
9797
return false;
9898
}
9999

@@ -116,7 +116,7 @@ bool video_capture::init_codec_ctx(const reshade::api::resource_desc &buffer_des
116116

117117
char errbuf[32 + AV_ERROR_MAX_STRING_SIZE] = "Failed to get frame buffer: ";
118118
av_make_error_string(errbuf + strlen(errbuf), sizeof(errbuf) - strlen(errbuf), err);
119-
reshade::log_message(reshade::log_level::error, errbuf);
119+
reshade::log::message(reshade::log::level::error, errbuf);
120120
return false;
121121
}
122122

@@ -143,7 +143,7 @@ bool video_capture::init_format_ctx(const char *filename)
143143
{
144144
char errbuf[32 + AV_ERROR_MAX_STRING_SIZE] = "Failed to initialize ffmpeg output context: ";
145145
av_make_error_string(errbuf + strlen(errbuf), sizeof(errbuf) - strlen(errbuf), err);
146-
reshade::log_message(reshade::log_level::error, errbuf);
146+
reshade::log::message(reshade::log::level::error, errbuf);
147147
return false;
148148
}
149149

@@ -152,7 +152,7 @@ bool video_capture::init_format_ctx(const char *filename)
152152
avformat_free_context(output_ctx);
153153
output_ctx = nullptr;
154154

155-
reshade::log_message(reshade::log_level::error, "Failed to open output file!");
155+
reshade::log::message(reshade::log::level::error, "Failed to open output file!");
156156
return false;
157157
}
158158

@@ -184,7 +184,7 @@ static void encode_frame(AVCodecContext *enc, AVFormatContext *s, AVFrame *frame
184184
{
185185
char errbuf[32 + AV_ERROR_MAX_STRING_SIZE] = "Failed to send frame for encoding: ";
186186
av_make_error_string(errbuf + strlen(errbuf), sizeof(errbuf) - strlen(errbuf), err);
187-
reshade::log_message(reshade::log_level::error, errbuf);
187+
reshade::log::message(reshade::log::level::error, errbuf);
188188
return;
189189
}
190190

@@ -206,7 +206,7 @@ static void on_init(reshade::api::effect_runtime *runtime)
206206
// Create a fence that is used to communicate status of copies between device and host
207207
if (!runtime->get_device()->create_fence(0, reshade::api::fence_flags::none, &data.copy_finished_fence))
208208
{
209-
reshade::log_message(reshade::log_level::error, "Failed to create copy fence!");
209+
reshade::log::message(reshade::log::level::error, "Failed to create copy fence!");
210210
}
211211
}
212212
static void on_destroy(reshade::api::effect_runtime *runtime)
@@ -242,7 +242,7 @@ static void on_reshade_finish_effects(reshade::api::effect_runtime *runtime, res
242242
{
243243
if (data.output_ctx != nullptr)
244244
{
245-
reshade::log_message(reshade::log_level::info, "Stopping video recording ...");
245+
reshade::log::message(reshade::log::level::info, "Stopping video recording ...");
246246

247247
queue->wait_idle();
248248

@@ -276,7 +276,7 @@ static void on_reshade_finish_effects(reshade::api::effect_runtime *runtime, res
276276
{
277277
if (!device->create_resource(desc, nullptr, reshade::api::resource_usage::copy_dest, &data.host_resources[i]))
278278
{
279-
reshade::log_message(reshade::log_level::error, "Failed to create host resource!");
279+
reshade::log::message(reshade::log::level::error, "Failed to create host resource!");
280280

281281
for (size_t k = 0; k < i; ++k)
282282
{
@@ -290,7 +290,7 @@ static void on_reshade_finish_effects(reshade::api::effect_runtime *runtime, res
290290
}
291291
}
292292

293-
reshade::log_message(reshade::log_level::info, "Starting video recording ...");
293+
reshade::log::message(reshade::log::level::info, "Starting video recording ...");
294294

295295
data.start_time = data.last_time = std::chrono::system_clock::now();
296296
}

‎examples/utils/load_texture_image.cpp‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ bool load_texture_image(const resource_desc &desc, subresource_data &data, std::
6262
if (desc.texture.width != static_cast<uint32_t>(width) ||
6363
desc.texture.height != static_cast<uint32_t>(height))
6464
{
65-
reshade::log_message(reshade::log_level::error, "Failed to replace texture data because dimensions do not match!");
65+
reshade::log::message(reshade::log::level::error, "Failed to replace texture data because dimensions do not match!");
6666
return false;
6767
}
6868

@@ -139,7 +139,7 @@ bool load_texture_image(const resource_desc &desc, subresource_data &data, std::
139139
break;
140140
default:
141141
// Unsupported format
142-
reshade::log_message(reshade::log_level::error, "Failed to replace texture data because format is not supported!");
142+
reshade::log::message(reshade::log::level::error, "Failed to replace texture data because format is not supported!");
143143
return false;
144144
}
145145

‎examples/utils/save_texture_image.cpp‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ bool save_texture_image(const resource_desc &desc, const subresource_data &data)
108108
static std::set<uint32_t> hash_set;
109109
if (hash_set.find(hash) != hash_set.end())
110110
{
111-
reshade::log_message(reshade::log_level::error, "Skipped texture that was already dumped.");
111+
reshade::log::message(reshade::log::level::error, "Skipped texture that was already dumped.");
112112
return true;
113113
}
114114
else

‎include/reshade.hpp‎

Lines changed: 38 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,9 @@ namespace reshade { namespace internal
5858
/// <summary>
5959
/// Gets the handle to the ReShade module.
6060
/// </summary>
61-
inline HMODULE get_reshade_module_handle(HMODULE reshade_module = nullptr)
61+
inline HMODULE get_reshade_module_handle(HMODULE initial_handle = nullptr)
6262
{
63-
static HMODULE handle = reshade_module;
63+
static HMODULE handle = initial_handle;
6464
if (handle == nullptr)
6565
{
6666
HMODULE modules[1024]; DWORD num = 0;
@@ -86,9 +86,9 @@ namespace reshade { namespace internal
8686
/// <summary>
8787
/// Gets the handle to the current add-on module.
8888
/// </summary>
89-
inline HMODULE get_current_module_handle(HMODULE addon_module = nullptr)
89+
inline HMODULE get_current_module_handle(HMODULE initial_handle = nullptr)
9090
{
91-
static HMODULE handle = addon_module;
91+
static HMODULE handle = initial_handle;
9292
return handle;
9393
}
9494
} }
@@ -97,44 +97,49 @@ namespace reshade { namespace internal
9797

9898
namespace reshade
9999
{
100-
/// <summary>
101-
/// Available log severity levels.
102-
/// </summary>
103-
enum class log_level
100+
#if !defined(RESHADE_API_LIBRARY_EXPORT) || defined(BUILTIN_ADDON)
101+
namespace log
104102
{
105103
/// <summary>
106-
/// | [ERROR] | ...
107-
/// </summary>
108-
error = 1,
109-
/// <summary>
110-
/// | [WARN] | ...
104+
/// Severity levels for logging.
111105
/// </summary>
112-
warning = 2,
113-
/// <summary>
114-
/// | [INFO] | ...
115-
/// </summary>
116-
info = 3,
106+
enum class level
107+
{
108+
/// <summary>
109+
/// | ERROR | ...
110+
/// </summary>
111+
error = 1,
112+
/// <summary>
113+
/// | WARN | ...
114+
/// </summary>
115+
warning = 2,
116+
/// <summary>
117+
/// | INFO | ...
118+
/// </summary>
119+
info = 3,
120+
/// <summary>
121+
/// | DEBUG | ...
122+
/// </summary>
123+
debug = 4,
124+
};
125+
117126
/// <summary>
118-
/// | [DEBUG] | ...
127+
/// Writes a message to ReShade's log.
119128
/// </summary>
120-
debug = 4
121-
};
122-
123-
/// <summary>
124-
/// Writes a message to ReShade's log.
125-
/// </summary>
126-
/// <param name="level">Severity level.</param>
127-
/// <param name="message">A null-terminated message string.</param>
128-
inline void log_message(log_level level, const char *message)
129-
{
129+
/// <param name="level">Severity level.</param>
130+
/// <param name="message">A null-terminated message string.</param>
131+
inline void message(level level, const char *message)
132+
{
130133
#if defined(RESHADE_API_LIBRARY)
131-
ReShadeLogMessage(nullptr, static_cast<int>(level), message);
134+
ReShadeLogMessage(nullptr, static_cast<int>(level), message);
132135
#else
133-
static const auto func = reinterpret_cast<void(*)(HMODULE, int, const char *)>(
134-
GetProcAddress(internal::get_reshade_module_handle(), "ReShadeLogMessage"));
135-
func(internal::get_current_module_handle(), static_cast<int>(level), message);
136+
static const auto func = reinterpret_cast<void(*)(HMODULE, int, const char *)>(
137+
GetProcAddress(internal::get_reshade_module_handle(), "ReShadeLogMessage"));
138+
func(internal::get_current_module_handle(), static_cast<int>(level), message);
136139
#endif
140+
}
137141
}
142+
#endif
138143

139144
/// <summary>
140145
/// Gets the base path ReShade uses to resolve relative paths.

‎source/dll_log.hpp‎

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,34 @@
1212

1313
namespace reshade::log
1414
{
15+
/// <summary>
16+
/// Severity levels for logging.
17+
/// </summary>
1518
enum class level
1619
{
17-
info = 3,
20+
/// <summary>
21+
/// | ERROR | ...
22+
/// </summary>
1823
error = 1,
24+
/// <summary>
25+
/// | WARN | ...
26+
/// </summary>
1927
warning = 2,
28+
/// <summary>
29+
/// | INFO | ...
30+
/// </summary>
31+
info = 3,
32+
/// <summary>
33+
/// | DEBUG | ...
34+
/// </summary>
2035
debug = 4,
2136
};
2237

2338
/// <summary>
2439
/// Opens a log file for writing.
2540
/// </summary>
2641
/// <param name="path">Path to the log file.</param>
42+
/// <param name="ec">Error code that is set on failure.</param>
2743
bool open_log_file(const std::filesystem::path &path, std::error_code &ec);
2844

2945
/// <summary>

0 commit comments

Comments
 (0)