Class GifImage
Contents
[
Hide
]GifImage class
The API for Graphical Interchange Format (GIF) image file provides developers with versatile tools for processing compressed raster images and animated GIFs. Offering features like XMP metadata handling, color palette settings, background and transparent color control, opacity settings, resize, crop, filter application, gamma corrections, contrast adjustment, grayscale transformation, and conversion to other formats. This API empowers seamless manipulation and enhancement of GIF images for a wide range of applications.
public sealed class GifImage : RasterCachedMultipageImage, IMultipageImageExt
Constructors
| Name | Description |
|---|---|
| GifImage(GifFrameBlock) | Crafting GIF images becomes effortless with the GifImage constructor. With just the firstFrame parameter, it enters in a world of dynamic visual communication. |
| GifImage(GifFrameBlock, IColorPalette) | Initiate a new GifImage object with specified parameters for the first frame and global palette. Start managing GIF images swiftly, ensuring accurate representation with customizable settings for optimal results. |
| GifImage(GifFrameBlock, IColorPalette, bool, byte, byte, byte, bool) | Get started effortlessly with the GifImage constructor. With this simple method, you can dive into creating animated GIFs with ease. Just supply the firstFrame, globalPalette, paletteColorResolution, aspectRatio, and other parameters, and you’re ready to bring your visuals to life. |
Properties
| Name | Description |
|---|---|
| ActiveFrame { get; set; } | Manage and manipulate frames with this property, enabling smooth navigation and modification of the active frame within the GIF image. |
| AutoAdjustPalette { get; set; } | Gets or sets a value indicating whether automatic adjust palette. |
| override BackgroundColor { get; set; } | Manage the background color of the GIF image with this property. You can set or retrieve the background color to ensure consistency and enhance visual appeal. |
| BackgroundColorIndex { get; set; } | Control the background color index of the GIF image using this property. Set or retrieve the index to maintain consistency or achieve desired visual effects. |
| override BitsPerPixel { get; } | Gets the image bits per pixel count. |
| Blocks { get; } | Gain access to the GIF blocks seamlessly with this property, facilitating easy retrieval and manipulation of the image’s underlying data structures. |
| Bounds { get; } | Gets the image bounds. |
| BufferSizeHint { get; set; } | Gets or sets the buffer size hint which is defined max allowed size for all internal buffers. |
| Container { get; } | Gets the Image container. |
| DataStreamContainer { get; } | Gets the object’s data stream. |
| Disposed { get; } | Gets a value indicating whether this instance is disposed. |
| override FileFormat { get; } | Retrieve the file format effortlessly with this property. It’s your go-to source for identifying the format of your files. Seamlessly integrated into your workflow, it provides vital information without any hassle. |
| override HasAlpha { get; } | Gets a value indicating whether this instance has alpha. |
| override HasBackgroundColor { get; } | This property determines whether the GIF image contains a background color. If true, it indicates that the image includes a background color. |
| HasTrailer { get; set; } | Manage the presence of a trailer in your GIF files with this property. Whether you need to check if a trailer exists or set its presence, this property simplifies the process. Keep your GIF files structured and compliant with this intuitive feature. |
| override HasTransparentColor { get; set; } | Determine whether the active frame of the GIF image includes a transparent color. This property provides a convenient way to check for transparency within the image. |
| override Height { get; } | Gets the image height. |
| virtual HorizontalResolution { get; set; } | Gets or sets the horizontal resolution, in pixels per inch, of this RasterImage. |
| override ImageOpacity { get; } | Retrieve the opacity of the active frame within the image, offering insight into its transparency level. This property is particularly useful for understanding the degree of transparency or opaqueness of the active frame in the image. |
| InterruptMonitor { get; set; } | Gets or sets the interrupt monitor. |
| override IsCached { get; } | Gets a value indicating whether image data is cached currently. |
| IsInterlaced { get; } | Determines if the image is interlaced, impacting its display during loading. This property offers insight into the image’s rendering behavior, essential for optimizing loading strategies and enhancing overall viewing experience. |
| IsPaletteSorted { get; set; } | Control the sorting of the palette in your GIF images using this property. Whether you need to check if the palette is sorted or set the sorting behavior, this property provides a straightforward way to manage the palette organization in your GIF files. |
| IsRawDataAvailable { get; } | Gets a value indicating whether raw data loading is available. |
| LoopsCount { get; set; } | Retrieve the loop count effortlessly with this property. If your GIF image includes loop information, this property gives you quick access to the loop count, enabling you to seamlessly manage looping behavior in your GIF files. |
| override PageCount { get; } | Retrieve the total number of pages contained within the image with this straightforward property. Ideal for quickly assessing the extent of the image content. |
| virtual PageExportingAction { get; set; } | Gets or sets the page exporting action. Please note that setting this method will automatically release page resources after it is executed. It will be executed just before each page is saved. |
| override Pages { get; } | Gain access to the pages within the image through this convenient property, allowing seamless navigation and manipulation of individual pages as needed. |
| Palette { get; set; } | Gets or sets the color palette. The color palette is not used when pixels are represented directly. |
| PaletteColorResolutionBits { get; set; } | Manage the palette color resolution of your GIF images with this property. Adjust the number of bits used to represent colors in the palette, providing fine control over color depth and image quality. |
| PixelAspectRatio { get; set; } | Manage the pixel aspect ratio of the GIF image with this property. Set or retrieve the aspect ratio to ensure accurate rendering and maintain visual fidelity. |
| virtual PremultiplyComponents { get; set; } | Gets or sets a value indicating whether the image components must be premultiplied. |
| RawCustomColorConverter { get; set; } | Gets or sets the custom color converter |
| virtual RawDataFormat { get; } | Gets the raw data format. |
| RawDataSettings { get; } | Gets the current raw data settings. Note when using these settings the data loads without conversion. |
| RawFallbackIndex { get; set; } | Gets or sets the fallback index to use when palette index is out of bounds |
| RawIndexedColorConverter { get; set; } | Gets or sets the indexed color converter |
| virtual RawLineSize { get; } | Gets the raw line size in bytes. |
| Size { get; } | Gets the image size. |
| override TransparentColor { get; } | Retrieve the transparent color of the active frame in the GIF image. This property allows you to access the specific color that has been designated as transparent within the currently active frame. |
| virtual UpdateXmpData { get; set; } | Gets or sets a value indicating whether to update the XMP metadata. |
| override UsePalette { get; } | Gets a value indicating whether the image palette is used. |
| virtual UseRawData { get; set; } | Gets or sets a value indicating whether to use raw data loading when the raw data loading is available. |
| virtual VerticalResolution { get; set; } | Gets or sets the vertical resolution, in pixels per inch, of this RasterImage. |
| override Width { get; } | Gets the image width. |
| override XmpData { get; set; } | Manage XMP metadata with this property. Whether you’re retrieving existing metadata or updating it with new information, this property streamlines the process. Keep your metadata organized and accessible, ensuring that your files contain the relevant information they need. |
Methods
| Name | Description |
|---|---|
| AddBlock(IGifBlock) | Adding a new GIF block allows you to include additional data within the image. This method enables you to append custom blocks to the GIF image, which can contain various types of information. |
| AddPage(RasterImage) | Incorporate a new page seamlessly into the existing image, enhancing its content and expanding its scope. This method augment image collections with additional content, fostering creativity and flexibility in image management and composition. |
| override AdjustBrightness(int) | Adjusts the brightness of the image according to the specified brightness parameter. This method modifies the brightness of the entire image uniformly, enhancing or reducing the overall luminance to achieve the desired effect. |
| override AdjustContrast(float) | Adjusts the contrast of the image, enhancing or reducing the difference in brightness between pixels. This method modifies the image’s overall tonal range, making darker areas darker and brighter areas brighter to improve visual clarity and detail. |
| override AdjustGamma(float) | Enhance image quality by applying gamma correction. This method adjusts the color gamma of the image to achieve optimal visual clarity. It modifies the gamma value of each pixel, resulting in improved color rendition and overall image appearance. |
| override AdjustGamma(float, float, float) | Gamma-correction of an image applies a nonlinear adjustment to the pixel values, enhancing or reducing brightness based on the specified coefficients for the red, green, and blue channels. This method helps to fine-tune the color balance and luminance of the image, improving its overall appearance and visual quality. |
| override BinarizeBradley(double) | Binarization of an image using Bradley’s adaptive thresholding algorithm with integral image thresholding is a method for converting a grayscale image into a binary image. This algorithm calculates a local threshold for each pixel based on the average intensity of the surrounding pixels within a specified window. By adaptively adjusting the threshold based on local pixel intensities, Bradley’s method is effective at handling variations in lighting and contrast across the image. |
| override BinarizeBradley(double, int) | Binarization of an image using Bradley’s adaptive thresholding algorithm using the integral image thresholding |
| override BinarizeFixed(byte) | Binarization of an image with a predefined threshold converts a grayscale or color image into a binary image, where each pixel is classified as either black or white based on whether its intensity value exceeds a specified threshold. |
| override BinarizeOtsu() | Binarization of an image with Otsu thresholding is a method used to automatically determine the optimal threshold value for converting a grayscale image into a binary image. The Otsu thresholding algorithm calculates the threshold that minimizes the intra-class variance of the pixel intensities in the two resulting classes (foreground and background). This technique is particularly useful when the optimal threshold value is unknown and needs to be determined adaptively based on the image’s histogram. |
| Blend(Point, RasterImage, byte) | Blends this image instance with the overlay image. |
| override Blend(Point, RasterImage, Rectangle, byte) | Blends this image instance with the overlay image. |
| override CacheData() | Caches the data private. |
| CanSave(ImageOptionsBase) | Determines whether image can be saved to the specified file format represented by the passed save options. |
| ClearBlocks() | Clearing all the GIF blocks removes any existing data stored within the image. This operation effectively resets the image to an empty state, removing any previously added blocks. Use this method when you need to start fresh with a clean slate for creating or modifying a GIF image. |
| override Crop(Rectangle) | Crop the image using a specified rectangle area. This operation removes the outer portion of the image, leaving only the selected region defined by the rectangle. |
| override Crop(int, int, int, int) | Crop image with shifts. |
| Dispose() | Disposes the current instance. |
| Dither(DitheringMethod, int) | Performs dithering on the current image. |
| override Dither(DitheringMethod, int, IColorPalette) | Apply dithering to the current image. This process enhances image quality by reducing color banding and improving color transitions, resulting in a smoother appearance. |
| override Filter(Rectangle, FilterOptionsBase) | Apply a specific filter to the designated area of the image, enhancing its visual quality or altering its appearance as desired. This method selectively processes pixels within the defined rectangle, allowing for targeted adjustments to be made while preserving the integrity of the surrounding image data. |
| GetArgb32Pixel(int, int) | Gets an image 32-bit ARGB pixel. |
| GetDefaultArgb32Pixels(Rectangle) | Gets the default 32-bit ARGB pixels array. |
| virtual GetDefaultOptions(object[]) | Gets the default options. |
| GetDefaultPixels(Rectangle, IPartialArgb32PixelLoader) | Gets the default pixels array using partial pixel loader. |
| GetDefaultRawData(Rectangle, RawDataSettings) | Gets the default raw data array. |
| GetDefaultRawData(Rectangle, IPartialRawDataLoader, RawDataSettings) | Gets the default raw data array using partial pixel loader. |
| virtual GetModifyDate(bool) | Gets the date and time the resource image was last modified. |
| override GetOriginalOptions() | Retrieve the original file settings-based options, crucial for maintaining fidelity and consistency in image processing and manipulation. This method allows seamless integration of file-specific parameters into subsequent operations, ensuring accurate rendition and adherence to the image’s inherent characteristics. This can be helpful to keep bit-depth and other parameters of the original image unchanged. For example, if we load a black-white PNG image with 1 bit per pixel and then save it using the Save method, the output PNG image with 8-bit per pixel will be produced. To avoid it and save PNG image with 1-bit per pixel, use this method to get corresponding saving options and pass them to the Save method as the second parameter. |
| GetPixel(int, int) | Gets an image pixel. |
| override GetSerializedStream(ImageOptionsBase, Rectangle, out int) | Converts to aps. |
| GetSkewAngle() | Gets the skew angle. This method is applicable to scanned text documents, to determine the skew angle when scanning. |
| override Grayscale() | The transformation of an image to its grayscale representation converts the color image into a grayscale version by removing color information while preserving luminance. This process simplifies the image to shades of gray, making it suitable for various applications such as printing, document processing, and grayscale analysis. |
| InsertBlock(int, IGifBlock) | Inserting a new GIF block allows you to add custom data at a specific position within the image. This method enables you to place custom blocks at a desired location in the GIF image, providing flexibility in organizing and structuring the image data. |
| LoadArgb32Pixels(Rectangle) | Loads 32-bit ARGB pixels. |
| LoadArgb64Pixels(Rectangle) | Loads 64-bit ARGB pixels. |
| LoadCmyk32Pixels(Rectangle) | Loads pixels in CMYK format. |
| LoadPartialArgb32Pixels(Rectangle, IPartialArgb32PixelLoader) | Loads 32-bit ARGB pixels partially by packs. |
| LoadPartialArgb64Pixels(Rectangle, IPartialArgb64PixelLoader) | Loads 64-bit ARGB pixels partially by packs. |
| LoadPartialPixels(Rectangle, IPartialPixelLoader) | Loads pixels partially by packs. |
| LoadPixels(Rectangle) | Loads pixels. |
| LoadRawData(Rectangle, RawDataSettings, IPartialRawDataLoader) | Loads raw data. |
| LoadRawData(Rectangle, Rectangle, RawDataSettings, IPartialRawDataLoader) | Loads raw data. |
| NormalizeAngle() | Normalizes the angle. This method is applicable to scanned text documents to get rid of the skewed scan. This method uses GetSkewAngle and Rotate methods. |
| override NormalizeAngle(bool, Color) | Normalizes the angle. This method is applicable to scanned text documents to get rid of the skewed scan. This method uses GetSkewAngle and Rotate methods. |
| OrderBlocks() | Ordering the GIF blocks according to the GIF specification ensures proper GIF layout and compliance with the standard. This process involves arranging the blocks in the correct sequence as defined by the specification. Additionally, it may involve removing certain GifGraphicsControlBlock instances that are not necessary for the final layout. By adhering to the GIF specification, the resulting image will be correctly structured and compatible with GIF viewing applications. |
| ReadArgb32ScanLine(int) | Reads the whole scan line by the specified scan line index. |
| ReadScanLine(int) | Reads the whole scan line by the specified scan line index. |
| RemoveBlock(IGifBlock) | Removing a GIF block removes specific data from the image, offering the ability to clean up or modify the image structure. This method enables you to remove unwanted or unnecessary blocks, optimizing the GIF image for efficient storage. Use this functionality to eliminate outdated information from the image while preserving its integrity and quality. |
| override RemoveMetadata() | Removes this image instance metadata by setting this XmpData value to null. |
| ReplaceColor(Color, byte, Color) | Replaces one color to another with allowed difference and preserves original alpha value to save smooth edges. |
| override ReplaceColor(int, byte, int) | Replaces one color to another with allowed difference and preserves original alpha value to save smooth edges. |
| ReplaceNonTransparentColors(Color) | Replaces all non-transparent colors with new color and preserves original alpha value to save smooth edges. Note: if you use it on images without transparency, all colors will be replaced with a single one. |
| override ReplaceNonTransparentColors(int) | Replaces all non-transparent colors with new color and preserves original alpha value to save smooth edges. Note: if you use it on images without transparency, all colors will be replaced with a single one. |
| Resize(int, int) | Resizes the image. The default NearestNeighbourResample is used. |
| override Resize(int, int, ImageResizeSettings) | Resizes this Image instance. |
| override Resize(int, int, ResizeType) | Resizes this Image instance. |
| ResizeFullFrame(int, int, ResizeType) | Resizing of the image while taking into account the full frames for each page in a GIF, thus preventing potential artifacts from appearing. This method is essential to maintain the integrity and quality of the image, especially when dealing with animated GIFs or sequences of frames. |
| ResizeHeightProportionally(int) | Resizes the height proportionally. The default NearestNeighbourResample is used. |
| virtual ResizeHeightProportionally(int, ImageResizeSettings) | Resizes the height proportionally. |
| override ResizeHeightProportionally(int, ResizeType) | Resizes the width proportionally. |
| ResizeProportional(int, int, ResizeType) | Proportional resizing maintains the aspect ratio of the image while adjusting its size, ensuring that the image does not appear stretched or distorted. This method resizes the image proportionally, scaling both the width and height by the same factor. The proportional resize will resize each frame according to the ratio of newWidth/width and newHeight/height. |
| ResizeWidthProportionally(int) | Resizes the width proportionally. The default NearestNeighbourResample is used. |
| virtual ResizeWidthProportionally(int, ImageResizeSettings) | Resizes the width proportionally. |
| override ResizeWidthProportionally(int, ResizeType) | Resizes the width proportionally. |
| virtual Rotate(float) | Rotate image around the center. |
| override Rotate(float, bool, Color) | This method rotates the image around its center point. By specifying the rotation angle, you can rotate the image clockwise or counterclockwise to achieve the desired orientation. This rotation helps adjust the image’s presentation or alignment without distorting its content. |
| override RotateFlip(RotateFlipType) | Perform rotation, flipping, or both on the active frame exclusively. This operation applies transformations solely to the currently active frame of the image, preserving the integrity of other frames in the sequence. |
| Save() | Saves the image data to the underlying stream. |
| Save(Stream) | Saves the object’s data to the specified stream. |
| override Save(string) | Saves the image to the specified file location. |
| Save(Stream, ImageOptionsBase) | Saves the image’s data to the specified stream in the specified file format according to save options. |
| virtual Save(string, bool) | Saves the object’s data to the specified file location. |
| virtual Save(string, ImageOptionsBase) | Saves the object’s data to the specified file location in the specified file format according to save options. |
| override Save(Stream, ImageOptionsBase, Rectangle) | Saves the image’s data to the specified stream in the specified file format according to save options. |
| virtual Save(string, ImageOptionsBase, Rectangle) | Saves the object’s data to the specified file location in the specified file format according to save options. |
| SaveArgb32Pixels(Rectangle, int[]) | Saves the 32-bit ARGB pixels. |
| SaveCmyk32Pixels(Rectangle, int[]) | Saves the pixels. |
| SavePixels(Rectangle, Color[]) | Saves the pixels. |
| SaveRawData(byte[], int, Rectangle, RawDataSettings) | Saves the raw data. |
| SetArgb32Pixel(int, int, int) | Sets an image 32-bit ARGB pixel for the specified position. |
| SetFrameTime(ushort) | Adjusts the duration of each frame in milliseconds, ensuring consistent timing throughout the image sequence. This method uniformly sets the display time for every frame, allowing for precise control over animation speed. Changing this value will reset delay for all frames. |
| override SetPalette(IColorPalette, bool) | Sets the image palette. |
| SetPixel(int, int, Color) | Sets an image pixel for the specified position. |
| virtual SetResolution(double, double) | Sets the resolution for this RasterImage. |
| virtual ToBitmap() | Converts raster image to the bitmap. This method is not supported in versions from .Net7.0 and higher |
| WriteArgb32ScanLine(int, int[]) | Writes the whole scan line to the specified scan line index. |
| WriteScanLine(int, Color[]) | Writes the whole scan line to the specified scan line index. |
Examples
Export of part of animation from GIF image based on time interval.
[C#]
using (var image = Image.Load("Animation.gif"))
{
var options = new GifOptions
{
FullFrame = true,
MultiPageOptions = new MultiPageOptions
{
Mode = MultiPageMode.TimeInterval,
TimeInterval = new TimeInterval(0, 400)
}
};
image.Save("PartOfAnimation.gif", options);
}
This example shows how to create a GIF image and save it to a file.
[C#]
string dir = "c:\\temp\\";
// Create a GIF Frame block of 100x100 px.
using (Aspose.Imaging.FileFormats.Gif.Blocks.GifFrameBlock firstBlock = new Aspose.Imaging.FileFormats.Gif.Blocks.GifFrameBlock(100, 100))
{
// Fill the entire block in red.
Aspose.Imaging.Graphics gr = new Aspose.Imaging.Graphics(firstBlock);
Aspose.Imaging.Brushes.SolidBrush brush = new Aspose.Imaging.Brushes.SolidBrush(Aspose.Imaging.Color.Red);
gr.FillRectangle(brush, firstBlock.Bounds);
using (Aspose.Imaging.FileFormats.Gif.GifImage gifImage = new Aspose.Imaging.FileFormats.Gif.GifImage(firstBlock))
{
gifImage.Save(dir + "output.gif");
}
}
Create multipage GIF image using single page raster images.
[C#]
static void Main(string[] args)
{
// Load frames
var frames = LoadFrames("Animation frames").ToArray();
// Create GIF image using the first frame
using (var image = new GifImage(new GifFrameBlock(frames[0])))
{
// Add frames to the GIF image using the AddPage method
for (var index = 1; index < frames.Length; index++)
{
image.AddPage(frames[index]);
}
// Save GIF image
image.Save("Multipage.gif");
}
}
private static IEnumerable<RasterImage> LoadFrames(string directory)
{
foreach (var filePath in Directory.GetFiles(directory))
{
yield return (RasterImage)Image.Load(filePath);
}
}
See Also
- class RasterCachedMultipageImage
- interface IMultipageImageExt
- namespace Aspose.Imaging.FileFormats.Gif
- assembly Aspose.Imaging
