WebPImage

WebPImage class

Manipulate WebP raster images with our API, using its modern features for both lossless and lossy compression, ensuring optimal image quality with reduced file sizes. Seamlessly handle extended file formats, animations, and alpha channels, while easily updating dimensions, resizing proportionally, cropping, rotating, applying filters, adjusting image parameters, and converting to other image formats for versatile web image optimization.

public sealed class WebPImage : RasterCachedMultipageImage, IMultipageImageExt

Constructors

Name	Description
WebPImage(RasterImage)	Instantiate a new instance of the `WebPImage` class, initialized from a provided rasterImage object. This constructor allows for seamless conversion of raster images to WebP format, enabling efficient handling and manipulation of image data within your application.
WebPImage(Stream)	Instantiate a new instance of the `WebPImage` class, initialized from a provided stream source. Utilize this constructor to seamlessly create WebP image objects directly from streams, enabling efficient handling and manipulation of WebP image data within your application.
WebPImage(string)	Instantiate a fresh instance of the `WebPImage` class, initialized from a provided file source. Utilize this constructor to seamlessly create WebP image objects directly from files, streamlining the process of loading and manipulating WebP image data within your application.
WebPImage(RasterImage, LoadOptions)	Create a new instance of the `WebPImage` class using a rasterImage object and specified load options, enabling flexible handling of image data. Utilize this constructor to seamlessly initialize WebP image objects from raster images while customizing loading parameters according to your application’s requirements.
WebPImage(Stream, LoadOptions)	Create a new instance of the `WebPImage` class using a stream and specified load options, facilitating versatile handling of WebP image data. Incorporate this constructor to seamlessly initialize WebP image objects from streams while customizing loading parameters as needed within your application.
WebPImage(string, LoadOptions)	Create a new instance of the `WebPImage` class using a file and specified load options, facilitating flexible handling of WebP image data. Utilize this constructor to seamlessly initialize WebP image objects from files while customizing loading parameters according to your application’s requirements.
WebPImage(int, int, WebPOptions)	Instantiate a new instance of the `WebPImage` class with an empty image of specified width and height dimensions. This constructor allows for the creation of blank WebP images, providing a foundation for subsequent image manipulation and content generation within your application.
WebPImage(int, int, WebPOptions, LoadOptions)	Create a new instance of the `WebPImage` class with an empty image and specified load options. This constructor allows for the initialization of WebP images with customizable loading parameters, providing flexibility in image creation and manipulation within your application.

Properties

Name	Description
AutoAdjustPalette { get; set; }	Gets or sets a value indicating whether automatic adjust palette.
override BackgroundColor { get; set; }	Gets or sets a value for the background color.
override BitsPerPixel { get; }	Gets the image bits per pixel count.
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; }	Access the file format value associated with the image, providing information about the format in which the image is stored. Utilize this property to determine the file format of the image, facilitating compatibility checks and format-specific processing within your application.
override HasAlpha { get; }	Retrieve whether the image contains an alpha channel, indicating the presence of transparency information. Utilize this property to determine whether the image includes transparency, enabling appropriate handling and processing of alpha-related operations within your application.
virtual HasBackgroundColor { get; set; }	Gets or sets a value indicating whether image has background color.
override HasTransparentColor { get; }	Gets a value indicating whether image has transparent color.
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; }	Gets opacity of this image.
InterruptMonitor { get; set; }	Gets or sets the interrupt monitor.
override IsCached { get; }	Gets a value indicating whether image data is cached currently.
IsRawDataAvailable { get; }	Gets a value indicating whether raw data loading is available.
Options { get; }	Retrieve or modify the options associated with the specified property, enabling fine-tuned customization of behavior and settings. Utilize this property to seamlessly access and manipulate configurable parameters, facilitating versatile control and optimization within your application’s functionality.
override PageCount { get; }	Retrieve the total count of pages within the specified document, facilitating efficient navigation and management of multi-page content. Incorporate this functionality to enhance user experience, enabling seamless access to comprehensive document structures.
override PageExportingAction { get; set; }	Access or modify the page exporting action, which defines the specific action to be executed before each page is saved. Please note that setting this property will automatically release page resources after execution. Utilize this feature to perform custom actions or cleanup tasks before exporting each page, ensuring optimal resource management and desired behavior during image saving operations within your application.
override Pages { get; }	Access the WebP blocks within the image, allowing detailed examination or manipulation of the underlying block structure. Utilize this property to analyze or modify individual blocks within the WebP image data, facilitating advanced image processing techniques within your application.
Palette { get; set; }	Gets or sets the color palette. The color palette is not used when pixels are represented directly.
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.
virtual TransparentColor { get; set; }	Gets the image transparent color.
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; }	Gets or sets XMP data from frame.

Methods

Name	Description
AddBlock(IFrame)	Incorporate a new WebP block into the image, enriching its content and facilitating advanced image manipulation. Integrate this method to dynamically enhance the structure and complexity of the WebP image data within your application, enabling precise control and optimization of image rendering.
AddPage(RasterImage)	Append a new page to the image, expanding its content and accommodating additional visual elements. Integrate this method to facilitate dynamic page management within your application, enabling seamless creation and augmentation of multi-page documents or images.
override AdjustBrightness(int)	Implement brightness adjustment for the image, allowing the modification of overall luminance levels. Incorporate this method into your image processing workflow to enhance visibility and improve the visual quality of images within your application.
override AdjustContrast(float)	Enhance the contrast of the `Image`, amplifying the differences between light and dark areas. Integrate this method into your image processing workflow to improve visual clarity and overall image quality within your application.
override AdjustGamma(float)	Apply gamma correction to the image, adjusting pixel intensities to achieve desired brightness and color balance. Incorporate this method into your image processing workflow to enhance visual quality and improve the accuracy of subsequent analysis or display tasks within your application.
override AdjustGamma(float, float, float)	Perform gamma correction on the image using individual coefficients for the red, green, and blue channels, allowing for fine-tuned adjustments of color balance and contrast. Integrate this method into your image processing pipeline to achieve precise control over color rendering and enhance visual fidelity within your application.
override BinarizeBradley(double)	Binarization of an image using Bradley’s adaptive thresholding algorithm using the integral image thresholding
override BinarizeBradley(double, int)	Apply binarization to the image using Bradley’s adaptive thresholding algorithm with integral image thresholding. This method dynamically computes local thresholds based on the image’s neighborhood, enhancing adaptability to varying lighting conditions and ensuring robust segmentation for subsequent processing tasks within your application.
override BinarizeFixed(byte)	Perform binarization on the image using a predefined threshold value, converting it into a binary image where pixels are classified as foreground or background based on their intensity relative to the threshold. Integrate this method into your image processing workflow to facilitate segmentation and feature extraction tasks, enhancing the accuracy and efficiency of subsequent analysis within your application.
override BinarizeOtsu()	Perform binarization on the image using Otsu’s thresholding method, automatically determining the optimal threshold value based on the image’s histogram. Integrate this method into your image processing workflow to achieve effective segmentation and feature extraction, enhancing the accuracy and reliability of image analysis tasks within your application.
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()	Clear all existing WebP blocks from the image, facilitating a clean slate for subsequent modifications or additions. Utilize this method to effectively reset the block structure within the WebP image data, ensuring optimal management and organization of image content within your application.
override Crop(Rectangle)	Crop the image using a specified rectangle region, removing unwanted portions while retaining the desired content. Integrate this method into your image processing workflow to precisely extract and focus on specific areas of interest within the image, enhancing clarity and composition for various applications.
override Crop(int, int, int, int)	Crop the image by applying left, right, top, and bottom shifts, effectively selecting a region of interest within the image. Utilize this method to dynamically extract desired portions of the image while adjusting its composition and focus according to your application’s requirements.
Dispose()	Disposes the current instance.
Dither(DitheringMethod, int)	Performs dithering on the current image.
override Dither(DitheringMethod, int, IColorPalette)	Perform dithering on the current image to reduce color banding and enhance visual quality. Integrate this method into your image processing workflow to achieve smoother transitions between colors and improve the overall appearance of the image within your application.
override Filter(Rectangle, FilterOptionsBase)	Filter the content within the specified rectangle, applying a designated image processing filter to enhance or modify the selected region. Integrate this method into your image manipulation workflow to achieve targeted enhancements or transformations within your application.
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.
virtual GetOriginalOptions()	Gets the options based on the original file settings. 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()	Convert the image to its grayscale representation, transforming it into a single-channel image where each pixel represents intensity or luminance. Integrate this method into your image processing pipeline to simplify analysis and enhance compatibility with grayscale-based algorithms, facilitating various computer vision and image analysis tasks within your application.
InsertBlock(int, IFrame)	Insert a new WebP block at the specified index within the image, enabling precise control over the block sequence. Integrate this method to seamlessly incorporate additional WebP blocks into the image data structure, facilitating advanced image processing and optimization within your application.
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.
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(IFrame)	Remove the specified WebP block from the image, facilitating efficient management of image data structure. Utilize this method to streamline image processing workflows by eliminating unnecessary blocks or components within your application.
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)	Resize the image according to specified settings, enabling precise control over dimensions, aspect ratio, and scaling behavior. Integrate this method into your image processing workflow to achieve customized resizing operations tailored to the specific requirements of your application.
override Resize(int, int, ResizeType)	Resize the image, adjusting its dimensions while preserving the aspect ratio. Integrate this method into your image processing workflow to dynamically scale images to fit various display or storage requirements within your application.
ResizeHeightProportionally(int)	Resizes the height proportionally. The default NearestNeighbourResample is used.
virtual ResizeHeightProportionally(int, ImageResizeSettings)	Resizes the height proportionally.
override ResizeHeightProportionally(int, ResizeType)	Adjust the height of the image proportionally, while preserving its aspect ratio for consistent resizing. Integrate this method into your image processing workflow to dynamically resize images with uniform proportions, ensuring optimal display or storage within your application.
ResizeWidthProportionally(int)	Resizes the width proportionally. The default NearestNeighbourResample is used.
virtual ResizeWidthProportionally(int, ImageResizeSettings)	Resizes the width proportionally.
override ResizeWidthProportionally(int, ResizeType)	Proportionally adjust the width of the image while maintaining its aspect ratio. Integrate this method into your image processing workflow to dynamically resize images with consistent proportions, ensuring optimal display or storage within your application.
virtual Rotate(float)	Rotate image around the center.
override Rotate(float, bool, Color)	Rotate the image around its center by a specified angle, while proportionally resizing it and applying specified background color parameters. Incorporate this method into your image processing workflow to achieve precise transformations with customizable background colors, ensuring optimal visual presentation within your application.
override RotateFlip(RotateFlipType)	Apply rotation, flipping, or both operations exclusively to the active frame within the image. Integrate this method into your image processing workflow to achieve precise manipulation of individual frames, enhancing flexibility and control over frame transformations within your application.
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.
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

This example shows how to load a WebP image from a file and save it to PNG.

[C#]

string dir = "c:\\temp\\";

// Load a WebP image from a file.
using (Aspose.Imaging.FileFormats.Webp.WebPImage webPImage = new Aspose.Imaging.FileFormats.Webp.WebPImage(dir + "test.webp"))
{
    // Save to PNG
    // Note that only the active frame will be stored to PNG, since PNG is not a multi-page format.
    webPImage.Save(dir + "test.output.png", new Aspose.Imaging.ImageOptions.PngOptions());
}