Clarify createScaledBitmap's 'filter' docs

Reddit complained the docs were bad, so make the docs less bad.

Test: none
Change-Id: I61928ea859af4ce0a63a9b545ea1b6dd965cc3df
This commit is contained in:
John Reck
2018-10-22 13:23:12 -07:00
parent cbcaabedfd
commit 7ba6f430f6

View File

@@ -738,7 +738,13 @@ public final class Bitmap implements Parcelable {
* @param src The source bitmap.
* @param dstWidth The new bitmap's desired width.
* @param dstHeight The new bitmap's desired height.
* @param filter true if the source should be filtered.
* @param filter Whether or not bilinear filtering should be used when scaling the
* bitmap. If this is true then bilinear filtering will be used when
* scaling which has better image quality at the cost of worse performance.
* If this is false then nearest-neighbor scaling is used instead which
* will have worse image quality but is faster. Recommended default
* is to set filter to 'true' as the cost of bilinear filtering is
* typically minimal and the improved image quality is significant.
* @return The new scaled bitmap or the source bitmap if no scaling is required.
* @throws IllegalArgumentException if width is <= 0, or height is <= 0
*/