diff options
| author | liamwhite <liamwhite@users.noreply.github.com> | 2022-09-15 10:36:18 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-09-15 10:36:18 -0400 |
| commit | b06ef5d530abdccb56d57d5156c48b68544d8ce8 (patch) | |
| tree | 3184832c48f3f158e19d6ec4339dd92b44e1f842 /src/audio_core/renderer/command/command_buffer.h | |
| parent | 0a63d43ad67ce974f4ee5b883348f686d27ca6a4 (diff) | |
| parent | 2c91fbf7f1384b5cb01e20e4f59e27a1f9bd9a61 (diff) | |
Merge pull request #8901 from lioncash/docs
audio_core: Amend documentation comment tags
Diffstat (limited to 'src/audio_core/renderer/command/command_buffer.h')
| -rw-r--r-- | src/audio_core/renderer/command/command_buffer.h | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/src/audio_core/renderer/command/command_buffer.h b/src/audio_core/renderer/command/command_buffer.h index 496b0e50a..162170846 100644 --- a/src/audio_core/renderer/command/command_buffer.h +++ b/src/audio_core/renderer/command/command_buffer.h @@ -191,6 +191,7 @@ public: * @param volume - Current mix volume used for calculating the ramp. * @param prev_volume - Previous mix volume, used for calculating the ramp, * also applied to the input. + * @param prev_samples - Previous sample buffer. Used for depopping. * @param precision - Number of decimal bits for fixed point operations. */ void GenerateMixRampCommand(s32 node_id, s16 buffer_count, s16 input_index, s16 output_index, @@ -208,6 +209,7 @@ public: * @param volumes - Current mix volumes used for calculating the ramp. * @param prev_volumes - Previous mix volumes, used for calculating the ramp, * also applied to the input. + * @param prev_samples - Previous sample buffer. Used for depopping. * @param precision - Number of decimal bits for fixed point operations. */ void GenerateMixRampGroupedCommand(s32 node_id, s16 buffer_count, s16 input_index, @@ -297,11 +299,11 @@ public: /** * Generate a device sink command, adding it to the command list. * - * @param node_id - Node id of the voice this command is generated for. - * @param buffer_offset - Base mix buffer offset to use. - * @param sink_info - The sink_info to generate this command from. - * @session_id - System session id this command is generated from. - * @samples_buffer - The buffer to be sent to the sink if upsampling is not used. + * @param node_id - Node id of the voice this command is generated for. + * @param buffer_offset - Base mix buffer offset to use. + * @param sink_info - The sink_info to generate this command from. + * @param session_id - System session id this command is generated from. + * @param samples_buffer - The buffer to be sent to the sink if upsampling is not used. */ void GenerateDeviceSinkCommand(s32 node_id, s16 buffer_offset, SinkInfoBase& sink_info, u32 session_id, std::span<s32> samples_buffer); |
