Note stride params of HalfFloatPlane are in bytes

The HalfFloatPlane() function does not follow libyuv's convention of buffer
stride in units of the corresponding buffer pointer. Document that.

Change-Id: Id8d466ccc2df263a49ad788ab349bc3993a48259
Reviewed-on: https://chromium-review.googlesource.com/c/libyuv/libyuv/+/5770639
Reviewed-by: Frank Barchard <fbarchard@chromium.org>
This commit is contained in:
Wan-Teh Chang 2024-08-07 13:34:26 -07:00 committed by Frank Barchard
parent 3cf54e90d3
commit 02e2ff4745

View File

@ -766,6 +766,10 @@ int ARGBPolynomial(const uint8_t* src_argb,
// Convert plane of 16 bit shorts to half floats.
// Source values are multiplied by scale before storing as half float.
//
// Note: Unlike other libyuv functions that operate on uint16_t buffers, the
// src_stride_y and dst_stride_y parameters of HalfFloatPlane() are in bytes,
// not in units of uint16_t.
LIBYUV_API
int HalfFloatPlane(const uint16_t* src_y,
int src_stride_y,