Glide/com.bumptech.glide.request/RequestOptions

RequestOptions

open class RequestOptions : BaseRequestOptions<T>

Provides type independent options to customize loads with Glide.

Non-final to allow Glide's generated classes to be assignable to their non-generated equivalents.

Functions

open fun apply(o: BaseRequestOptions<out Any>): T

Updates this options set with any options that are explicitly set in the given T object and returns this object if autoClone is disabled or a new T object if autoClone is enabled.

open fun autoClone(): T

Similar to lock except that mutations cause a clone operation to happen before the mutation resulting in all methods returning a new Object and leaving the original locked object unmodified.

bitmapTransform

open fun bitmapTransform(transformation: Transformation<Bitmap>): RequestOptions

Returns a RequestOptions object with transform set.

open fun centerCrop(): T

Applies CenterCrop to all default types and throws an exception if asked to transform an unknown type.

centerCropTransform

open fun centerCropTransform(): RequestOptions

Returns a RequestOptions object with centerCrop set.

open fun centerInside(): T

Applies CenterInside to all default types, CENTER_INSIDE to image types and throws an exception if asked to transform an unknown type.

centerInsideTransform

open fun centerInsideTransform(): RequestOptions

Returns a RequestOptions object with centerInside set.

open fun circleCrop(): T

Applies CircleCrop to all default types and throws an exception if asked to transform an unknown type.

circleCropTransform

open fun circleCropTransform(): RequestOptions

Returns a RequestOptions object with circleCrop set.

open fun clone(): T

Returns a copy of this request builder with all of the options put so far on this builder.

open fun decode(resourceClass: Class<out Any>): T

open fun decodeTypeOf(resourceClass: Class<out Any>): RequestOptions

Returns a RequestOptions object with decode set.

disallowHardwareConfig

open fun disallowHardwareConfig(): T

Disables the use of HARDWARE in Downsampler to avoid errors caused by inspecting Bitmap pixels, drawing with hardware support disabled, drawing to android.graphics.

diskCacheStrategy

open fun diskCacheStrategy(strategy: DiskCacheStrategy): T

Sets the DiskCacheStrategy to use for this load.

diskCacheStrategyOf

open fun diskCacheStrategyOf(diskCacheStrategy: DiskCacheStrategy): RequestOptions

Returns a RequestOptions object with diskCacheStrategy set.

open fun dontAnimate(): T

Disables resource decoders that return animated resources so any resource returned will be static.

open fun dontTransform(): T

Removes all applied Transformations for all resource classes and allows unknown resource types to be transformed without throwing an exception.

open fun downsample(strategy: DownsampleStrategy): T

Sets the DownsampleStrategy to use when decoding Bitmaps using .

open fun downsampleOf(strategy: DownsampleStrategy): RequestOptions

Returns a RequestOptions object with downsample set.

open fun encodeFormat(format: CompressFormat): T

Sets the value for key COMPRESSION_FORMAT.

open fun encodeFormatOf(format: CompressFormat): RequestOptions

Returns a com.bumptech.glide.request.RequestOptions with encodeFormat called with the given format.

open fun encodeQuality(quality: Int): T

Sets the value for key COMPRESSION_QUALITY.

encodeQualityOf

open fun encodeQualityOf(quality: Int): RequestOptions

Returns a com.bumptech.glide.request.RequestOptions with encodeQuality called with the given quality.

open fun equals(o: Any): Boolean

open fun error(drawable: Drawable): T

Sets a Drawable to display if a load fails.

open fun error(resourceId: Int): T

Sets a resource to display if a load fails.

open fun errorOf(errorDrawable: Drawable): RequestOptions

Returns a RequestOptions object with error set.

open fun errorOf(errorId: Int): RequestOptions

Returns a RequestOptions object with error} set.

open fun fallback(drawable: Drawable): T

Sets an Drawable to display if the model provided to load is null.

open fun fallback(resourceId: Int): T

Sets a resource to display if the model provided to load is null.

open fun fitCenter(): T

Applies FitCenter and to all default types, FIT_CENTER to image types, and throws an exception if asked to transform an unknown type.

fitCenterTransform

open fun fitCenterTransform(): RequestOptions

Returns a RequestOptions object with fitCenter set.

open fun format(format: DecodeFormat): T

Sets the DecodeFormat to use when decoding Bitmap objects using and Glide's default GIF decoders.

open fun formatOf(format: DecodeFormat): RequestOptions

Returns a RequestOptions object with format set.

open fun frame(frameTimeMicros: Long): T

Sets the time position of the frame to extract from a video.

open fun frameOf(frameTimeMicros: Long): RequestOptions

Returns a RequestOptions object with frame set.

open fun hashCode(): Int

isDiskCacheStrategySet

fun isDiskCacheStrategySet(): Boolean

isMemoryCacheable

fun isMemoryCacheable(): Boolean

fun isPrioritySet(): Boolean

isSkipMemoryCacheSet

fun isSkipMemoryCacheSet(): Boolean

isTransformationSet

fun isTransformationSet(): Boolean

isValidOverride

fun isValidOverride(): Boolean

open fun lock(): T

Throws if any further mutations are attempted.

open fun noAnimation(): RequestOptions

Returns a new com.bumptech.glide.request.RequestOptions with dontAnimate called.

noTransformation

open fun noTransformation(): RequestOptions

Returns a RequestOptions object with dontTransform set.

onlyRetrieveFromCache

open fun onlyRetrieveFromCache(flag: Boolean): T

If set to true, will only load an item if found in the cache, and will not fetch from source.

open fun <T> option(option: Option<T>, value: T): RequestOptions

Returns a RequestOptions object with the given Option set via set.

optionalCenterCrop

open fun optionalCenterCrop(): T

Applies com.bumptech.glide.load.resource.bitmap.CenterCrop to all default types, and ignores unknown types.

optionalCenterInside

open fun optionalCenterInside(): T

Applies com.bumptech.glide.load.resource.bitmap.CenterInside to all default types, CENTER_INSIDE to image types, and ignores unknown types.

optionalCircleCrop

open fun optionalCircleCrop(): T

Applies CircleCrop to all default types, and ignores unknown types.

optionalFitCenter

open fun optionalFitCenter(): T

Applies FitCenter and to all default types, FIT_CENTER to image types, and ignores unknown types.

optionalTransform

open fun optionalTransform(transformation: Transformation<Bitmap>): T

Applies the given Transformation for Bitmaps to the default types (Bitmap, android.graphics.drawable.

open fun <Y> optionalTransform(resourceClass: Class<Y>, transformation: Transformation<Y>): T

Applies the given Transformation for any decoded resource of the given type and allows unknown resource types to be ignored.

open fun override(size: Int): T

Overrides the com.bumptech.glide.request.target.Target's width and height with the given size.

open fun override(width: Int, height: Int): T

Overrides the com.bumptech.glide.request.target.Target's width and height with the given values.

open fun overrideOf(size: Int): RequestOptions

Returns a RequestOptions with override set where both the width and height are the given size.

open fun overrideOf(width: Int, height: Int): RequestOptions

Returns a RequestOptions object with override} set.

open fun placeholder(drawable: Drawable): T

Sets an Drawable to display while a resource is loading.

open fun placeholder(resourceId: Int): T

Sets an Android resource id for a Drawable resource to display while a resource is loading.

open fun placeholderOf(placeholder: Drawable): RequestOptions

open fun placeholderOf(placeholderId: Int): RequestOptions

Returns a RequestOptions object with placeholder set.

open fun priority(priority: Any): T

Sets the priority for this load.

open fun priorityOf(priority: Any): RequestOptions

Returns a RequestOptions object with priority} set.

open fun <Y> set(option: Option<Y>, value: Y): T

open fun signature(signature: Key): T

Sets some additional data to be mixed in to the memory and disk cache keys allowing the caller more control over when cached data is invalidated.

open fun signatureOf(signature: Key): RequestOptions

Returns a RequestOptions object with signature set.

open fun sizeMultiplier(sizeMultiplier: Float): T

Applies a multiplier to the com.bumptech.glide.request.target.Target's size before loading the resource.

sizeMultiplierOf

open fun sizeMultiplierOf(sizeMultiplier: Float): RequestOptions

Returns a RequestOptions object with sizeMultiplier set.

skipMemoryCache

open fun skipMemoryCache(skip: Boolean): T

Allows the loaded resource to skip the memory cache.

skipMemoryCacheOf

open fun skipMemoryCacheOf(skipMemoryCache: Boolean): RequestOptions

Returns a RequestOptions object with skipMemoryCache set.

open fun theme(theme: Theme): T

Sets the android.content.res.Resources.

open fun timeout(timeoutMs: Int): T

Sets the read and write timeout for the http requests used to load the image.

open fun timeoutOf(timeout: Int): RequestOptions

Returns a RequestOptions object with timeout set.

open fun transform(transformations: Array<Transformation<Bitmap>>): T

Applies the given Transformations in the given order for Bitmaps to the default types (Bitmap, android.graphics.drawable.

open fun transform(transformation: Transformation<Bitmap>): T

Applies the given Transformation for Bitmaps to the default types (Bitmap, android.graphics.drawable.

open fun <Y> transform(resourceClass: Class<Y>, transformation: Transformation<Y>): T

Applies the given Transformation for any decoded resource of the given type and throws if asked to transform an unknown resource type.

~~open~~ ~~fun~~ ~~transforms~~(transformations: Array<Transformation<Bitmap>>): T

Applies the given Transformations in the given order for Bitmaps to the default types (Bitmap, android.graphics.drawable.

useAnimationPool

open fun useAnimationPool(flag: Boolean): T

If set to true, uses a special java.util.concurrent.Executor that is used exclusively for decoding frames of animated resources, like GIFs.

useUnlimitedSourceGeneratorsPool

open fun useUnlimitedSourceGeneratorsPool(flag: Boolean): T

If set to true, uses a cached unlimited java.util.concurrent.Executor to run the request.

Properties

diskCacheStrategy

open val diskCacheStrategy: DiskCacheStrategy

open val errorId: Int

errorPlaceholder

open val errorPlaceholder: Drawable

fallbackDrawable

open val fallbackDrawable: Drawable

open val fallbackId: Int

open val isLocked: Boolean

isTransformationAllowed

open val isTransformationAllowed: Boolean

isTransformationRequired

open val isTransformationRequired: Boolean

onlyRetrieveFromCache

open val onlyRetrieveFromCache: Boolean

open val options: Options

open val overrideHeight: Int

open val overrideWidth: Int

placeholderDrawable

open val placeholderDrawable: Drawable

open val placeholderId: Int

open val priority: Any

open val resourceClass: Class<out Any>

open val signature: Key

open val sizeMultiplier: Float

open val theme: Theme

transformations

open val transformations: Map<Class<out Any>, Transformation<out Any>>

useAnimationPool

open val useAnimationPool: Boolean

useUnlimitedSourceGeneratorsPool

open val useUnlimitedSourceGeneratorsPool: Boolean