Skip to content

Commit

Permalink
Fix incorrect documentation for retro_audio_sample_batch_t (#16965)
Browse files Browse the repository at this point in the history
retro_audio_sample_batch_t returns the number of processed frames, *not* samples.

- See `audio_driver_sample_batch` in `audio_driver.h`
  • Loading branch information
JesseTG authored Sep 7, 2024
1 parent c87a88f commit c0715fc
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion libretro-common/include/libretro.h
Original file line number Diff line number Diff line change
Expand Up @@ -7426,7 +7426,7 @@ typedef void (RETRO_CALLCONV *retro_audio_sample_t)(int16_t left, int16_t right)
* is defined as a sample of left and right channels, interleaved.
* For example: <tt>int16_t buf[4] = { l, r, l, r };</tt> would be 2 frames.
*
* @return The number of samples that were processed.
* @return The number of frames that were processed.
*
* @see retro_set_audio_sample_batch()
* @see retro_set_audio_sample()
Expand Down

0 comments on commit c0715fc

Please sign in to comment.