Class ImageRef

Namespace

IO.Scanbot.Sdk.Image

Assembly

DocumentSDK.NET.Droid.dll

[Register("io/scanbot/sdk/image/ImageRef", DoNotGenerateAcw = true)]
public sealed class ImageRef : Drawable, IParcelable, IAutoCloseable, IJavaObject, IJavaPeerable, IDisposable

Inheritance

object

Object

Drawable

ImageRef

Implements

IParcelable

IAutoCloseable

IJavaObject

IJavaPeerable

IDisposable

Inherited Members

Drawable.ScheduleSelf(Action, long)

Drawable.UnscheduleSelf(Action)

Drawable.ApplyTheme(Resources.Theme)

Drawable.CanApplyTheme()

Drawable.ClearColorFilter()

Drawable.CopyBounds()

Drawable.CopyBounds(Rect)

Drawable.CreateFromPath(string)

Drawable.CreateFromPathAsync(string)

Drawable.CreateFromResourceStream(Resources, TypedValue, Stream, string, BitmapFactory.Options)

Drawable.CreateFromResourceStreamAsync(Resources, TypedValue, Stream, string, BitmapFactory.Options)

Drawable.CreateFromResourceStream(Resources, TypedValue, Stream, string)

Drawable.CreateFromResourceStreamAsync(Resources, TypedValue, Stream, string)

Drawable.CreateFromStream(Stream, string)

Drawable.CreateFromStreamAsync(Stream, string)

Drawable.CreateFromXml(Resources, XmlReader, Resources.Theme)

Drawable.CreateFromXmlAsync(Resources, XmlReader, Resources.Theme)

Drawable.CreateFromXml(Resources, XmlReader)

Drawable.CreateFromXmlAsync(Resources, XmlReader)

Drawable.CreateFromXmlInner(Resources, XmlReader, IAttributeSet, Resources.Theme)

Drawable.CreateFromXmlInner(Resources, XmlReader, IAttributeSet)

Drawable.GetConstantState()

Drawable.GetHotspotBounds(Rect)

Drawable.GetOutline(Outline)

Drawable.GetPadding(Rect)

Drawable.GetState()

Drawable.Inflate(Resources, XmlReader, IAttributeSet, Resources.Theme)

Drawable.InflateAsync(Resources, XmlReader, IAttributeSet, Resources.Theme)

Drawable.Inflate(Resources, XmlReader, IAttributeSet)

Drawable.InflateAsync(Resources, XmlReader, IAttributeSet)

Drawable.InvalidateSelf()

Drawable.JumpToCurrentState()

Drawable.Mutate()

Drawable.OnLayoutDirectionChanged(int)

Drawable.ResolveOpacity(int, int)

Drawable.ScheduleSelf(IRunnable, long)

Drawable.SetBounds(int, int, int, int)

Drawable.SetCallback(Drawable.ICallback)

Drawable.SetColorFilter(Color, PorterDuff.Mode)

Drawable.SetDither(bool)

Drawable.SetFilterBitmap(bool)

Drawable.SetHotspot(float, float)

Drawable.SetHotspotBounds(int, int, int, int)

Drawable.SetLayoutDirection(LayoutDirection)

Drawable.SetLevel(int)

Drawable.SetState(int[])

Drawable.SetTint(int)

Drawable.SetTintBlendMode(BlendMode)

Drawable.SetTintList(ColorStateList)

Drawable.SetTintMode(PorterDuff.Mode)

Drawable.SetVisible(bool, bool)

Drawable.UnscheduleSelf(IRunnable)

Drawable.Alpha

Drawable.AutoMirrored

Drawable.Bounds

Drawable.Callback

Drawable.ChangingConfigurations

Drawable.ColorFilter

Drawable.Current

Drawable.DirtyBounds

Drawable.HasFocusStateSpecified

Drawable.IntrinsicHeight

Drawable.IntrinsicWidth

Drawable.IsFilterBitmap

Drawable.IsProjected

Drawable.IsStateful

Drawable.IsVisible

Drawable.LayoutDirection

Drawable.Level

Drawable.MinimumHeight

Drawable.MinimumWidth

Drawable.OpticalInsets

Drawable.TransparentRegion

Object.Dispose()

Object.GetObject<T>(nint, nint, JniHandleOwnership)

Object.GetObject<T>(nint, JniHandleOwnership)

Object.FromArray<T>(T[])

Object.Equals(Object)

Object.GetHashCode()

Object.Notify()

Object.NotifyAll()

Object.ToString()

Object.Wait()

Object.Wait(long, int)

Object.Wait(long)

Object.Class

object.Equals(object)

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

ImageRef(UUID, bool)

[Register(".ctor", "(Ljava/util/UUID;Z)V", "")]
public ImageRef(UUID uniqueId, bool acquireStrongReference)

Parameters

uniqueId UUID

acquireStrongReference bool

Properties

Opacity

Return the opacity/transparency of this Drawable.

[Obsolete("deprecated")]
public override int Opacity { get; }

Property Value

int

To be added.

Remarks

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.

UniqueId

public UUID UniqueId { get; }

Property Value

UUID

Methods

AcquireSerializedReference(UUID)

[Register("acquireSerializedReference", "(Ljava/util/UUID;)Z", "")]
public static bool AcquireSerializedReference(UUID p0)

Parameters

p0 UUID

Returns

bool

Clear()

[Register("clear", "()V", "")]
public void Clear()

Close()

Closes this resource, relinquishing any underlying resources.

[Register("close", "()V", "")]
public void Close()

Remarks

<p>Closes this resource, relinquishing any underlying resources.

This method is invoked automatically on objects managed by the try-with-resources statement.

Java documentation for

java.lang.AutoCloseable.close()

.

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.

Exceptions

Exception

DescribeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

[Register("describeContents", "()I", "")]
public int DescribeContents()

Returns

int

a bitmask indicating the set of special object types marshaled by this Parcelable object instance.

Remarks

<p>Describe the kinds of special objects contained in this Parcelable

instance's marshaled representation. For example, if the object will include a file descriptor in the output of #writeToParcel(Parcel, int), the return value of this method must include the #CONTENTS_FILE_DESCRIPTOR bit.

Java documentation for

android.os.Parcelable.describeContents()

.

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.

Deserialize(string)

[Register("deserialize", "(Ljava/lang/String;)Lio/scanbot/sdk/image/ImageRef;", "")]
public static ImageRef Deserialize(string source)

Parameters

source string

Returns

ImageRef

Draw(Canvas)

Draw in its bounds (set via setBounds) respecting optional effects such as alpha (set via setAlpha) and color filter (set via setColorFilter).

[Register("draw", "(Landroid/graphics/Canvas;)V", "")]
public override void Draw(Canvas canvas)

Parameters

canvas Canvas

The canvas to draw into

Remarks

<p>Draw in its bounds (set via setBounds) respecting optional effects such

as alpha (set via setAlpha) and color filter (set via setColorFilter).

Java documentation for

android.graphics.drawable.Drawable.draw(android.graphics.Canvas)

.

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.

EncodeImage()

[Register("encodeImage", "()Lio/scanbot/common/Result;", "")]
public IResult EncodeImage()

Returns

IResult

EncodeImage(EncodeImageOptions)

[Register("encodeImage", "(Lio/scanbot/sdk/image/EncodeImageOptions;)Lio/scanbot/common/Result;", "")]
public IResult EncodeImage(EncodeImageOptions options)

Parameters

options EncodeImageOptions

Returns

IResult

FromBitmap(Bitmap)

[Register("fromBitmap", "(Landroid/graphics/Bitmap;)Lio/scanbot/sdk/image/ImageRef;", "")]
public static ImageRef FromBitmap(Bitmap bitmap)

Parameters

bitmap Bitmap

Returns

ImageRef

FromBitmap(Bitmap, BasicImageLoadOptions)

[Register("fromBitmap", "(Landroid/graphics/Bitmap;Lio/scanbot/sdk/image/BasicImageLoadOptions;)Lio/scanbot/sdk/image/ImageRef;", "")]
public static ImageRef FromBitmap(Bitmap p0, BasicImageLoadOptions p1)

Parameters

p0 Bitmap

p1 BasicImageLoadOptions

Returns

ImageRef

FromEncodedBuffer(ByteBuffer)

[Register("fromEncodedBuffer", "(Ljava/nio/ByteBuffer;)Lio/scanbot/sdk/image/ImageRef;", "")]
public static ImageRef FromEncodedBuffer(ByteBuffer encodedBuffer)

Parameters

encodedBuffer ByteBuffer

Returns

ImageRef

FromEncodedBuffer(ByteBuffer, BufferImageLoadOptions)

[Register("fromEncodedBuffer", "(Ljava/nio/ByteBuffer;Lio/scanbot/sdk/image/BufferImageLoadOptions;)Lio/scanbot/sdk/image/ImageRef;", "")]
public static ImageRef FromEncodedBuffer(ByteBuffer encodedBuffer, BufferImageLoadOptions options)

Parameters

encodedBuffer ByteBuffer

options BufferImageLoadOptions

Returns

ImageRef

FromEncodedBuffer(byte[])

[Register("fromEncodedBuffer", "([B)Lio/scanbot/sdk/image/ImageRef;", "")]
public static ImageRef FromEncodedBuffer(byte[] encodedBuffer)

Parameters

encodedBuffer byte[]

Returns

ImageRef

FromEncodedBuffer(byte[], BufferImageLoadOptions)

[Register("fromEncodedBuffer", "([BLio/scanbot/sdk/image/BufferImageLoadOptions;)Lio/scanbot/sdk/image/ImageRef;", "")]
public static ImageRef FromEncodedBuffer(byte[] p0, BufferImageLoadOptions p1)

Parameters

p0 byte[]

p1 BufferImageLoadOptions

Returns

ImageRef

FromInputStream(Stream)

[Register("fromInputStream", "(Ljava/io/InputStream;)Lio/scanbot/sdk/image/ImageRef;", "")]
public static ImageRef FromInputStream(Stream inputStream)

Parameters

inputStream Stream

Returns

ImageRef

FromInputStream(Stream, BufferImageLoadOptions)

[Register("fromInputStream", "(Ljava/io/InputStream;Lio/scanbot/sdk/image/BufferImageLoadOptions;)Lio/scanbot/sdk/image/ImageRef;", "")]
public static ImageRef FromInputStream(Stream inputStream, BufferImageLoadOptions options)

Parameters

inputStream Stream

options BufferImageLoadOptions

Returns

ImageRef

FromJson(JSONObject)

[Register("fromJson", "(Lorg/json/JSONObject;)Lio/scanbot/sdk/image/ImageRef;", "")]
public static ImageRef FromJson(JSONObject source)

Parameters

source JSONObject

Returns

ImageRef

FromJson(IDictionary<string, Object>)

[Register("fromJson", "(Ljava/util/Map;)Lio/scanbot/sdk/image/ImageRef;", "")]
public static ImageRef FromJson(IDictionary<string, Object> source)

Parameters

source IDictionary<string, Object>

Returns

ImageRef

FromNv21(byte[], int, int)

[Register("fromNv21", "([BII)Lio/scanbot/sdk/image/ImageRef;", "")]
public static ImageRef FromNv21(byte[] nv21, int width, int height)

Parameters

nv21 byte[]

width int

height int

Returns

ImageRef

FromNv21(byte[], int, int, RawImageLoadOptions)

[Register("fromNv21", "([BIILio/scanbot/sdk/image/RawImageLoadOptions;)Lio/scanbot/sdk/image/ImageRef;", "")]
public static ImageRef FromNv21(byte[] p0, int p1, int p2, RawImageLoadOptions p3)

Parameters

p0 byte[]

p1 int

p2 int

p3 RawImageLoadOptions

Returns

ImageRef

FromPath(string)

[Register("fromPath", "(Ljava/lang/String;)Lio/scanbot/sdk/image/ImageRef;", "")]
public static ImageRef FromPath(string path)

Parameters

path string

Returns

ImageRef

FromPath(string, PathImageLoadOptions)

[Register("fromPath", "(Ljava/lang/String;Lio/scanbot/sdk/image/PathImageLoadOptions;)Lio/scanbot/sdk/image/ImageRef;", "")]
public static ImageRef FromPath(string p0, PathImageLoadOptions p1)

Parameters

p0 string

p1 PathImageLoadOptions

Returns

ImageRef

FromSerializedReference(UUID)

[Register("fromSerializedReference", "(Ljava/util/UUID;)Lio/scanbot/sdk/image/ImageRef;", "")]
public static ImageRef FromSerializedReference(UUID uniqueId)

Parameters

uniqueId UUID

Returns

ImageRef

FromYUV420(ByteBuffer, int, int, ByteBuffer, int, int, ByteBuffer, int, int, int, int)

[Register("fromYUV420", "(Ljava/nio/ByteBuffer;IILjava/nio/ByteBuffer;IILjava/nio/ByteBuffer;IIII)Lio/scanbot/sdk/image/ImageRef;", "")]
public static ImageRef FromYUV420(ByteBuffer yPlaneBuffer, int yPlaneRowStride, int yPlanePixelStride, ByteBuffer uPlaneBuffer, int uPlaneRowStride, int uPlanePixelStride, ByteBuffer vPlaneBuffer, int vPlaneRowStride, int vPlanePixelStride, int width, int height)

Parameters

yPlaneBuffer ByteBuffer

yPlaneRowStride int

yPlanePixelStride int

uPlaneBuffer ByteBuffer

uPlaneRowStride int

uPlanePixelStride int

vPlaneBuffer ByteBuffer

vPlaneRowStride int

vPlanePixelStride int

width int

height int

Returns

ImageRef

FromYUV420(ByteBuffer, int, int, ByteBuffer, int, int, ByteBuffer, int, int, int, int, RawImageLoadOptions)

[Register("fromYUV420", "(Ljava/nio/ByteBuffer;IILjava/nio/ByteBuffer;IILjava/nio/ByteBuffer;IIIILio/scanbot/sdk/image/RawImageLoadOptions;)Lio/scanbot/sdk/image/ImageRef;", "")]
public static ImageRef FromYUV420(ByteBuffer yPlaneBuffer, int yPlaneRowStride, int yPlanePixelStride, ByteBuffer uPlaneBuffer, int uPlaneRowStride, int uPlanePixelStride, ByteBuffer vPlaneBuffer, int vPlaneRowStride, int vPlanePixelStride, int width, int height, RawImageLoadOptions options)

Parameters

yPlaneBuffer ByteBuffer

yPlaneRowStride int

yPlanePixelStride int

uPlaneBuffer ByteBuffer

uPlaneRowStride int

uPlanePixelStride int

vPlaneBuffer ByteBuffer

vPlaneRowStride int

vPlanePixelStride int

width int

height int

options RawImageLoadOptions

Returns

ImageRef

Hibernate()

[Register("hibernate", "()Lio/scanbot/common/Result;", "")]
public IResult Hibernate()

Returns

IResult

Info()

[Register("info", "()Lio/scanbot/common/Result;", "")]
public IResult Info()

Returns

IResult

InvalidateDrawable()

[Register("invalidateDrawable", "()V", "")]
public void InvalidateDrawable()

RegisterPlatformImageDecoders()

[Register("registerPlatformImageDecoders", "()V", "")]
public static void RegisterPlatformImageDecoders()

ReleaseAllImages()

[Register("releaseAllImages", "()V", "")]
public static void ReleaseAllImages()

ReleaseStrongReference(UUID)

[Register("releaseStrongReference", "(Ljava/util/UUID;)Z", "")]
public static bool ReleaseStrongReference(UUID p0)

Parameters

p0 UUID

Returns

bool

RenderToBitmap(Bitmap)

[Register("renderToBitmap", "(Landroid/graphics/Bitmap;)Lio/scanbot/common/Result;", "")]
public IResult RenderToBitmap(Bitmap target)

Parameters

target Bitmap

Returns

IResult

RenderToHardwareBuffer(HardwareBuffer)

[Register("renderToHardwareBuffer", "(Landroid/hardware/HardwareBuffer;)Lio/scanbot/common/Result;", "")]
public IResult RenderToHardwareBuffer(HardwareBuffer target)

Parameters

target HardwareBuffer

Returns

IResult

SaveImage(string)

[Register("saveImage", "(Ljava/lang/String;)Lio/scanbot/common/Result;", "")]
public IResult SaveImage(string path)

Parameters

path string

Returns

IResult

SaveImage(string, SaveImageOptions)

[Register("saveImage", "(Ljava/lang/String;Lio/scanbot/sdk/image/SaveImageOptions;)Lio/scanbot/common/Result;", "")]
public IResult SaveImage(string path, SaveImageOptions options)

Parameters

path string

options SaveImageOptions

Returns

IResult

Serialize()

[Register("serialize", "()Ljava/lang/String;", "")]
public string Serialize()

Returns

string

SetAlpha(int)

Specify an alpha value for the drawable.

[Register("setAlpha", "(I)V", "")]
public override void SetAlpha(int alpha)

Parameters

alpha int

To be added.

Remarks

<p>Specify an alpha value for the drawable. 0 means fully transparent, and

255 means fully opaque.

Java documentation for

android.graphics.drawable.Drawable.setAlpha(int)

.

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.

SetColorFilter(ColorFilter)

Specify an optional color filter for the drawable.

[Register("setColorFilter", "(Landroid/graphics/ColorFilter;)V", "")]
public override void SetColorFilter(ColorFilter colorFilter)

Parameters

colorFilter ColorFilter

The color filter to apply, or null to remove the existing color filter

Remarks

<p>Specify an optional color filter for the drawable.</p>
<p>If a Drawable has a ColorFilter, each output pixel of the Drawable's

drawing contents will be modified by the color filter before it is blended onto the render target of a Canvas.

Pass null to remove any existing color filter.

<strong>Note:</strong> Setting a non-null color filter disables #setTintList(ColorStateList) tint.

Java documentation for

android.graphics.drawable.Drawable.setColorFilter(android.graphics.ColorFilter)

.

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.

SetHibernationCacheDirPath(string)

[Register("setHibernationCacheDirPath", "(Ljava/lang/String;)Lio/scanbot/common/Result;", "")]
public static IResult SetHibernationCacheDirPath(string p0)

Parameters

p0 string

Returns

IResult

SetHibernationJpegQuality(int)

[Register("setHibernationJpegQuality", "(I)V", "")]
public static void SetHibernationJpegQuality(int p0)

Parameters

p0 int

SetOptimizeDrawableSize(bool)

[Register("setOptimizeDrawableSize", "(Z)V", "")]
public void SetOptimizeDrawableSize(bool optimizeImageSize)

Parameters

optimizeImageSize bool

SetStorageCryptingProvider(ICoreStreamProvider)

[Register("setStorageCryptingProvider", "(Lio/scanbot/sdk/persistence/fileio/CoreStreamProvider;)Lio/scanbot/common/Result;", "")]
public static IResult SetStorageCryptingProvider(ICoreStreamProvider p0)

Parameters

p0 ICoreStreamProvider

Returns

IResult

ToBitmap()

[Register("toBitmap", "()Lio/scanbot/common/Result;", "")]
public IResult ToBitmap()

Returns

IResult

ToJson(ImageSerializationMode)

[Register("toJson", "(Lio/scanbot/sdk/common/ImageSerializationMode;)Lorg/json/JSONObject;", "")]
public JSONObject ToJson(ImageSerializationMode imageSerializationMode)

Parameters

imageSerializationMode ImageSerializationMode

Returns

JSONObject

UpgradeSerializedReference(UUID)

[Register("upgradeSerializedReference", "(Ljava/util/UUID;)Z", "")]
public static bool UpgradeSerializedReference(UUID p0)

Parameters

p0 UUID

Returns

bool

WriteToParcel(Parcel, ParcelableWriteFlags)

Flatten this object in to a Parcel.

[Register("writeToParcel", "(Landroid/os/Parcel;I)V", "")]
public void WriteToParcel(Parcel parcel, ParcelableWriteFlags flags)

Parameters

parcel Parcel

flags ParcelableWriteFlags

Additional flags about how the object should be written. May be 0 or #PARCELABLE_WRITE_RETURN_VALUE.

Remarks

Flatten this object in to a Parcel.

Java documentation for

android.os.Parcelable.writeToParcel(android.os.Parcel, int)

.

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.