com.googlecode.leptonica.android

Class Pix

java.lang.Object

com.googlecode.leptonica.android.Pix

public class Pix
extends Object

Java representation of a native Leptonica PIX object.

Author:

alanv@google.com (Alan Viverette)

Field Summary

Fields

Modifier and Type	Field and Description
static int	INDEX_D Index of the image bit-depth within the dimensions array.
static int	INDEX_H Index of the image height within the dimensions array.
static int	INDEX_W Index of the image width within the dimensions array.

Constructor Summary

Constructors

Constructor and Description
Pix(int nativePix) Creates a new Pix wrapper for the specified native PIX object.
Pix(int width, int height, int depth)

Method Summary

Methods

Modifier and Type	Method and Description
Pix	clone() Returns a clone of this Pix.
Pix	copy() Returns a deep copy of this Pix that can be modified without affecting the original Pix.
static Pix	createFromPix(byte[] pixData, int width, int height, int depth) Creates a new Pix from raw Pix data obtained from getData().
protected void	finalize()
byte[]	getData() Return the raw bytes of the native PIX object.
int	getDepth() Returns the depth of this Pix.
int[]	getDimensions() Returns an array of this image's dimensions.
boolean	getDimensions(int[] dimensions) Fills an array with this image's dimensions.
int	getHeight() Returns the height of this Pix.
int	getNativePix() Returns a pointer to the native Pix object.
int	getPixel(int x, int y) Returns the Color at the specified location.
android.graphics.Rect	getRect() Returns a Rect with the width and height of this Pix.
int	getWidth() Returns the width of this Pix.
boolean	invert() Inverts this Pix in-place.
void	recycle() Releases resources and frees any memory associated with this Pix.
void	setPixel(int x, int y, int color) Sets the Color at the specified location.

Methods inherited from class java.lang.Object

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

Field Detail

INDEX_W

public static final int INDEX_W

Index of the image width within the dimensions array.

See Also:

Constant Field Values

INDEX_H

public static final int INDEX_H

Index of the image height within the dimensions array.

See Also:

Constant Field Values

INDEX_D

public static final int INDEX_D

Index of the image bit-depth within the dimensions array.

See Also:

Constant Field Values

Constructor Detail

Pix

public Pix(int nativePix)

Creates a new Pix wrapper for the specified native PIX object. Never call this twice on the same native pointer, because finalize() will attempt to free native memory twice.

Parameters:

nativePix - A pointer to the native PIX object.

Pix

public Pix(int width,
   int height,
   int depth)

Method Detail

getNativePix

public int getNativePix()

Returns a pointer to the native Pix object. This is used by native code and is only valid within the same process in which the Pix was created.

Returns:

a native pointer to the Pix object

getData

public byte[] getData()

Return the raw bytes of the native PIX object. You can reconstruct the Pix from this data using createFromPix().

Returns:

a copy of this PIX object's raw data

getDimensions

public int[] getDimensions()

Returns an array of this image's dimensions. See Pix.INDEX_* for indices.

Returns:

an array of this image's dimensions or null on failure

getDimensions

public boolean getDimensions(int[] dimensions)

Fills an array with this image's dimensions. The array must be at least 3 elements long.

Parameters:

dimensions - An integer array with at least three elements.

Returns:

true on success

clone

public Pix clone()

Returns a clone of this Pix. This does NOT create a separate copy, just a new pointer that can be recycled without affecting other clones.

Overrides:

clone in class Object

Returns:

a clone (shallow copy) of the Pix

copy

public Pix copy()

Returns a deep copy of this Pix that can be modified without affecting the original Pix.

Returns:

a copy of the Pix

invert

public boolean invert()

Inverts this Pix in-place.

Returns:

true on success

recycle

public void recycle()

Releases resources and frees any memory associated with this Pix. You may not modify or access the pix after calling this method.

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

createFromPix

public static Pix createFromPix(byte[] pixData,
                int width,
                int height,
                int depth)

Creates a new Pix from raw Pix data obtained from getData().

Parameters:

pixData - Raw pix data obtained from getData().

width - The width of the original Pix.

height - The height of the original Pix.

depth - The bit-depth of the original Pix.

Returns:

a new Pix or null on error

getRect

public android.graphics.Rect getRect()

Returns a Rect with the width and height of this Pix.

Returns:

a Rect with the width and height of this Pix

getWidth

public int getWidth()

Returns the width of this Pix.

Returns:

the width of this Pix

getHeight

public int getHeight()

Returns the height of this Pix.

Returns:

the height of this Pix

getDepth

public int getDepth()

Returns the depth of this Pix.

Returns:

the depth of this Pix

getPixel

public int getPixel(int x,
           int y)

Returns the Color at the specified location.

Parameters:

x - The x coordinate (0...width-1) of the pixel to return.

y - The y coordinate (0...height-1) of the pixel to return.

Returns:

The argb Color at the specified coordinate.

Throws:

IllegalArgumentException - If x, y exceeds the image bounds.

setPixel

public void setPixel(int x,
            int y,
            int color)

Sets the Color at the specified location.

Parameters:

x - The x coordinate (0...width-1) of the pixel to set.

y - The y coordinate (0...height-1) of the pixel to set.

color - The argb Color to set at the specified coordinate.

Throws:

IllegalArgumentException - If x, y exceeds the image bounds.