←Select platform
In This Topic ▼

RasterImage Class Members

Summary

The following tables list the members exposed by RasterImage.

Protected Constructors

Name Description
Protected Constructor RasterImage This constructor is required by ISerializable.

Public Methods

Name Description
Public Method Access Provides exclusive access to the image data contained in this RasterImage.
Public Method AccessData Provides exclusive access to the image data contained in this RasterImage.
Public Method AddBeziersToRegion Creates or updates the image region by adding a Bézier region.
Public Method AddBorderToRegion Creates a region of pixels with values that fall within a range defined by the value of a specific pixel and a lower and upper tolerance value but are not equal to the _borderColor_.
Public Method AddColorHsvRangeToRegion Creates or updates the image region by adding a region that consists of all the pixels that fall in the given HSV color range.
Public Method AddColorRgbRangeToRegion Creates or updates the image region by adding a region that consists of all the pixels that fall in the given RGB color range.
Public Method AddColorToRegion Creates or updates the image region by adding a region that consists of all the pixels of a specified color.
Public Method AddCurveToRegion Creates or updates the image region by adding a curved region.
Public Method AddEllipseToRegion Creates or updates the image region by adding an elliptical region.
Public Method AddMagicWandToRegion Sets a region based on the color found at point x, y in the image.
Public Method AddMaskToRegion Creates or updates the image region by adding a region that consists of all the white pixels in a 1-bit mask image.
Public Method AddPage Adds a new page to this RasterImage.
Public Method AddPages Adds one or more images to this RasterImage.
Public Method AddPolygonToRegion Creates or updates the image region by adding a polygonal region.
Public Method AddRectangleToRegion Creates or updates the image region by adding a rectangular region.
Public Method AddRoundRectangleToRegion Creates or updates the image region by adding a rounded rectangular region.
Public Method AutoFixResolution Automatically converts the resolution of this image.
Public Method CalculatePaintModeRectangle Adjusts the given rectangle based on the given paint mode properties.
Public Method CalculateRegionArea Gets the total number of pixels in the image region.
Public Method CalculateRegionMaximumClipSegments Gets the number of elements required to hold the clip segments for any row in the region.
Public Method ChangeCompression Compresses or decompresses this RasterImage.
Public Method ChangeFromDib Changes a Windows device independent bitmap (DIB) to a LEAD RasterImage object.
Public Method ChangeHeight Increases or decreases the allocated height of an image.
Public Method ChangeToDib Changes a LEAD RasterImage object to a Windows Device Independent Bitmap (DIB).
Public Method ChangeViewPerspective Rotates and flips the image data as necessary to achieve the desired view perspective.
Public Method Clone Creates a new RasterImage object by copying an area of this RasterImage.
Public Method CloneAll Creates an exact copy of this RasterImage.
Public Method CopyData Updates the data of this RasterImage.
Public Method CopyMetadataTo Copies the metadata (tags, comments, and markers) to the given image.
Public Method CopyPaletteTo Copies the palette of this RasterImage into a destination image.
Public Method Create Creates a new RasterImage using the specified parameters.
Public Method CreateAlphaImage Creates a grayscale image from this RasterImage alpha channel data.
Public Method CreateFromYUVData Creates a new RasterImage using the specified parameters and fills the image using the specified YUV data.
Public Method CreateGrayscale Creates a new grayscale RasterImage using the specified parameters.
Public Method CreateMaskFromRegion Creates a 1-bit mask image from the region that is defined in the image.
Public Method CreateThumbnail Creates a thumbnail image of this RasterImage.
Public Method DisableEvents Disables raising the Changed event.
Public Method DitherLine Used in a loop, dithers the line in a specified unmanaged memory input buffer, and writes it to an unmanaged memory output buffer.
Public Method EnableEvents Enables raising the Changed event.
Public Method FlipRegion Flips the image region (top to bottom).
Public Method FlipViewPerspective Flips this RasterImage image by changing its ViewPerspective.
Public Method FromDib Creates a new image from the specified Windows device independent bitmap (DIB) stored in an unmanaged pointer.
Public Method FromDibArray Creates a new image from the specified Windows device independent bitmap (DIB) stored in a managed array.
Public Method GetImageHeightDpi Gets the height of this RasterImage in pixels, taking ViewPerspective and YResolution into account.
Public Method GetImageSizeDpi Gets the size in pixels of this RasterImage object, taking YResolution into account.
Public Method GetImageWidthDpi Gets the width of this RasterImage in pixels, taking ViewPerspective and XResolution into account.
Public Method GetLookupTable Gets the 8-bit lookup table (LUT) of this RasterImage.
Public Method GetLookupTable16 Gets the 16-bit lookup table (LUT) of this RasterImage.
Public Method GetObjectData Populates a specified SerializationInfo with the data needed to serialize this object.
Public Method GetOverlayAttributes Gets one or more overlay attributes for the specified index.
Public Method GetOverlayImage Gets the overlay image for the specified index.
Public Method GetPaintLookupTable For internal use by LEADTOOLS.
Public Method GetPaintLookupTable16 For internal use by LEADTOOLS.
Public Method GetPalette Gets a copy of the palette of this RasterImage object that will be used by 1-8 bit color or grayscale image.
Public Method GetPixel Returns the color of the specified pixel.
Public Method GetPixelColor Returns the color of the specified pixel.
Public Method GetPixelData Copies the pixel data of the specified pixel into an unmanaged memory buffer.
Public Method GetRegion Gets the RasterRegion object that describes this RasterImage current region.
Public Method GetRegionBounds Gets the bounding rectangle of the image region.
Public Method GetRegionBoundsClipped Gets the bounding rectangle of the image region.
Public Method GetRegionClipSegments Gets the segments contained in the region for a particular row.
Public Method GetRow Retrieves one or more rows of image data from this RasterImage into un unmanaged memory buffer.
Public Method GetRowColumn Accepts a column offset to retrieve data from an image and place it in an ummanaged memory buffer.
Public Method GetRowColumnCompressed Retrieves (into an unmanaged memory buffer) a row (or part of a row) of 1-bit compressed data from an image that has been loaded in its compressed format.
Public Method GetRowCompressed Retrieves (into an unmanaged memory buffer) one or more rows of 1-bit compressed data from an image that has been loaded in its compressed format.
Public Method GetTrueColorValue Gets the true (RGB) value of the specified color based on the current image palette.
Public Method GetYUVData Converts the RasterImage grayscale or BGR data to YUV and stores it in an output buffer.
Public Method InsertPage Inserts a new page into this RasterImage.
Public Method InsertPages Inserts one or more pages into this RasterImage.
Public Method MakeRegionEmpty Removes the region from the image and frees the memory used for the region.
Public Method OffsetRegion Moves the image region by the specified number of rows and columns.
Public Method OnChanged Raises the Changed event.
Public Method PointFromImage Translates a point (x,y) from this RasterImage view perspective to the specified view perspective.
Public Method PointToImage Translates a point (x,y) from the specified view perspective to this RasterImage view perspective.
Public Method RectangleFromImage Translates a rectangle from this RasterImage view perspective to the specified view perspective.
Public Method RectangleToImage Translates a rectangle from a specified view perspective to this RasterImage view perspective.
Public Method RegionContains Determines whether the specified pixel is in the image region.
Public Method Release Releases memory locked with Access back to the system.
Public Method RemoveAllPages Removes all pages from this RasterImage.
Public Method RemovePageAt Removes the page at the specified index from this RasterImage.
Public Method RemovePages Removes one or more pages from this RasterImage.
Public Method ReplacePage Replaces an existing page in this RasterImage.
Public Method ReplacePages Replaces one or more pages of this RasterImage.
Public Method ReverseRegion Flips the image region (left to right).
Public Method RotateViewPerspective Rotates this RasterImage by changing its ViewPerspective.
Public Method SetAlphaImage Replaces existing alpha channel data or creates new alpha channel data.
Public Method SetLookupTable Sets the 8-bit lookup table (LUT) of this RasterImage.
Public Method SetLookupTable16 Sets the 16-bit lookup table (LUT) of this RasterImage.
Public Method SetOverlayImage Sets the overlay image for a certain index.
Public Method SetOverlayImageSize Changes the size of the overlay image for a certain index.
Public Method SetPaintLookupTable For internal use by LEADTOOLS.
Public Method SetPaintLookupTable16 For internal use by LEADTOOLS.
Public Method SetPalette Sets the palette of this RasterImage object that will be used by 1-8 bit color or grayscale image.
Public Method SetPixel Changes the color value of the specified pixel.
Public Method SetPixelColor Changes the color value of the specified pixel.
Public Method SetPixelData Changes the data of the specified pixel by copying from an unmanaged memory buffer.
Public Method SetRegion Sets or updates the RasterRegion object that describes this RasterImage current region.
Public Method SetRow Copies one or more rows of image data from an unmanaged memory buffer to this RasterImage.
Public Method SetRowColumn Copies data from an unmanaged memory buffer to an image, with an offset to the image.
Public Method SetRowColumnCompressed Puts a row (or part of a row) of 1-bit compressed data from an unmanaged memory buffer to an image that is maintained in its compressed format.
Public Method SetRowCompressed Puts one or more rows of 1-bit compressed data from an unmanaged memory buffer to an image that is maintained in its compressed format.
Public Method SetRowSegments For internal use by LEADTOOLS.
Public Method SetUserData Sets the data for the image to the specified unmanaged memory buffer.
Public Method SetYUVData Updates the image data using the YUV data from an input buffer. The YUV data is converted to grayscale/BGR before being set in the RasterImage.
Public Method StartDithering Initializes the buffered dithering of an image.
Public Method StopDithering Cleans up all data variables and buffers allocated by the StartDithering and DitherLine methods.
Public Method ToDib Gets an unmanaged pointer containing a Windows device independent bitmap (DIB) version of this image.
Public Method ToDibArray Gets a managed buffer containing a Windows device independent bitmap (DIB) version of this image.
Public Method TranslateColor Translates the specified color in the image, and returns the nearest matching color in the destination image.
Public Method Underlay Combines two images so that one appears to be an underlying texture for the other.
Public Method UpdateOverlayAttributes Updates the overlay attributes for the overlay at the specified index.
Public Method UpdateOverlayBits Updates the overlay image pixels with the bits from the corresponding bitplane of the main image.
Public Method WindowLevel Sets up the paint or paint and image processing methods' window leveling options for this RasterImage
Public Method WindowLevelExt Sets up the paint or paint and image processing methods' window leveling options for this RasterImage

Protected Methods

Name Description
Protected Method Dispose Releases all the resources used by this RasterImage.
Protected Method Finalize This member overrides Finalize.
Protected Method ReleaseData Releases memory locked with AccessData back to the system.

Public Properties

Name Description
Public Property AnimationBackground Gets or sets a value indicating the animation background color for the current frame.
Public Property AnimationDelay Gets or sets a value indicating the animation delay in milliseconds (ms) for the current frame.
Public Property AnimationDisposalMethod Gets or sets a value indicating the animation disposal method for the current frame.
Public Property AnimationGlobalBackground Gets or sets a value indicating the global background color of the animation image.
Public Property AnimationGlobalLoop Gets or sets a value indicating the global loop count for animated images.
Public Property AnimationGlobalSize Gets or sets a value indicating the global size of the animation image.
Public Property AnimationOffset Gets or sets a value indicating the animation offset for the current frame.
Public Property AnimationWaitUserInput Gets or sets a value indicating whether the RasterImageAnimator object should wait for user input in the current frame.
Public Property BitsPerPixel Gets the number of bits per pixel of this RasterImage
Public Property BytesPerLine Gets the number of bytes per scanline for the image data of this RasterImage.
Public Property Comments The collection of comment data used when reading and writing certain file formats (including GIF).
Public Property CustomData Gets a dictionary that holds user-added data for the image.
Public Property Data Gets the data for the image in native format.
Public Property DataSize Gets the size, in bytes, of the image data buffer.
Public Property DitherData For internal use by LEADTOOLS.
Public Property DitheringMethod Gets or sets the default dithering method, referenced by some internal LEADTOOLS methods.
Public Property GeoKeys The collection of GeoKeys used when reading and writing Geo TIFF files.
Public Property GrayscaleMode Determines if this RasterImage is a grayscale image.
Public Property HasRegion Determines whether this RasterImage has a region.
Public Property Height Gets the height of this RasterImage in pixels.
Public Property HighBit Gets or sets the image window level high bit value.
Public Property ImageHeight Gets the height of this RasterImage in pixels, taking ViewPerspective into account.
Public Property ImageSize Gets the size in pixels of this RasterImage object.
Public Property ImageWidth Gets the width of this RasterImage in pixels, taking ViewPerspective into account.
Public Property IsBasic Determines whether the image data is basic.
Public Property IsCompressed Determines if the memory allocated for the image data is compressed memory.
Public Property IsConventionalMemory Determines if the memory allocated for the image data is in conventional memory.
Public Property IsDiskMemory Determines if the memory allocated for the image data is allocated as a disk file rather than in physical memory.
Public Property IsDisposed Gets a value indicating whether the RasterImage object has been disposed of.
Public Property IsFlipped Determines whether the image has a a flipped ViewPerspective.
Public Property IsGlobalMemory Determines if the memory allocated for the image data is a global Windows handle.
Public Property IsGray Determines whether the image has a grayscale byte order.
Public Property IsLoading Gets a value that determines whether this RasterImage object is still loading.
Public Property IsMirrored Determines whether the image data is mirrored.
Public Property IsNull Checks whether this raster image is a global null instance.
Public Property IsRotated Determines whether the image has a rotated ViewPerspective.
Public Property IsSuperCompressed Determines if the memory allocated for the image data is super-compressed memory.
Public Property IsTiled Determines if the memory allocated for the image data is allocated in tiles.
Public Property LowBit Gets or sets the image window level low bit value.
Public Property Markers The collection of marker data used when reading and writing certain file formats (including JPEG).
Public Property MaxValue Gets or sets the images maximum grayscale value.
Public Property MemoryInformation Gets or sets information about the memory allocated for the image data.
Public Property MinValue Gets or sets the images minimum grayscale value.
Public Property NonLinearLookupTable Determines whether the image has a non-linear lookup table (LUT).
Public Property NoRegionClip Enables or disables clipping the image to the region.
Public Property Order Gets or sets the color order of this RasterImage.
Public Property OriginalFormat Gets or sets the original image format of this RasterImage.
Public Property OverlayCount Gets the number of overlays that have been defined for this RasterImage.
Public Property Page Gets or sets the current active page for this RasterImage.
Public Property PageCount Gets the total number of pages in the this RasterImage.
Public Property PaintContrast Gets or sets the current contrast value for the image.
Public Property PaintGamma Gets or sets the current gamma correction value for the image.
Public Property PaintHighBit Gets or sets the image paint high bit value.
Public Property PaintIntensity Gets or sets the current intensity value for the image.
Public Property PaintLowBit Gets or sets the image paint low bit value.
Public Property PremultiplyAlpha Enables or disables automatic handling of premultiplied alpha channel values.
Public Property Signed Determines if the image data contains signed values.
Public Property Tags The collection of tag data used when reading and writing certain file formats (including TIFF).
Public Property Transparent Gets or sets a value that indicates whether to use the transparent color.
Public Property TransparentColor Gets or sets the transparent color used when painting this image.
Public Property UseLookupTable Enables or disables using the lookup table (LUT) of this RasterImage.
Public Property UsePaintLookupTable For internal use by LEADTOOLS.
Public Property ViewPerspective Gets or sets the view perspective of the image data of this RasterImage.
Public Property Width Gets the width of this RasterImage in pixels.
Public Property XResolution Gets or sets the image horizontal resolution, in dots per inch (DPI).
Public Property YResolution Gets or sets the image vertical resolution, in dots per inch (DPI).

Public Events

Name Description
Public Event Changed Occurs when the image data or attributes has changed.
Public Event Disposed Occurs when the image is disposed by a call to the Dispose method.
Public Event LoadCompleted For internal use by LEADTOOLS
Public Event PagesChanged Occurs when pages are added, inserted or removed from this RasterImage object.

Public Fields

Name Description
Public Field MaxOverlays Gets the maximum number of overlays allowed in a RasterImage.
Public Field NullInstance An object that represents a null RasterImage.
Public Field RasterImageDataFormat Get the name of the data format used when copying a raster image to the clipboard

Help Version 20.0.2019.3.11
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

Leadtools Assembly