Language

BitmapFactory.Options Class

Definition

Holds bitmap-decoding requests and the decoder's reported image information.

[Android.Runtime.Register("android/graphics/BitmapFactory$Options", DoNotGenerateAcw=true)]
public class BitmapFactory.Options : Java.Lang.Object
[<Android.Runtime.Register("android/graphics/BitmapFactory$Options", DoNotGenerateAcw=true)>]
type BitmapFactory.Options = class
    inherit Object
Inheritance
BitmapFactory.Options
Attributes

Remarks

Android platform documentation

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Constructors

Name Description
BitmapFactory.Options()

Create a default Options object, which if left unchanged will give the same result from the decoder as if null were passed.

BitmapFactory.Options(IntPtr, JniHandleOwnership)

A constructor used when creating managed representations of JNI objects; called by the runtime.

Properties

Name Description
Class

Returns the runtime class of this Object.

(Inherited from Object)
Handle

The handle to the underlying Android instance.

(Inherited from Object)
InBitmap

If set, decode methods that take the Options object will attempt to reuse this bitmap when loading content.

InDensity

The pixel density to use for the bitmap.

InDither
Obsolete.

This member is deprecated.

InInputShareable
Obsolete.

This member is deprecated.

InJustDecodeBounds

If set to true, the decoder will return null (no bitmap), but the out... fields will still be set, allowing the caller to query the bitmap without having to allocate the memory for its pixels.

InMutable

If set, decode methods will always return a mutable Bitmap instead of an immutable one.

InPreferQualityOverSpeed
Obsolete.

This member is deprecated.

InPreferredColorSpace

If this is non-null, the decoder will try to decode into this color space.

InPreferredConfig

If this is non-null, the decoder will try to decode into this internal configuration.

InPremultiplied

If true (which is the default), the resulting bitmap will have its color channels pre-multiplied by the alpha channel.

InPurgeable
Obsolete.

This member is deprecated.

InSampleSize

If set to a value > 1, requests the decoder to subsample the original image, returning a smaller image to save memory.

InScaled

When this flag is set, if #inDensity and #inTargetDensity are not 0, the bitmap will be scaled to match #inTargetDensity when loaded, rather than relying on the graphics system scaling it each time it is drawn to a Canvas.

InScreenDensity

The pixel density of the actual screen that is being used.

InTargetDensity

The pixel density of the destination this bitmap will be drawn to.

InTempStorage

Temp storage to use for decoding.

JniIdentityHashCode

Gets the identity hash code assigned to this Java peer by the interop runtime.

(Inherited from Object)
JniManagedPeerState

Gets the state flags last assigned by the runtime.

(Inherited from JavaObject)
JniPeerMembers

Gets the JNI metadata used to access members of this Java binding.

MCancel
Obsolete.

This member is deprecated.

OutColorSpace

If known, the color space the decoded bitmap will have.

OutConfig

If known, the config the decoded bitmap will have.

OutHeight

The resulting height of the bitmap.

OutMimeType

If known, this string is set to the mimetype of the decoded image.

OutWidth

The resulting width of the bitmap.

PeerReference

Gets the JNI object reference for this Java peer.

(Inherited from Object)
ThresholdClass

This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.

ThresholdType

This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.

Methods

Name Description
Clone()

Creates and returns a copy of this object.

(Inherited from Object)
Construct(JniObjectReference, JniObjectReferenceOptions)

Delegates construction of this peer to the runtime's value manager.

(Inherited from JavaObject)
Dispose()

Releases the resources held by this Java peer.

(Inherited from Object)
Dispose(Boolean)

Releases the resources held by this Java peer.

(Inherited from Object)
DisposeUnlessReferenced()

Asks the value manager to dispose this peer unless its mapping retains this same managed instance.

(Inherited from JavaObject)
Equals(Object)

Tests whether another managed peer refers to the same Java object.

(Inherited from JavaObject)
Equals(Object)

Indicates whether some other object is "equal to" this one.

(Inherited from Object)
GetHashCode()

Returns a hash code value for the object.

(Inherited from Object)
JavaFinalize()
Obsolete.

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

(Inherited from Object)
Notify()

Wakes up a single thread that is waiting on this object's monitor.

(Inherited from Object)
NotifyAll()

Wakes up all threads that are waiting on this object's monitor.

(Inherited from Object)
RequestCancelDecode()
Obsolete.

This member is deprecated.

SetHandle(IntPtr, JniHandleOwnership)

Sets the Handle property.

(Inherited from Object)
SetPeerReference(JniObjectReference, JniObjectReferenceOptions)

Stores a reference value in the control block without creating a JNI reference copy.

(Inherited from JavaObject)
ToArray<T>()

Creates a managed array from this Java array wrapper.

(Inherited from Object)
ToString()

Returns a string representation of the object.

(Inherited from Object)
UnregisterFromRuntime()

Unregisters this Java peer from the interop runtime.

(Inherited from Object)
Wait()

Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>.

(Inherited from Object)
Wait(Int64, Int32)

Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed.

(Inherited from Object)
Wait(Int64)

Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed.

(Inherited from Object)

Explicit Interface Implementations

Name Description
IJavaPeerable.Disposed()

Marks this peer as disposed and calls Dispose with disposing set to true.

(Inherited from JavaObject)
IJavaPeerable.Finalized()

Marks this peer as disposed and calls Dispose with disposing set to false.

(Inherited from JavaObject)
IJavaPeerable.JniObjectReferenceControlBlock

Gets the native control-block pointer used by this peer.

(Inherited from JavaObject)
IJavaPeerable.SetJniIdentityHashCode(Int32)

Stores the identity hash code supplied by the runtime.

(Inherited from JavaObject)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates)

Replaces the stored managed peer state flags.

(Inherited from JavaObject)
IJavaPeerable.SetPeerReference(JniObjectReference)

Updates the peer reference and releases a disposed peer's control block when the reference is invalid.

(Inherited from JavaObject)

Extension Methods

Name Description
GetJniTypeName(IJavaPeerable)

Gets the JNI name of the type of the instance self.

JavaAs<TResult>(IJavaPeerable)

Try to coerce self to type TResult, checking that the coercion is valid on the Java side.

JavaCast<TResult>(IJavaObject)

Performs an Android runtime-checked type conversion.

JavaCast<TResult>(IJavaObject)

Reuses a compatible managed peer or obtains a wrapper of the requested type.

TryJavaCast<TResult>(IJavaPeerable, TResult)

Try to coerce self to type TResult, checking that the coercion is valid on the Java side.

Applies to