You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Currently, all of the following capture-related API methods take &mut self:
trigger_capture()
start_frame_capture()
end_frame_capture()
This is because the RenderDoc API used for capturing frames is designed with inherently serial operations (not thread-safe) and need to statically indicate to the compiler and end user alike that unsynchronized internal mutation is occurring. As such, trigger_multi_frame_capture() should take &mut self as well.
This is technically a breaking API change, but it is critical to fix this in order to prevent unsound behavior in future versions. It should be documented in the CHANGELOG.md so users looking to upgrade versions are aware of the change.
The text was updated successfully, but these errors were encountered:
Currently, all of the following capture-related API methods take
&mut self
:trigger_capture()
start_frame_capture()
end_frame_capture()
This is because the RenderDoc API used for capturing frames is designed with inherently serial operations (not thread-safe) and need to statically indicate to the compiler and end user alike that unsynchronized internal mutation is occurring. As such,
trigger_multi_frame_capture()
should take&mut self
as well.This is technically a breaking API change, but it is critical to fix this in order to prevent unsound behavior in future versions. It should be documented in the
CHANGELOG.md
so users looking to upgrade versions are aware of the change.The text was updated successfully, but these errors were encountered: