Fix ResizeImage documentation (#157619)

Whoever reviewed the documentation changes in #154212 neglected to double-check that the information was accurate (it was me who did this).

Fixes #136508
This commit is contained in:
Nate Wilson 2024-10-29 18:46:11 -06:00 committed by GitHub
parent 47318592d1
commit 7ee7fff210
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -1194,19 +1194,16 @@ enum ResizeImagePolicy {
/// Instructs Flutter to decode the image at the specified dimensions
/// instead of at its native size.
///
/// The [width] and [height] parameters refer to logical pixels.
///
/// Logical pixels have roughly the same visual size across devices, whereas
/// physical pixels correspond to actual device hardware.
/// The number of physical pixels per logical pixel is described by the
/// [ui.FlutterView.devicePixelRatio].
///
/// This allows finer control of the size of the image in [ImageCache] and is
/// generally used to reduce the memory footprint of [ImageCache].
///
/// The decoded image may still be displayed at sizes other than the
/// cached size provided here.
///
/// The [width] and [height] parameters determine the image resolution.
/// These values also set the image's width & height in logical pixels
/// if it is unconstrained.
///
/// {@tool snippet}
/// This example shows how to size the image to half of the screen's width.
///
@ -1219,6 +1216,11 @@ enum ResizeImagePolicy {
/// );
/// ```
/// {@end-tool}
///
/// See also:
///
/// * [ui.FlutterView.devicePixelRatio], used to convert between physical and
/// logical pixels.
class ResizeImage extends ImageProvider<ResizeImageKey> {
/// Creates an ImageProvider that decodes the image to the specified size.
///