Meet us at PRINT 19. Chicago, IL. Oct. 3 - 5.
This documentation is for the old version. Go to the latest Graphics Mill docs

Bitmap Members

The Bitmap type exposes the following members.

Constructors

Name Description
Public method Bitmap Overloaded.

Creates empty Bitmap instance.

Methods

Name Description
Public method {dtor}

Enables using delete operator in C++ applications. It is strongly not recommended to use it directly.

Public method Abort

Aborts currently running operation.

Public method Clear

Clears the image and sets all pixels to the specified color.

Public method ClearHistory

Discards both undo and redo history.

Public method ClearRedoHistory

Discards redo history.

Public method ClearUndoHistory

Discards undo history.

Public method Clone

Creates a full copy of bitmap. All the bitmap data and object properties are copied.

Public method Create Overloaded.

Discards old bitmap data and creates new bitmap

Public method Deserialize

Deserializes the bitmap object.

Public method Dispose

Releases all resources used by this Bitmap.

(Overrides LockableObject.Dispose().)
Public method Draw Overloaded.

Draws a bitmap on various surfaces as Bitmap, GdiGraphics, System.Drawing.Graphics classes, or Windows GDI device context.

Public method Equals (Inherited from Object.)
Public method Export

Returns pixels of bitmap as 3D array.

Public method Static member FromClipboard

Extracts the image data from the clipboard and creates the Bitmap class instance containing this image data.

Public method Static member FromHdc

Extracts the image data from the specified device context and creates the Bitmap class instance containing this image data.

Public method GetEmptyMask

Returns grayscale image of the same size as current bitmap filled with black color. It can be used as mask template for transforms.

Public method GetGdiGraphics

Returns GdiGraphics object associated with this Bitmap.

Public method GetGdiplusGraphics

Returns System.Drawing.Graphics object associated with this Bitmap.

Public method GetHashCode (Inherited from Object.)
Public method GetObjectData

Populates a SerializationInfo with the data needed to serialize the Bitmap object.

Public method GetPixel

Returns pixel value at specified coordinates.

Public method GetType (Inherited from Object.)
Public method HorizontalPixelsToUnits

Converts horizontal value from pixels to unit specified in Unit property.

(Inherited from UnitConverterObject.)
Public method HorizontalUnitsToPixels

Converts horizontal value from unit specified in Unit property to pixels.

(Inherited from UnitConverterObject.)
Public method Import

Fills pixels of the current bitmap from given 3D array.

Public method Load Overloaded.

Loads the bitmap from some external source.

Public method LoadFromClipboard

Loads the bitmap from the clipboard.

Public method LoadFromHdc

Captures a bitmap from the specified device context.

Public method LoadThumbnail Overloaded.

Loads the thumbnail from specified file on-the-fly.

Public method Lock

Locks the object.

(Inherited from LockableObject.)
Public method LockBits Overloaded.

Locks a rectangular area of the bitmap and returns BitmapData object which provides direct access to pixels (without copying).

Protected method MemberwiseClone (Inherited from Object.)
Public method Redo Overloaded.

Redoes last undone change.

Public method Save Overloaded.

Saves the bitmap into specified file.

Public method SaveState

Saves state of the object.

Public method SaveToClipboard

Saves the bitmap into the clipboard.

Public method Serialize

Serializes the bitmap object.

Public method SetPixel

Sets pixel value at the specified coordinates.

Public method ToGdiplusBitmap

Returns System.Drawing.Bitmap containing a copy of the image stored in current Bitmap class instance.

Public method ToGdiplusBitmapDirectly

Returns System.Drawing.Bitmap which references to the same bitmap data as the current Bitmap class instance.

Public method ToString (Inherited from Object.)
Public method Undo Overloaded.

Undoes last made change.

Public method Unload

Unloads bitmap data.

Public method Unlock

Unlocks the object previously locked with method Lock().

(Inherited from LockableObject.)
Public method UnlockBits

Unlocks previously locked area of bitmap with LockBits(Int32, Int32, Int32, Int32) method.

Public method VerticalPixelsToUnits

Converts vertical value from pixels to unit specified in Unit property.

(Inherited from UnitConverterObject.)
Public method VerticalUnitsToPixels

Converts vertical value from unit specified in Unit property to pixels.

(Inherited from UnitConverterObject.)

Operators

Name Description
Public operator Static member Implicit Overloaded.

Cast this instance of the Aurigma.GraphicsMill.Bitmap to System.Drawing.Bitmap or vice versa.

Properties

Name Description
Public property BitsLocked

Indicates if pixels are locked with LockBits(Int32, Int32, Int32, Int32).

Public property BitsPerPixel

Returns number of bits per pixel.

Public property CanRedo

Indicates if last reverted action can be redone.

Public property CanUndo

Indicates if last bitmap modification can be undone.

Public property Channels

Returns object which provides access to various operations with bitmap channels.

Public property ColorAdjustment

Returns object providing methods which are responsible for color adjustment and tone correction (brightness/contrast, levels, hue/saturation/lightness adjustment, etc.).

Public property ColorManagement

Returns object providing methods which are responsible for color management.

Public property ColorProfile

Gets/sets color profile associated with the bitmap.

Public property ColorSpace

Indicates color space of the current bitmap.

Public property CompressSerializedData

Gets/sets a value that specifies whether to compress data during serialization.

Public property Handle

Gets a GDI handle to the bitmap (HBITMAP).

Public property HasAlpha

Specifies whether current pixel format supports alpha channel (information about opacity of pixels).

Public property Height

Returns current bitmap height in pixels.

Public property HorizontalResolution

Specifies horizontal resolution of the image (also known as DPI, dots per inch).

(Inherited from UnitConverterObject.)
Public property IsCmyk

Indicates if color space of current bitmap is CMYK.

Public property IsDisposed (Inherited from LockableObject.)
Public property IsEmpty

Indicates if bitmap is empty (no bitmap data loaded).

Public property IsExtended

Indicates if current pixel format is extended (i.e. 16 bits per channel).

Public property IsGrayScale

Indicates if color space of current bitmap is grayscale.

Public property IsIndexed

Indicates if current bitmap is indexed (palette-based).

Public property IsRgb

Indicates if color space of current bitmap is RGB.

Public property Locked

Indicates if the object has been locked.

(Inherited from LockableObject.)
Public property LogicalHeight

Returns current bitmap height in units specified with Unit property.

Public property LogicalWidth

Returns current bitmap width in units specified with Unit property.

Public property MaxUndoStepCount

Gets/sets maximum number of available undo steps (levels).

Public property MemoryUsed

Returns a number of bytes occupied with pixels of this Bitmap.

Public property Modified

Indicates if the bitmap was changed since last saving.

Public property Palette

Returns palette accosiated with bitmap.

Public property PixelFormat

Returns pixel format of the current bitmap.

Public property RedoStepCount

Returns number of available redo levels (i.e. how much time method Redo() can be called).

Public property Statistics

Returns an object providing methods which retrieves bitmap stats (like histogram, etc).

Public property Timeout

Gets/sets value specifying maximum time for which object can be locked.

(Inherited from LockableObject.)
Public property Transforms

Returns object providing methods which are responsible for geometric transformations of the bitmap (resize, rotate, crop, swirl, etc).

Public property UndoRedoEnabled

Enables or disables undo/redo functionality.

Public property UndoRedoTrackingEnabled

Enables or disables the automatic change tracking.

Public property UndoStepCount

Returns number of available undo levels (i.e. how much time method Undo() can be called).

Public property Unit

Gets/sets unit to convert from/to.

(Inherited from UnitConverterObject.)
Public property VerticalResolution

Specifies vertical resolution (also known as DPI, dots per inch).

(Inherited from UnitConverterObject.)
Public property Width

Returns current bitmap width in pixels.

Events

Name Description
Protected event Changed

Fires when the bitmap was modified (after the end of an operation).

Protected event Changing

Fires before an image is being modified (before the start of an operation).

Protected event Progress

Fires on progress notifications of the currently applied operation.

Public event Redoing

Fires when image is being redone (before starting).

Public event Redone

Fires when operation has been redone (after finishing).

Public event Saved

Fires when the image has been saved (after finishing).

Protected event Saving

Fires when image is being saved (before starting).

Public event StateRestored

Fires when the bitmap state is restored (redone or undone).

Protected event Undoing

Fires when image is being undone (before starting).

Public event Undone

Fires when operation has been undone (after finishing).

See Also

Reference