Package io.scanbot.sdk.image

Class BufferImageLoadOptions

java.lang.Object

io.scanbot.sdk.image.BufferImageLoadOptions

public class BufferImageLoadOptions
extends Object

Options for loading image from buffer.

Constructor Summary

Constructors

Constructor	Description
BufferImageLoadOptions()	Constructs BufferImageLoadOptions with default parameters.
BufferImageLoadOptions(Rectangle cropRect, ColorConversion colorConversion, CanvasColor canvasColor, BufferLoadMode loadMode)	Constructs BufferImageLoadOptions with the given params.

Method Summary

Modifier and Type	Method	Description
CanvasColor	getCanvasColor()	Getter for canvasColor field.
ColorConversion	getColorConversion()	Getter for colorConversion field.
Rectangle	getCropRect()	Getter for cropRect field.
BufferLoadMode	getLoadMode()	Getter for loadMode field.
void	setCanvasColor(CanvasColor canvasColor)	Setter for canvasColor field.
void	setColorConversion(ColorConversion colorConversion)	Setter for colorConversion field.
void	setCropRect(Rectangle cropRect)	Setter for cropRect field.
void	setLoadMode(BufferLoadMode loadMode)	Setter for loadMode field.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BufferImageLoadOptions

public BufferImageLoadOptions(Rectangle cropRect,
 ColorConversion colorConversion,
 CanvasColor canvasColor,
 BufferLoadMode loadMode)

Constructs BufferImageLoadOptions with the given params.

Parameters:

cropRect - If the rect is not empty, the image will be cropped to this rect before processing.

colorConversion - Color conversion to apply during image loading. Default is `ANY_COLOR`.

canvasColor - CanvasColor color to use when converting images with alpha channel to images without alpha channel. Default is `WHITE`.

loadMode - Load mode. Default is `EAGER`.

BufferImageLoadOptions

public BufferImageLoadOptions()

Constructs BufferImageLoadOptions with default parameters.

Method Details

getCropRect

public Rectangle getCropRect()

Getter for cropRect field. See constructor documentation for more information about the field.

Returns:

cropRect

setCropRect

public void setCropRect(Rectangle cropRect)

Setter for cropRect field. See constructor documentation for more information about the field.

Parameters:

cropRect - Value to set.

getColorConversion

public ColorConversion getColorConversion()

Getter for colorConversion field. See constructor documentation for more information about the field.

Returns:

colorConversion

setColorConversion

public void setColorConversion(ColorConversion colorConversion)

Setter for colorConversion field. See constructor documentation for more information about the field.

Parameters:

colorConversion - Value to set.

getCanvasColor

public CanvasColor getCanvasColor()

Getter for canvasColor field. See constructor documentation for more information about the field.

Returns:

canvasColor

setCanvasColor

public void setCanvasColor(CanvasColor canvasColor)

Setter for canvasColor field. See constructor documentation for more information about the field.

Parameters:

canvasColor - Value to set.

getLoadMode

public BufferLoadMode getLoadMode()

Getter for loadMode field. See constructor documentation for more information about the field.

Returns:

loadMode

setLoadMode

public void setLoadMode(BufferLoadMode loadMode)

Setter for loadMode field. See constructor documentation for more information about the field.

Parameters:

loadMode - Value to set.