From 96f01244b579ad7f1f93321a4538496a26ada54b Mon Sep 17 00:00:00 2001 From: sinamas Date: Mon, 29 Apr 2013 01:15:02 +0200 Subject: [PATCH] libgambatte: s/drawn/completed etc. --- libgambatte/include/gambatte.h | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/libgambatte/include/gambatte.h b/libgambatte/include/gambatte.h index c38f949b5..5713e38f1 100644 --- a/libgambatte/include/gambatte.h +++ b/libgambatte/include/gambatte.h @@ -69,7 +69,7 @@ class GB { * Returns early when a new video frame has finished drawing in the video buffer, * such that the caller may update the video output before the frame is overwritten. * The return value indicates whether a new video frame has been drawn, and the - * exact time (in number of samples) at which it was drawn. + * exact time (in number of samples) at which it was completed. * * @param videoBuf 160x144 RGB32 (native endian) video frame buffer or 0 * @param pitch distance in number of pixels (not bytes) from the start of one line @@ -77,8 +77,8 @@ class GB { * @param audioBuf buffer with space >= samples + 2064 * @param samples in: number of stereo samples to produce, * out: actual number of samples produced - * @return sample number at which the video frame was produced. -1 means no frame - * was produced. + * @return sample offset in audioBuf at which the video frame was completed, or -1 + * if no new video frame was completed. */ std::ptrdiff_t runFor(gambatte::uint_least32_t *videoBuf, std::ptrdiff_t pitch, gambatte::uint_least32_t *audioBuf, std::size_t &samples);