Document Solutions for Imaging
DS.Documents.Imaging Assembly / GrapeCity.Documents.Imaging Namespace / GcBitmap Class
Properties Methods

In This Topic
    GcBitmap Class Members
    In This Topic

    The following tables list the members exposed by GcBitmap.

    Public Constructors
     NameDescription
    Public ConstructorGcBitmap ConstructorOverloaded.   
    Top
    Public Properties
     NameDescription
    Public PropertyDpiXGets the horizontal dpi of the bitmap.  
    Public PropertyDpiYGets the vertical dpi of the bitmap.  
    Public PropertyExifProfileGets or sets an instance of GrapeCity.Documents.Imaging.Exif.ExifProfile with Exif metadata of the image.  
    Public PropertyGraphicsGets an instance of the GcBitmapGraphics class.

    The Graphics becomes available after executing the CreateGraphics method.

     
    Public PropertyHasImageGets a value indicating whether the underlying image exists (has been loaded or created). If this property is false, call Load() or CreateImage() to load or create the underlying image. Calling any other method will throw an exception unless this property is true.  
    Public PropertyHeightGets the height of the image, in DIPs.  
    Public PropertyIccProfileDataGets or sets the raw ICC profile data.  
    Public PropertyIsDisposedGets a value indicating whether the GcBitmap has been disposed of.  
    Public PropertyItemGets or sets a pixel color value at the specified coordinates.  
    Public PropertyOpaqueGets or sets a value indicating whether the alpha channel of the image should be ignored.  
    Public PropertyPixelHeightGets the pixel height of the image.  
    Public PropertyPixelWidthGets the pixel width of the image.  
    Public PropertyPremultipliedGets or sets a value indicating if the color channels for all pixels are premultiplied by the alpha channel.

    Setting this property doesn't perform actual conversion.

     
    Public PropertyRawDataGets a pointer to the internal binary data.  
    Public PropertyRendererGets an instance of the BitmapRenderer class.

    The renderer becomes available after executing the EnsureRendererCreated method.

     
    Public PropertyRotationGets the flip and rotate transformations that must be applied to the image.  
    Public PropertyStoreInTempFileGets or sets a value indicating whether pixel data should be dynamically mapped to a temporary file rather than kept fully in memory.

    Setting this property to true frees up memory but slows down operations on pixel data.

    Do not activate this mode for small images (less than 100 x 100 pixels).

    The default is false.

     
    Public PropertyWidthGets the width of the image, in DIPs.  
    Top
    Public Methods
     NameDescription
    Public MethodAdjustLevelsOverloaded. Adjusts the levels of an image histogram.

    The method maps the input range of values (blackPoint..whitePoint) to the output range (outputBlack..outputWhite) using the specified gamma correction (midtone).

     
    Public MethodAlphaBlendDraws the source bitmap with the specified opacity into the current bitmap.  
    Public MethodApplyColorMatrixMultiplies RGBA values of the GcBitmap by a 5x4 matrix.  
    Public MethodApplyEffectApplies a graphic effect to an image or its portion in-place.  
    Public MethodApplyLicenseKeyApplies a license key to an instance of GcBitmap.  
    Public MethodApplyTransparencyMaskOverloaded. Applies a transparency mask to the current image or its portion.  
    Public MethodAutoLevelModifies R, G, B color intensities such that the maximum range of values (0..255) is fully covered.  
    Public MethodBitBltPerforms a bit-block transfer of the color data corresponding to a rectangle of pixels from the specified source bitmap into the current bitmap.  
    Public MethodCalculateOtsuThresholdCalculates Otsu's threshold [0..255] for a grayscale image.

    It is expected that the image is already converted to monochromatic gray.

     
    Public MethodClearOverloaded. Clears the GcBitmap with the specified color.  
    Public MethodClipCreates a new GcBitmap with a fragment of the image.  
    Public MethodCloneOverloaded. Creates a new GcBitmap with a copy of the image.  
    Public MethodCompositeAndBlendApplies the algorithms of Porter Duff compositing and blending to the current bitmap (used as backdrop, destination) and the source bitmap.  
    Public MethodConvertFromPremultipliedAlphaOverloaded. Makes the alpha channel not premultiplied in the color channels and sets the Premultiplied property to False.  
    Public MethodConvertToOpaqueOverloaded. Converts an image with transparent or semitransparent pixels to fully opaque with specified background color.  
    Public MethodConvertToPremultipliedAlphaOverloaded. Premultiplies the color channels by the alpha channel and sets the Premultiplied property to True.  
    Public MethodCreateGraphicsCreates an instance of the GcBitmapGraphics class.  
    Public MethodCreateImageOverloaded. Creates the image of the given size and resolution.

    The content is not initialized and can contain any random data.

    If subsequent rendering is going to cover the whole surface of the bitmap, or if CreateGraphics will be called on the bitmap with a non-null background color, clearing it (which is a lengthy operation for large bitmaps) is not needed. If some areas of the bitmap are going to be left untouched, they must be cleared to avoid the possibility of random artifacts showing.

     
    Public MethodDiscardImageReleases the internal image and clears all metadata.  
    Public MethodDisposeClean up any resources being used.  
    Public MethodEnsureRendererCreatedCreates a BitmapRenderer that allows drawing on the GcBitmap if it has not been created yet.  
    Public MethodExportColorChannelCopies data from one color channel of the current GcBitmap to an existing GrayscaleBitmap of the same pixel size.  
    Public MethodExtractColorsCreates a sorted array of unique colors for the current image.  
    Public MethodFlipRotateProduces a flipped (horizontal or vertical) and/or rotated (by 90 degree increments) bitmap.

    The source bitmap remains unchanged.

     
    Public MethodGenerateOctreePaletteGenerates a palette for the image using the Octree quantizer algorithm.

    The Alpha color channel is ignored.

     
    Public MethodGetContentRectOverloaded. Returns the coordinates of a rectangle with colors different from background.  
    Public MethodHasTransparentPixelsDetermines whether the image contains transparent or semitransparent pixels.

    It always returns false for an opaque image.

     
    Public MethodImportColorChannelCopies data from a GrayscaleBitmap to one color channel of the current GcBitmap of the same pixel size.  
    Public MethodIsBlackAndWhiteDetermines whether the image contains only black and white pixels.  
    Public MethodIsGrayscaleDetermines whether the image contains only opaque grayscale pixels.  
    Public MethodLoadOverloaded. Loads the image from a stream. JPEG, PNG, WEBP, GIF, BMP, TIFF, ICO, JPEG 2000 formats are supported.  
    Public Methodstatic (Shared in Visual Basic)MergePalettesMerges sorted arrays of unique colors in 32-bit ARGB format (returned from ExtractColors)  
    Public MethodResizeCreates a new GcBitmap with a resized image fragment.  
    Public MethodSaveAsBmpOverloaded. Saves the image into a Stream in BMP format.  
    Public MethodSaveAsGifOverloaded. Saves the image into a Stream in GIF format.  
    Public MethodSaveAsIcoOverloaded. Saves the image into a Stream in ICO format.  
    Public MethodSaveAsJpegOverloaded. Saves the image into a Stream in JPEG format with specified quality (from 0 to 100).  
    Public MethodSaveAsPngOverloaded. Saves the image into a Stream in PNG format.  
    Public MethodSaveAsTiffOverloaded. Saves the image into a Stream in TIFF format.  
    Public MethodSaveAsWebpOverloaded. Saves the image into a Stream in WEBP format.  
    Public MethodSetAlphaTo255Updates the alpha channel of pixels to 255 (to make them opaque).  
    Public MethodSetDpiOverloaded. Changes the physical resolution of the image.  
    Public Methodstatic (Shared in Visual Basic)SetLicenseKeySets the license key.  
    Public MethodShrinkARGBFormatOverloaded. Changes pixel format from 8 bits per channel to lower values with two-dimensional error diffusion.  
    Public MethodToBilevelBitmapCreates a BilevelBitmap from the current GcBitmap.

    This method does not perform any transformations of the color palette. It is expected that the source GcBitmap has already been converted to bi-level palette using some thresholding or dithering effects. The ToBilevelBitmap method just copies data from a specified color channel to a new instance of the BilevelBitmap class.

     
    Public MethodToGrayscaleBitmapCreates a GrayscaleBitmap from the current GcBitmap.

    This method does not perform any transformations of the color palette. It is expected that the source GcBitmap has already been converted to grayscale palette using a GrayscaleEffect or something like that. Alternatively, you can use this method to extract individual channels of a color image without any prior conversion, and treat the resulting GrayscaleBitmap simply as a representation of some image data with 8 bits per pixel. The ToGrayscaleBitmap method just copies data from a specified color channel to a new instance of the GrayscaleBitmap class. If you need to copy some color channel to an existing instance of GrayscaleBitmap, use the ExportColorChannel method instead.

     
    Public MethodToIndexed4bppBitmapOverloaded. Creates an opaque Indexed4bppBitmap from the current image using the Octree quantizer algorithm.  
    Public MethodToIndexed8bppBitmapOverloaded. Creates an opaque Indexed8bppBitmap from the current image using the Octree quantizer algorithm.  
    Public MethodToJpegStreamSaves the image into a Stream in JPEG format with specified quality (from 0 to 100). The returned stream should be disposed after usage.  
    Top
    See Also

    Reference

    GcBitmap Class
    GrapeCity.Documents.Imaging Namespace