Add "update_buffer_region_command" and "update_texture_region_command" events specific to a command list

Includes hook for "vkCmdUpdateBuffer" and improves handling for "ID3D11DeviceContext::UpdateSubresource" on deferred device contexts

Author: crosire

include/reshade.hpp

@@ -11,7 +11,7 @@
 #include <Windows.h>
 
 // Current version of the ReShade API
-#define RESHADE_API_VERSION 17
+#define RESHADE_API_VERSION 18
 
 // Optionally import ReShade API functions when 'RESHADE_API_LIBRARY' is defined instead of using header-only mode
 #if defined(RESHADE_API_LIBRARY) || defined(RESHADE_API_LIBRARY_EXPORT)

include/reshade_api_device.hpp

@@ -186,6 +186,16 @@ namespace reshade { namespace api
 		/// If this feature is not present, <see cref="resource_view_type::acceleration_structure"/>, <see cref="command_list::dispatch_rays"/>, <see cref="command_list::copy_acceleration_structure"/>, <see cref="command_list::build_acceleration_structure"/> and <see cref="command_list::query_acceleration_structures"/> must not be used.
 		/// </summary>
 		ray_tracing,
+		/// <summary>
+		/// Specifies whether deferred buffer updates can be used.
+		/// If this feature is not present, <see cref="command_list::update_buffer_region"/> must not be used.
+		/// </summary>
+		update_buffer_region_command,
+		/// <summary>
+		/// Specifies whether deferred texture updates can be used.
+		/// If this feature is not present, <see cref="command_list::update_texture_region"/> must not be used.
+		/// </summary>
+		update_texture_region_command,
 	};
 
 	/// <summary>
@@ -412,15 +422,15 @@ namespace reshade { namespace api
 		virtual void unmap_texture_region(resource resource, uint32_t subresource) = 0;
 
 		/// <summary>
-		/// Uploads data to a buffer resource.
+		/// Uploads data to a buffer resource immediately.
 		/// </summary>
 		/// <param name="data">Pointer to the data to upload.</param>
 		/// <param name="resource">Buffer resource to upload to.</param>
 		/// <param name="offset">Offset (in bytes) into the buffer resource to start uploading to.</param>
 		/// <param name="size">Number of bytes to upload.</param>
 		virtual void update_buffer_region(const void *data, resource resource, uint64_t offset, uint64_t size) = 0;
 		/// <summary>
-		/// Uploads data to a texture resource.
+		/// Uploads data to a texture resource immediately.
 		/// </summary>
 		/// <param name="data">Pointer to the data to upload.</param>
 		/// <param name="resource">Texture resource to upload to.</param>
@@ -813,7 +823,7 @@ namespace reshade { namespace api
 		/// <param name="max_sizes">Optional pointer to an array of size values, one for each buffer. Can be <see langword="nullptr"/> or have elements set to UINT64_MAX to use the entire buffer.</param>
 		/// <param name="counter_buffers">Pointer to the first element of an array of counter buffer resources. These resources must have been created with the <see cref="resource_usage::stream_output"/> usage.</param>
 		/// <param name="counter_offsets">Pointer to the first element of an array of counter offset values, one for each counter buffer. Each offset is the number of bytes from the start of the counter buffer to the first element to write to.</param>
-		virtual void bind_stream_output_buffers(uint32_t first, uint32_t count, const api::resource *buffers, const uint64_t *offsets, const uint64_t *max_sizes, const api::resource *counter_buffers, const uint64_t *counter_offsets) = 0;
+		virtual void bind_stream_output_buffers(uint32_t first, uint32_t count, const resource *buffers, const uint64_t *offsets, const uint64_t *max_sizes, const resource *counter_buffers, const uint64_t *counter_offsets) = 0;
 
 		/// <summary>
 		/// Draws non-indexed primitives.
@@ -1104,7 +1114,7 @@ namespace reshade { namespace api
 		/// <param name="source">Acceleration structure to read data from when <paramref name="mode"/> is <see cref="acceleration_structure_build_mode::update"/>, otherwise zero.</param>
 		/// <param name="dest">Acceleration structure to write data to.</param>
 		/// <param name="mode">Choose between building a new or updating an existing acceleration structure.</param>
-		virtual void build_acceleration_structure(acceleration_structure_type type, acceleration_structure_build_flags flags, uint32_t input_count, const acceleration_structure_build_input *inputs, api::resource scratch, uint64_t scratch_offset, resource_view source, resource_view dest, acceleration_structure_build_mode mode) = 0;
+		virtual void build_acceleration_structure(acceleration_structure_type type, acceleration_structure_build_flags flags, uint32_t input_count, const acceleration_structure_build_input *inputs, resource scratch, uint64_t scratch_offset, resource_view source, resource_view dest, acceleration_structure_build_mode mode) = 0;
 
 		/// <summary>
 		/// Queries acceleration structure size parameters.
@@ -1116,6 +1126,31 @@ namespace reshade { namespace api
 		/// <param name="type">Type of the acceleration structure query.</param>
 		/// <param name="first">Index of the first query in the query heap to write the result to.</param>
 		virtual void query_acceleration_structures(uint32_t count, const resource_view *acceleration_structures, query_heap heap, query_type type, uint32_t first) = 0;
+
+		/// <summary>
+		/// Uploads data to a buffer resource when the command list is executed.
+		/// </summary>
+		/// <remarks>
+		/// The <paramref name="dest"/>ination resource has to be in the <see cref="resource_usage::copy_dest"/> state.
+		/// </remarks>
+		/// <seealso cref="device_caps::update_buffer_region_command"/>
+		/// <param name="data">Pointer to the data to upload.</param>
+		/// <param name="dest">Buffer resource to upload to.</param>
+		/// <param name="dest_offset">Offset (in bytes) into the buffer resource to start uploading to.</param>
+		/// <param name="size">Number of bytes to upload.</param>
+		virtual void update_buffer_region(const void *data, resource dest, uint64_t dest_offset, uint64_t size) = 0;
+		/// <summary>
+		/// Uploads data to a texture resource when the command list is executed.
+		/// </summary>
+		/// <remarks>
+		/// The <paramref name="dest"/>ination resource has to be in the <see cref="resource_usage::copy_dest"/> state.
+		/// </remarks>
+		/// <seealso cref="device_caps::update_texture_region_command"/>
+		/// <param name="data">Pointer to the data to upload.</param>
+		/// <param name="dest">Texture resource to upload to.</param>
+		/// <param name="dest_subresource">Index of the subresource to upload to (<c>level + (layer * levels)</c>).</param>
+		/// <param name="dest_box">Optional 3D box (or <see langword="nullptr"/> to reference the entire subresource) that defines the region in the <paramref name="resource"/> to upload to.</param>
+		virtual void update_texture_region(const subresource_data &data, resource dest, uint32_t dest_subresource, const subresource_box *dest_box = nullptr) = 0;
 	};
 
 	/// <summary>

include/reshade_events.hpp

@@ -553,22 +553,37 @@ namespace reshade
 		/// <list type="bullet">
 		/// <item><description>ID3D10Device::UpdateSubresource</description></item>
 		/// <item><description>ID3D11DeviceContext::UpdateSubresource</description></item>
+		/// <item><description>ID3D11DeviceContext1::UpdateSubresource1</description></item>
 		/// <item><description>glBufferSubData</description></item>
 		/// <item><description>glNamedBufferSubData</description></item>
 		/// </list>
 		/// <para>Callback function signature: <c>bool (api::device *device, const void *data, api::resource resource, uint64_t offset, uint64_t size)</c></para>
 		/// </summary>
 		/// <remarks>
+		/// To prevent this action from being executed, return <see langword="true"/>, otherwise return <see langword="false"/>.
+		/// </remarks>
+		update_buffer_region = 24,
+		/// <summary>
+		/// Called before:
+		/// <list type="bullet">
+		/// <item><description>ID3D11DeviceContext::UpdateSubresource (on deferred device contexts)</description></item>
+		/// <item><description>ID3D11DeviceContext1::UpdateSubresource1 (on deferred device contexts)</description></item>
+		/// <item><description>vkCmdUpdateBuffer</description></item>
+		/// </list>
+		/// <para>Callback function signature: <c>bool (api::command_list *cmd_list, const void *data, api::resource dest, uint64_t dest_offset, uint64_t size)</c></para>
+		/// </summary>
+		/// <remarks>
 		/// To prevent this command from being executed, return <see langword="true"/>, otherwise return <see langword="false"/>.
 		/// Destination resource will be in the <see cref="api::resource_usage::copy_dest"/> state.
 		/// </remarks>
-		update_buffer_region,
+		update_buffer_region_command = 98,
 
 		/// <summary>
 		/// Called before:
 		/// <list type="bullet">
 		/// <item><description>ID3D10Device::UpdateSubresource</description></item>
 		/// <item><description>ID3D11DeviceContext::UpdateSubresource</description></item>
+		/// <item><description>ID3D11DeviceContext1::UpdateSubresource1</description></item>
 		/// <item><description>glTexSubData1D</description></item>
 		/// <item><description>glTexSubData2D</description></item>
 		/// <item><description>glTexSubData3D</description></item>
@@ -585,10 +600,22 @@ namespace reshade
 		/// <para>Callback function signature: <c>bool (api::device *device, const api::subresource_data &amp;data, api::resource resource, uint32_t subresource, const api::subresource_box *box)</c></para>
 		/// </summary>
 		/// <remarks>
+		/// To prevent this action from being executed, return <see langword="true"/>, otherwise return <see langword="false"/>.
+		/// </remarks>
+		update_texture_region = 25,
+		/// <summary>
+		/// Called before:
+		/// <list type="bullet">
+		/// <item><description>ID3D11DeviceContext::UpdateSubresource (on deferred device contexts)</description></item>
+		/// <item><description>ID3D11DeviceContext1::UpdateSubresource1 (on deferred device contexts)</description></item>
+		/// </list>
+		/// <para>Callback function signature: <c>bool (api::command_list *cmd_list, const api::subresource_data &amp;data, api::resource dest, uint32_t dest_subresource, const api::subresource_box *dest_box)</c></para>
+		/// </summary>
+		/// <remarks>
 		/// To prevent this command from being executed, return <see langword="true"/>, otherwise return <see langword="false"/>.
 		/// Destination resource will be in the <see cref="api::resource_usage::copy_dest"/> state.
 		/// </remarks>
-		update_texture_region,
+		update_texture_region_command = 99,
 
 		/// <summary>
 		/// Called after successful pipeline creation from:
@@ -636,7 +663,7 @@ namespace reshade
 		/// <remarks>
 		/// May be called multiple times with the same pipeline handle (whenever the pipeline is updated or its reference count is incremented).
 		/// </remarks>
-		init_pipeline,
+		init_pipeline = 26,
 
 		/// <summary>
 		/// Called on pipeline creation, before:
@@ -1252,6 +1279,8 @@ namespace reshade
 		/// <summary>
 		/// Called before:
 		/// <list type="bullet">
+		/// <item><description>ID3D11DeviceContext::CopySubresourceRegion</description></item>
+		/// <item><description>ID3D11DeviceContext1::CopySubresourceRegion1</description></item>
 		/// <item><description>ID3D12GraphicsCommandList::CopyBufferRegion</description></item>
 		/// <item><description>glCopyBufferSubData</description></item>
 		/// <item><description>glCopyNamedBufferSubData</description></item>
@@ -1291,6 +1320,7 @@ namespace reshade
 		/// <item><description>IDirect3DDevice9::StretchRect</description></item>
 		/// <item><description>ID3D10Device::CopySubresourceRegion</description></item>
 		/// <item><description>ID3D11DeviceContext::CopySubresourceRegion</description></item>
+		/// <item><description>ID3D11DeviceContext1::CopySubresourceRegion1</description></item>
 		/// <item><description>ID3D12GraphicsCommandList::CopyTextureRegion</description></item>
 		/// <item><description>glBlitFramebuffer</description></item>
 		/// <item><description>glBlitNamedFramebuffer</description></item>
@@ -1742,7 +1772,7 @@ namespace reshade
 		reshade_overlay_technique,
 
 #if RESHADE_ADDON
-		max = 98 // Last value used internally by ReShade to determine number of events in this enum
+		max = 100 // Last value used internally by ReShade to determine number of events in this enum
 #endif
 	};
 
@@ -1856,6 +1886,9 @@ namespace reshade
 	RESHADE_DEFINE_ADDON_EVENT_TRAITS(addon_event::build_acceleration_structure, bool, api::command_list *cmd_list, api::acceleration_structure_type type, api::acceleration_structure_build_flags flags, uint32_t input_count, const api::acceleration_structure_build_input *inputs, api::resource scratch, uint64_t scratch_offset, api::resource_view source, api::resource_view dest, api::acceleration_structure_build_mode mode);
 	RESHADE_DEFINE_ADDON_EVENT_TRAITS(addon_event::query_acceleration_structures, bool, api::command_list *cmd_list, uint32_t count, const api::resource_view *acceleration_structures, api::query_heap heap, api::query_type type, uint32_t first);
 
+	RESHADE_DEFINE_ADDON_EVENT_TRAITS(addon_event::update_buffer_region_command, bool, api::command_list *cmd_list, const void *data, api::resource dest, uint64_t dest_offset, uint64_t size);
+	RESHADE_DEFINE_ADDON_EVENT_TRAITS(addon_event::update_texture_region_command, bool, api::command_list *cmd_list, const api::subresource_data &data, api::resource dest, uint32_t dest_subresource, const api::subresource_box *dest_box);
+
 	RESHADE_DEFINE_ADDON_EVENT_TRAITS(addon_event::reset_command_list, void, api::command_list *cmd_list);
 	RESHADE_DEFINE_ADDON_EVENT_TRAITS(addon_event::close_command_list, void, api::command_list *cmd_list);
 

source/addon_manager.cpp

@@ -52,7 +52,9 @@ static const char *addon_event_to_string(reshade::addon_event ev)
 	case addon_event::map_texture_region: return "map_texture_region";
 	case addon_event::unmap_texture_region: return "unmap_texture_region";
 	case addon_event::update_buffer_region: return "update_buffer_region";
+	case addon_event::update_buffer_region_command: return "update_buffer_region_command";
 	case addon_event::update_texture_region: return "update_texture_region";
+	case addon_event::update_texture_region_command: return "update_texture_region_command";
 	case addon_event::init_pipeline: return "init_pipeline";
 	case addon_event::create_pipeline: return "create_pipeline";
 	case addon_event::destroy_pipeline: return "destroy_pipeline";

source/d3d10/d3d10_impl_device.cpp

@@ -125,6 +125,10 @@ bool reshade::d3d10::device_impl::check_capability(api::device_caps capability)
 	case api::device_caps::shared_fence_nt_handle:
 	case api::device_caps::amplification_and_mesh_shader:
 	case api::device_caps::ray_tracing:
+		return false;
+	case api::device_caps::update_buffer_region_command:
+	case api::device_caps::update_texture_region_command:
+		return true;
 	default:
 		return false;
 	}