com.googlecode.leptonica.android

Class Pix

com.googlecode.leptonica.android.Pix

public class Pix

Java representation of a native Leptonica PIX object.

Field Detail

INDEX_W

public static int INDEX_W

Index of the image width within the dimensions array.

See Also:

Constant Field Values

INDEX_H

public static int INDEX_H

Index of the image height within the dimensions array.

See Also:

Constant Field Values

INDEX_D

public static int INDEX_D

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

See Also:

Constant Field Values

Constructor Detail

Pix

public Pix(long nativePix)

Creates a new Pix wrapper for the specified native PIX object.

Parameters:

nativePix - A pointer to the native PIX object.

Pix

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

Method Detail

getNativePix

public long 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:

org.jetbrains.dokka.NodeRenderContent@7fcbdc37: a native pointer to the Pix object

getData

public kotlin.Array[] getData()

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

Returns:

org.jetbrains.dokka.NodeRenderContent@731e10e5: a copy of this PIX object's raw data

getDimensions

public kotlin.Array[] getDimensions()

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

Returns:

org.jetbrains.dokka.NodeRenderContent@45300783: an array of this image's dimensions or null on failure

getDimensions

public boolean getDimensions(@Size
                             kotlin.Array[] 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:

org.jetbrains.dokka.NodeRenderContent@16617cb4: 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.

Returns:

org.jetbrains.dokka.NodeRenderContent@37ea302b: 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:

org.jetbrains.dokka.NodeRenderContent@3470870b: a copy of the Pix

invert

public boolean invert()

Inverts this Pix in-place.

Returns:

org.jetbrains.dokka.NodeRenderContent@71398219: 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.

createFromPix

public static Pix createFromPix(kotlin.Array[] 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:

org.jetbrains.dokka.NodeRenderContent@6ca0c456: 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:

org.jetbrains.dokka.NodeRenderContent@a2dda81: a Rect with the width and height of this Pix

getWidth

public int getWidth()

Returns the width of this Pix.

Returns:

org.jetbrains.dokka.NodeRenderContent@3a554c10: the width of this Pix

getHeight

public int getHeight()

Returns the height of this Pix.

Returns:

org.jetbrains.dokka.NodeRenderContent@7412809: the height of this Pix

getDepth

public int getDepth()

Returns the depth of this Pix.

Returns:

org.jetbrains.dokka.NodeRenderContent@6d29dec3: the depth of this Pix

getRefCount

public int getRefCount()

getPixel

public int getPixel(int x,
                    int y)

Returns the android.graphics.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:

org.jetbrains.dokka.NodeRenderContent@9b4e835: The argb android.graphics.Color at the specified coordinate.

Throws:

IllegalArgumentException - If x, y exceeds the image bounds.

setPixel

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

Sets the android.graphics.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 android.graphics.Color to set at the specified coordinate.

Throws:

IllegalArgumentException - If x, y exceeds the image bounds.