com.aspose.drawing

Class Bitmap

java.lang.Object

com.aspose.drawing.Image

com.aspose.drawing.Bitmap

All Implemented Interfaces:

com.aspose.ms.System.IDisposable

public class Bitmap
extends Image

Encapsulates a bitmap, which consists of the pixel data for a graphics image and its attributes. A Bitmap is an object used to work with images defined by pixel data.

Nested Class Summary

Nested classes/interfaces inherited from class com.aspose.drawing.Image

Image.GetThumbnailImageAbort

Constructor Summary

Constructors

Constructor and Description
Bitmap(Image original) Initializes a new instance of the Bitmap class from the specified existing image.
Bitmap(Image original, int width, int height) Initializes a new instance of the Bitmap class from the specified existing image, scaled to the specified size.
Bitmap(Image original, Size newSize) Initializes a new instance of the Bitmap class from the specified existing image, scaled to the specified size.
Bitmap(InputStream stream) Initializes a new instance of the Bitmap class from the specified data stream.
Bitmap(InputStream stream, boolean useIcm) Initializes a new instance of the Bitmap class from the specified data stream.
Bitmap(int width, int height) Initializes a new instance of the Bitmap class with the specified size.
Bitmap(int width, int height, int format) Initializes a new instance of the Bitmap class with the specified size and format.
Bitmap(int width, int height, int stride, int format, int[] data) Initializes a new instance of the Bitmap class with the specified size and pixel data.
Bitmap(String filename) Initializes a new instance of the Bitmap class from the specified file.
Bitmap(String filename, boolean useIcm) Initializes a new instance of the Bitmap class from the specified file.

Method Summary

Modifier and Type	Method and Description
Bitmap	deepClone(RectangleF rect, int format) Creates a copy of the section of this Bitmap defined with a specified PixelFormat enumeration.
Bitmap	deepClone(Rectangle rect, int format) Creates a copy of the section of this Bitmap defined by Rectangle structure and with a specified PixelFormat(Image.getPixelFormat()) enumeration.
UUID[]	getFrameDimensionsList() Gets an array of GUIDs that represent the dimensions of frames within this Image.
int	getHeight() Gets the height, in pixels, of this Bitmap.
ColorPalette	getPalette() Gets or sets the color palette used for this Image.
Color	getPixel(int x, int y) Gets the color of the specified pixel in this Bitmap.
int	getPixelFormat() Gets the pixel format for this Image.
int[]	getPropertyIdList() Gets IDs of the property items stored in this Image.
PropertyItem	getPropertyItem(int propid) Gets the specified property item from this Image.
PropertyItem[]	getPropertyItems() Gets all the property items (pieces of metadata) stored in this Image.
ImageFormat	getRawFormat() Gets the file format of this Image.
int	getWidth() Gets the width, in pixels, of this Bitmap.
BitmapData	lockBits(Rectangle rect, int flags, int format) Locks a Bitmap into system memory.
void	makeTransparent() Makes the specified color transparent for this Bitmap.
void	makeTransparent(Color transparentColor) Makes the specified color transparent for this Bitmap.
void	readArgb32Pixels(int[] pixels) Reads bitmap pixels in ARGB32 format into given array.
void	removePropertyItem(int propid) Removes the specified property item from this Image.
void	rotateFlip(int rotateFlipType) This method rotates, flips, or rotates and flips the Image.
void	setPalette(ColorPalette value) Gets or sets the color palette used for this Image.
void	setPixel(int x, int y, Color color) Sets the color of the specified pixel in this Bitmap.
void	setPropertyItem(PropertyItem propitem) Stores a property item (piece of metadata) in this Image.
void	setResolution(float xDpi, float yDpi) Sets the resolution for this Bitmap.
void	unlockBits(BitmapData bitmapData) Unlocks this Bitmap from system memory.
void	writeArgb32Pixels(int[] pixels) Writes pixels to the bitmap.

Methods inherited from class com.aspose.drawing.Image

deepClone, dispose, fromFile, fromHbitmap, fromStream, fromStream, getBounds, getFlags, getFrameCount, getHorizontalResolution, getPhysicalDimension, getPixelFormatSize, getSize, getTag, getThumbnailImage, getVerticalResolution, isAlphaPixelFormat, save, save, save, save, save, saveAdd, saveAdd, selectActiveFrame, setTag

Methods inherited from class java.lang.Object

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

Constructor Detail

Bitmap

public Bitmap(int width,
              int height)

Initializes a new instance of the Bitmap class with the specified size.

Parameters:

width - The width, in pixels, of the new Bitmap.

height - The height, in pixels, of the new Bitmap.

Bitmap

public Bitmap(String filename)

Initializes a new instance of the Bitmap class from the specified file.

Parameters:

filename - The name of the bitmap file.

Bitmap

public Bitmap(String filename,
              boolean useIcm)

Initializes a new instance of the Bitmap class from the specified file.

Parameters:

filename - The name of the bitmap file.

useIcm - true to use color correction for this Bitmap; otherwise, false.

Bitmap

public Bitmap(InputStream stream)

Initializes a new instance of the Bitmap class from the specified data stream.

Parameters:

stream - The data stream used to load the image.

Bitmap

public Bitmap(InputStream stream,
              boolean useIcm)

Initializes a new instance of the Bitmap class from the specified data stream.

Parameters:

stream - The data stream used to load the image.

useIcm - true to use color correction for this Bitmap; otherwise, false.

Bitmap

public Bitmap(int width,
              int height,
              int format)

Initializes a new instance of the Bitmap class with the specified size and format.

Parameters:

width - The width, in pixels, of the new Bitmap.

height - The height, in pixels, of the new Bitmap.

format - The PixelFormat(Image.getPixelFormat()) enumeration for the new Bitmap.

Bitmap

public Bitmap(int width,
              int height,
              int stride,
              int format,
              int[] data)

Initializes a new instance of the Bitmap class with the specified size and pixel data.

Parameters:

width - The width, in pixels, of the new Bitmap.

height - The height, in pixels, of the new Bitmap.

stride - The byte offset between the beginning of one scan line and the next, must be a multiple of four.

format - The PixelFormat(Image.getPixelFormat()) enumeration for the new Bitmap.

data - The pixel data.

Bitmap

public Bitmap(Image original)

Initializes a new instance of the Bitmap class from the specified existing image.

Parameters:

original - The Image from which to create the new Bitmap.

Bitmap

public Bitmap(Image original,
              Size newSize)

Initializes a new instance of the Bitmap class from the specified existing image, scaled to the specified size.

Parameters:

original - The Image from which to create the new Bitmap

newSize - The Size(Image.getSize()) structure that represent the size of the new Bitmap.

Bitmap

public Bitmap(Image original,
              int width,
              int height)

Initializes a new instance of the Bitmap class from the specified existing image, scaled to the specified size.

Parameters:

original - The Image from which to create the new Bitmap.

width - The width, in pixels, of the new Bitmap.

height - The height, in pixels, of the new Bitmap.

Method Detail

getWidth

public int getWidth()

Gets the width, in pixels, of this Bitmap.

Specified by:

getWidth in class Image

getHeight

public int getHeight()

Gets the height, in pixels, of this Bitmap.

Specified by:

getHeight in class Image

getRawFormat

public ImageFormat getRawFormat()

Gets the file format of this Image.

Specified by:

getRawFormat in class Image

Returns:

The ImageFormat that represents the file format of this Image.

getPixelFormat

public int getPixelFormat()

Gets the pixel format for this Image.

Specified by:

getPixelFormat in class Image

Returns:

A PixelFormat(Image.getPixelFormat()) that represents the pixel format for this Image.

getPalette

public ColorPalette getPalette()

Gets or sets the color palette used for this Image.

Specified by:

getPalette in class Image

Returns:

A ColorPalette that represents the color palette used for this Image.

setPalette

public void setPalette(ColorPalette value)

Gets or sets the color palette used for this Image.

Specified by:

setPalette in class Image

getFrameDimensionsList

public UUID[] getFrameDimensionsList()

Gets an array of GUIDs that represent the dimensions of frames within this Image.

Overrides:

getFrameDimensionsList in class Image

Returns:

An array of GUIDs that specify the dimensions of frames within this Image from most significant to least significant.

getPropertyIdList

public int[] getPropertyIdList()

Gets IDs of the property items stored in this Image.

Specified by:

getPropertyIdList in class Image

Returns:

An array of the property IDs, one for each property item stored in this image.

getPropertyItems

public PropertyItem[] getPropertyItems()

Gets all the property items (pieces of metadata) stored in this Image.

Specified by:

getPropertyItems in class Image

Returns:

An array of PropertyItem objects, one for each property item stored in the image.

deepClone

public final Bitmap deepClone(Rectangle rect,
                              int format)

Creates a copy of the section of this Bitmap defined by Rectangle structure and with a specified PixelFormat(Image.getPixelFormat()) enumeration.

Parameters:

rect - Defines the portion of this Bitmap to copy. Coordinates are relative to this Bitmap.

format - Specifies the PixelFormat(Image.getPixelFormat()) enumeration for the destination Bitmap.

Returns:

The new Bitmap that this method creates.

deepClone

public final Bitmap deepClone(RectangleF rect,
                              int format)

Creates a copy of the section of this Bitmap defined with a specified PixelFormat enumeration.

Parameters:

rect - Defines the portion of this Bitmap to copy.

format - Specifies the PixelFormat enumeration for the destination Bitmap.

Returns:

The Bitmap that this method creates.

Throws:

com.aspose.ms.System.OutOfMemoryException - rect is outside of the source bitmap bounds.

com.aspose.ms.System.ArgumentException - The height or width of rect is 0.

setResolution

public final void setResolution(float xDpi,
                                float yDpi)

Sets the resolution for this Bitmap.

Parameters:

xDpi - The horizontal resolution, in dots per inch, of the Bitmap.

yDpi - The vertical resolution, in dots per inch, of the Bitmap.

lockBits

public final BitmapData lockBits(Rectangle rect,
                                 int flags,
                                 int format)

Locks a Bitmap into system memory.

Parameters:

rect - A Rectangle structure specifying the portion of the Bitmap to lock.

flags - An ImageLockMode enumeration specifying the access level (read/write) for the Bitmap.

format - A PixelFormat(Image.getPixelFormat()) enumeration specifying the data format of this Bitmap.

Returns:

A BitmapData containing information about this lock operation.

unlockBits

public final void unlockBits(BitmapData bitmapData)

Unlocks this Bitmap from system memory.

Parameters:

bitmapData - A BitmapData specifying information about the lock operation.

getPixel

public final Color getPixel(int x,
                            int y)

Gets the color of the specified pixel in this Bitmap.

Parameters:

x - The x-coordinate of the pixel to retrieve.

y - The y-coordinate of the pixel to retrieve.

Returns:

A Color structure that represents the color of the specified pixel.

setPixel

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

Sets the color of the specified pixel in this Bitmap.

Parameters:

x - The x-coordinate of the pixel to set.

y - The y-coordinate of the pixel to set.

color - A Color structure that represents the color to assign to the specified pixel.

readArgb32Pixels

public final void readArgb32Pixels(int[] pixels)

Reads bitmap pixels in ARGB32 format into given array.

Parameters:

pixels - Array to place bitmap pixels. Must have enough capacity.

writeArgb32Pixels

public final void writeArgb32Pixels(int[] pixels)

Writes pixels to the bitmap.

Parameters:

pixels - Array with source pixels in ARGB32 format. Must have enough length.

makeTransparent

public final void makeTransparent()

Makes the specified color transparent for this Bitmap.

makeTransparent

public final void makeTransparent(Color transparentColor)

Makes the specified color transparent for this Bitmap.

Parameters:

transparentColor - The Color structure that represents the color to make transparent.

Throws:

com.aspose.ms.System.InvalidOperationException - The image format of the Bitmap is an icon format.

com.aspose.ms.System.Exception - The operation failed.

rotateFlip

public void rotateFlip(int rotateFlipType)

This method rotates, flips, or rotates and flips the Image.

Specified by:

rotateFlip in class Image

Parameters:

rotateFlipType - A RotateFlipType member that specifies the type of rotation and flip to apply to the image.

getPropertyItem

public PropertyItem getPropertyItem(int propid)

Gets the specified property item from this Image.

Specified by:

getPropertyItem in class Image

Parameters:

propid - The ID of the property item to get.

Returns:

The PropertyItem this method gets.

removePropertyItem

public void removePropertyItem(int propid)

Removes the specified property item from this Image.

Specified by:

removePropertyItem in class Image

Parameters:

propid - The ID of the property item to remove.

setPropertyItem

public void setPropertyItem(PropertyItem propitem)

Stores a property item (piece of metadata) in this Image.

Specified by:

setPropertyItem in class Image

Parameters:

propitem - The PropertyItem to be stored.