Skip to content

Commit 46d0740

Browse files
author
Jonah Williams
authored
[framework] clean up image provider documentation. (#131416)
Fixes flutter/flutter#130524 loadBuffer was superseded by loadImage
1 parent 80c7dd7 commit 46d0740

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

packages/flutter/lib/src/painting/image_provider.dart

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -162,8 +162,8 @@ class ImageConfiguration {
162162

163163
/// Performs the decode process for use in [ImageProvider.load].
164164
///
165-
/// This typedef is deprecated. Use [DecoderBufferCallback] with
166-
/// [ImageProvider.loadBuffer] instead.
165+
/// This typedef is deprecated. Use [ImageDecoderCallback] with
166+
/// [ImageProvider.loadImage] instead.
167167
///
168168
/// This callback allows decoupling of the `cacheWidth`, `cacheHeight`, and
169169
/// `allowUpscaling` parameters from implementations of [ImageProvider] that do
@@ -247,16 +247,16 @@ typedef ImageDecoderCallback = Future<ui.Codec> Function(
247247
/// using that key. This is handled by [resolveStreamForKey]. That method
248248
/// may fizzle if it determines the image is no longer necessary, use the
249249
/// provided [ImageErrorListener] to report an error, set the completer
250-
/// from the cache if possible, or call [loadBuffer] to fetch the encoded image
250+
/// from the cache if possible, or call [loadImage] to fetch the encoded image
251251
/// bytes and schedule decoding.
252-
/// 4. The [loadBuffer] method is responsible for both fetching the encoded bytes
252+
/// 4. The [loadImage] method is responsible for both fetching the encoded bytes
253253
/// and decoding them using the provided [DecoderCallback]. It is called
254254
/// in a context that uses the [ImageErrorListener] to report errors back.
255255
///
256-
/// Subclasses normally only have to implement the [loadBuffer] and [obtainKey]
256+
/// Subclasses normally only have to implement the [loadImage] and [obtainKey]
257257
/// methods. A subclass that needs finer grained control over the [ImageStream]
258258
/// type must override [createStream]. A subclass that needs finer grained
259-
/// control over the resolution, such as delaying calling [loadBuffer], must override
259+
/// control over the resolution, such as delaying calling [loadImage], must override
260260
/// [resolveStreamForKey].
261261
///
262262
/// The [resolve] method is marked as [nonVirtual] so that [ImageProvider]s can
@@ -610,9 +610,9 @@ abstract class ImageProvider<T extends Object> {
610610
/// Converts a key into an [ImageStreamCompleter], and begins fetching the
611611
/// image.
612612
///
613-
/// This method is deprecated. Implement [loadBuffer] for faster image
614-
/// loading. Only one of [load] and [loadBuffer] must be implemented, and
615-
/// [loadBuffer] is preferred.
613+
/// This method is deprecated. Implement [loadImage] for faster image
614+
/// loading. Only one of [load] and [loadImage] must be implemented, and
615+
/// [loadImage] is preferred.
616616
///
617617
/// The [decode] callback provides the logic to obtain the codec for the
618618
/// image.
@@ -626,7 +626,7 @@ abstract class ImageProvider<T extends Object> {
626626
'This feature was deprecated after v2.13.0-1.0.pre.',
627627
)
628628
ImageStreamCompleter load(T key, DecoderCallback decode) {
629-
throw UnsupportedError('Implement loadBuffer for faster image loading');
629+
throw UnsupportedError('Implement loadImage for faster image loading');
630630
}
631631

632632
/// Converts a key into an [ImageStreamCompleter], and begins fetching the

0 commit comments

Comments
 (0)