Translations: 简体中文
Caution
- The 4.x version has undergone a lot of destructive reconstruction and simplification to be compatible with Compose Multiplatform, and is not compatible with the 3.x version.
- The maven groupId is upgraded to
io.github.panpf.sketch4, so versions 2.* and 3.* will not prompt for upgrade.
core:
- new: Added Image.asBitmap(), asBitmapOrNull(), asDrawableOrNull(), asPainterOrNull() extension functions
- improve: The defaultImage property of ConditionStateImage and ComposableConditionStateImage is now nullable
decode:
- improve: Improve to determine whether regional decoding is supported based on mimeType. Non-image types directly return false. On non-Android platforms, based on the skiko version, it is determined whether heic, heif, and avi types are supported.
fetch:
- improve: AssetUriFetcher and ResourceUriFetcher are now compatible with the sketch3 protocol
core:
- fix: Fixed a bug that caused REMOVE records to be lost due to disk cache being killed, and re-initialization did not verify whether the file existed, causing size() exceptions. #219
animated:
- fix: Fixed the bug that the dependency of sketch-animated-heif accidentally included the local test module. #220
core:
- remove: Remove Image.getPixels()
- remove: Remove the AnyThread, MainThread, IntRange, and IntDef annotations under the ' com.github.panpf.sketch.annotation' package and use the alternatives under the ' androidx.annotation' package
- change: Merge AndroidBitmapImage and SkiaBitmapImage into BitmapImage
- change: DrawableEqualizer renamed to EquitableDrawable
- change: Remove AndroidBitmap, SkiBitmap, SkiaImageInfo, SkiaImage, SkiaRect
- change: SkiaAnimatedImage renamed to AnimatedImage
- change: ImageRequest's registerListener and registerProgressListener methods renamed to addListener and addProgressListener
- new: Added ComponentLoader, which supports automatic detection and registration of Fetcher and Decoder components. All components in the built-in module are supported.
compose:
- fix: Fix the bug that the filterQuality parameter of AsyncImage is invalid. #211
- remove: Remove ComposeBitmapImage
- remove: Remove PainterState.Empty
- change: PainterEqualizer renamed to EquitablePainter
- change: ComposeImagePainter renamed to ImageBitmapPainter, SkiaAnimatedImagePainter renamed to AnimatedImagePainter
view:
- fix: Fix the bug that the image cannot be loaded when the ImageView is attached to the window but size is null due to padding. #208
decode:
- change: Decoder's decode() method removes the suspend modifier and changes the return type from Result to DecodeResult
- change: BitmapConfig refactored to BitmapColorType
- new: Non-Android platforms now also support ColorType
- new: Non-Android platforms now also support ColorSpace
- new: DrawableDecoder supports colorSpace
fetch:
- change: The parameter passed in Fetcher.Factory.create() is changed to RequestContext
cache:
- change: SkiaBitmapImage is now cached in the memory cache on non-Android platforms, not ComposeBitmapImage.
- change: The default memory cache size is now 256MB for desktop and web platforms and 128MB for ios platforms
http:
- remove: Removed the setHttpHeader() and addHttpHeader() methods of ImageRequest.Builder and ImageOptions.Builder
- change: Remove the sketch-http-core module, add the sketch-http-hurl module, rename the sketch-http-ktor module to sketch-http-ktor2 and no longer support wasmJs, add the sketch-http-ktor3 module
animated:
- fix: Fixed the bug that on non-Android platforms, animations set repeatCount and do not stay on the last frame after playing, but stay on the first frame. #212
- fix: Fixed the bug that GifDrawable and MovieDrawable could not apply animatedTransformation correctly. #214
- fix: Fixed the bug that the repeatCount setting of GifDrawableDecoder should be increased by 1 by mistake. #215
- change: Split the sketch-animated module into sketch-animated-core and sketch-animated-gif, sketch-animated-webp, sketch-animated-heif, sketch-animated-koralgif module and rename it to sketch-animated-gif-koral
- improve: animatedTransformation now supports non-Android platforms
transformation:
- fix: Fix the bug that CircleCrop, Rotate, RoundedCorners Transformation does not work at RGB_565. #209
- fix: Fixed the bug that Transformations such as blur and rotate on the Android platform did not keep the ColorSpace unchanged. #213
- change: Transformation's transform() method removes the suspend modifier
state:
- change: The type of error attribute of ImageRequest and ImageOptions changed from ErrorImageState to StateImage
- change: ErrorImageState is refactored into ConditionStateImage, and ConditionStateImage can be used in placeholder and fallback
- improve: Improve IconDrawable, support fixed-size background and restrict icons to have fixed sizes or specify iconSize
- improve: Improve IconPainter, support fixed-size background and restrict icons to have fixed sizes or specify iconSize
- new: Added 'Drawable.asStateImage(Any)' and 'ColorDrawable.asStateImage()' extension functions
extensions:
- fix: Fixed the bug that the equals method of RingProgressDrawable, SectorProgressDrawable, RingProgressPainter, SectorProgressPainter did not execute as expected. #210
- change: Split the sketch-extensions-apkicon and sketch-extensions-appicon modules from the sketch-extensions-core module
other:
- depend: Upgrade kotlin 2.0.21, kotlinx coroutines 1.9.0
- depend: Upgrade jetbrains compose 1.7.0, jetbrains lifecycle 2.8.3
- fix: Fixed the bug that the ComposableImageRequest() and ComposableImageOptions() functions cannot listen and update the Compose State. #207
- fix: Fix the bug that CircleCrop, Rotate, RoundedCorners Transformation does not work at RGB_565. #209
- remove: Remove SkiaExifOrientationHelper
- remove: DataSource removes sketch and request attributes
- change: DataSource's getFile() and getFileOrNull() methods add Sketch parameters
- change: DataSource's openSourceOrNull() and getFileOrNull() methods are now available as extension functions
- change: RequestContext moved to 'com.github.panpf.sketch.request' package
- new: SkiaBitmapImage now supports memory caching
- new: DataSource adds key attribute
- improve: SkiaAnimatedImagePainter now does not share Bitmap for decoding and drawing to avoid cluttered images. #206
- improve: SkiaAnimatedImagePainter now still does not start animation when drawing, it will automatically load the first frame
- new: SkiaAnimatedImagePainter now supports caching frames that take longer to decode than the frame duration to improve playback smoothness, but this uses more memory, closed by default, enabled through 'cacheDecodeTimeoutFrame()' function
- fix: Fixed a bug where SkiaAnimatedImagePainter crashed when encountering disguised gif images. #205
- improve: Improve the accuracy of animation-related Decoder in determining the image type. No longer rely on the mimeType attribute of FetchResult because it may be inaccurate.
- fix: Fix the bug of exception when AppIconUriFetcher.Factory parses versionCode. #204
- change: KotlinResourceUriFetcher supported uri changed from 'kotlin.resource://' to 'file:///kotlin_resource/'
- change: ComposeResourceUriFetcher supported uri changed from 'compose.resource://' to file:///compose_resource/
- change: The uri supported by ResourceUriFetcher has been changed from 'android.resource: //resource?resType=drawable&resName=ic_launcher' and 'android.resource://resource?resId=1031232' to 'android.resource:///drawable/ic_launcher' and ' android.resource:///1031232'
- change: AssetUriFetcher supported uri changed from 'asset://' to 'file:///android_asset/'
- change: ImageRequest.uri property type changed from String to Uri
- improve: All implementation classes of DataSource implement equals and hashCode methods
- improve: All implementation classes of Fetcher implement equals and hashCode methods
- fix: Fixed the issue where HurlStack and OkHttpStack failed to control network concurrency due to switching threads again. #199
- fix: Fixed the bug that decoding pictures will not start until all network tasks are completed. #201
- change: The mergeComponents() method of ImageOptions and ImageRequest has been renamed to addComponents()
- change: The drawableResId parameter of ImageView.loadImage() and newResourceUri() functions was renamed to resId
- change: AndroidLogPipeline and PrintLogPipeline are changed to singleton mode
- improve: Check the type of PlatformContext to prevent passing Activity to Sketch or ImageRequest
- new: Add PlatformContext.sketch and View.sketch extension functions
- new: Sketch.Builder and ComponentRegistry.Builder added addComponents() function
- new: Sketch.Builder adds networkParallelismLimited() and decodeParallelismLimited() methods to control the number of network and decoding concurrency. #200
- change: ComposeBitmapValue renamed to ComposeBitmapImageValue
- change: Refactor Sketch.enqueueDownload() and executeDownload() and move from sketch-extensions-core module to sketch-core module
- change: LongImageClipPrecisionDecider renamed to LongImagePrecisionDecider, LongImageStartCropScaleDecider renamed to LongImageScaleDecider
- change: Revert to using screen size as final Size when building ImageRequest
- improve: Painter.asSketchImage() now returns PainterImage; ComposeBitmap.asSketchImage() now returns ComposeBitmapImage
- new: ImageRequest.Builder and ImageOptions.Builder add sizeWithView(), sizeWithDisplay(), size( IntSize) extension functions
- change: ImageView.disposeLoad() renamed to ImageView.disposeLoad()
- new: Added ImageRequest.Builder.composableError() and ImageOptions.Builder.composableError() extension functions
- new: Added ErrorStateImage.Builder.saveCellularTrafficError(DrawableResource) extension function
request:
- change: There is no longer a distinction between Display, Load and Download, now there is only one ImageRequest, ImageResult and ImageListener
- change: The requestKey attribute of ImageResult has been removed, and the requestCacheKey attribute has been renamed to cacheKey.
- change: Now Target, ImageResult, DecodeResult all use Image
- change: SketchDrawable's imageUri, requestKey, requestCacheKey, imageInfo, dataFrom, transformedList, extras and other properties have been removed, now please get them from ImageResult
- change: depth and depthFrom properties merged into DepthHolder
- change: Android platform-specific APIs such as bitmapConfig, colorSpace, preferQualityOverSpeed, placeholder(Int), fallback(Int), error(Int), etc. are provided in the form of extension functions
- change: resizeApplyToDrawable renamed to resizeOnDraw
- change: Parameters renamed to Extras
- new: Added 'sizeMultiplier: Float' attribute to set the scaling ratio of the image size
- new: Added 'allowNullImage: Boolean' attribute
decode:
- change: BitmapDecoder and DrawableDecoder merged into Decoder
- change: BitmapDecodeInterceptor and DrawableDecodeInterceptor merged into DecodeInterceptor
cache:
- delete: Remove BitmapPool and its related disallowReuseBitmap attribute, CountBitmap, and SketchCountBitmapDrawable classes
- change: Refactor DiskCache SnapShot and Editor, get() and edit() are changed to openSnapShot() and openEditor(), and openSnapShot() and openEditor() of the same key now conflict with each other, openEditor always returns null before openSnapshot is closed.
- change: Refactor MemoryCache.Value
state:
- change: uriEmpty attribute of ImageRequest and ImageOptions renamed to fallback
- delete: Delete ErrorStateImage.Builder.uriEmptyError()
other:
- change: SketchSingleton refactored into SingletonSketch
- change: displayImage renamed to loadImage
- delete: AsyncImage composable function removes placeholder, error, uriEmpty, onLoading, onSuccess, onError parameters
- upgrade：Compose Multiplatform upgraded to 1.6.10
- new: AsyncImageState can now set ImageOptions, for example: 'rememberAsyncImageState { ImageOptions() }'
- upgrade：Android minimum API raised to API 21
- upgrade：kotlin is upgraded to 2.0.0, mainly to support Compose Multiplatform 1.6.10