API Reference

Class

OfficeRasterImage

Edit on GitHub

Namespace OfficeIMO.Drawing

Assembly OfficeIMO.Core

Source ../../../../_/OfficeIMO.Core/Raster/OfficeRasterImage.cs:16

Modifiers sealed

Dependency-free RGBA raster image buffer.

Inheritance

Object
OfficeRasterImage

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Method OfficeDrawingRasterRenderer.Render
Method OfficeDrawingRasterRenderer.Render
Method OfficeImageComposer.ComposeRaster
Method OfficeImageComposer.ComposeRaster
Method OfficeImageComposer.ComposeRaster
Property OfficeImageLayer.RasterImage
Method OfficeJpegCodec.Decode
Method OfficeRasterResampler.Resize
Method OfficeRasterResampler.Resize
Method OfficeRasterResampler.Resize
Method OfficeRasterResampler.Transform
Property OfficeScanPerspectiveResult.Image
Property OfficeScanProcessingResult.Image

Accepted by parameters

Method IOfficeRasterImageCodec.TryDecode parameter image
Method OfficeBmpReader.TryDecode parameter image
Method OfficeDibReader.TryDecode parameter image
Method OfficeGifReader.TryDecode parameter image
Method OfficeGifReader.TryDecodeFrame parameter image
Method OfficeIccRasterConverter.TryConvertToSrgb parameter image
Method OfficeImageLayer.FromRaster parameter rasterImage
Method OfficeJpegCodec.Encode parameter image
Method OfficeJpegCodec.EncodeTo parameter image
Method OfficeJpegCodec.EncodeTo parameter image
Method OfficeJpegCodec.TryDecode parameter image
Method OfficePngReader.TryDecode parameter image
Method OfficePngWriter.Encode parameter image
Method OfficePngWriter.Encode parameter image
Method OfficePngWriter.Encode parameter image
Method OfficePngWriter.EncodeTo parameter image
Method OfficePngWriter.EncodeTo parameter image
Method OfficePngWriter.EncodeTo parameter image
Method OfficePngWriter.EncodeTo parameter image
Method OfficePngWriter.EncodeTo parameter image
Method OfficePngWriter.EncodeTo parameter image
Constructor OfficeRasterCanvas.OfficeRasterCanvas parameter image
Constructor OfficeRasterCanvas.OfficeRasterCanvas parameter image
Method OfficeRasterCanvas.DrawAffineImage parameter image
Method OfficeRasterCanvas.DrawAffineImage parameter image
Method OfficeRasterCanvas.DrawImage parameter image
Method OfficeRasterCanvas.DrawImage parameter image
Method OfficeRasterCanvas.DrawImage parameter image
Method OfficeRasterCanvas.DrawImage parameter image
Method OfficeRasterCanvas.DrawImage parameter image
Method OfficeRasterCanvas.DrawImage parameter image
Method OfficeRasterCanvas.DrawImage parameter image
Method OfficeRasterImageDecoder.TryDecode parameter image
Method OfficeRasterImageDecoder.TryDecode parameter image
Method OfficeRasterImageDecoder.TryDecode parameter image
Method OfficeRasterImageDecoder.TryDecode parameter image
Method OfficeRasterImageEncoder.Encode parameter image
Method OfficeRasterImageEncoder.Encode parameter image
Method OfficeRasterImageEncoder.EncodeTo parameter image
Method OfficeRasterImageEncoder.EncodeTo parameter image
Method OfficeRasterImageEncoder.EncodeTo parameter image
Method OfficeRasterImageFallbackCodec.TryDecode parameter image
Method OfficeRasterResampler.Resize parameter source
Method OfficeRasterResampler.Resize parameter source
Method OfficeRasterResampler.Resize parameter source
Method OfficeRasterResampler.Transform parameter source
Method OfficeScanProcessor.CorrectPerspective parameter source
Method OfficeScanProcessor.Process parameter source
Method OfficeTiffCodec.Encode parameter image
Method OfficeTiffCodec.EncodePages parameter pages
Method OfficeTiffCodec.EncodePagesTo parameter pages
Method OfficeTiffCodec.EncodeTo parameter image
Method OfficeTiffCodec.EncodeTo parameter image
Method OfficeTiffCodec.TryDecode parameter image
Method OfficeTiffCodec.TryDecodePage parameter image
Method OfficeWebpCodec.Encode parameter image
Method OfficeWebpCodec.Encode parameter image
Method OfficeWebpCodec.EncodeTo parameter image
Method OfficeWebpCodec.EncodeTo parameter image
Method OfficeWebpCodec.EncodeTo parameter image
Method OfficeWebpCodec.EncodeTo parameter image
Method OfficeWebpCodec.TryDecode parameter image

Constructors

public OfficeRasterImage(Int32 width, Int32 height, Nullable<OfficeColor> background = null) #

../../../../_/OfficeIMO.Core/Raster/OfficeRasterImage.cs:16

Creates a new RGBA image buffer.

Parameters

width System.Int32 requiredposition: 0
height System.Int32 requiredposition: 1
background System.Nullable{OfficeIMO.Drawing.OfficeColor} = null optionalposition: 2

Methods

public Void BlendPixel(Int32 x, Int32 y, OfficeColor color) #

../../../../_/OfficeIMO.Core/Raster/OfficeRasterImage.cs:85

Returns: Void

Alpha blends a pixel over the current pixel.

Parameters

x System.Int32 requiredposition: 0
y System.Int32 requiredposition: 1
color OfficeIMO.Drawing.OfficeColor requiredposition: 2

public Void Fill(OfficeColor color) #

../../../../_/OfficeIMO.Core/Raster/OfficeRasterImage.cs:114

Returns: Void

Fills the whole image with a color.

Parameters

color OfficeIMO.Drawing.OfficeColor requiredposition: 0

public OfficeColor GetPixel(Int32 x, Int32 y) #

../../../../_/OfficeIMO.Core/Raster/OfficeRasterImage.cs:65

Returns: OfficeColor

Gets the color of a pixel.

Parameters

x System.Int32 requiredposition: 0
y System.Int32 requiredposition: 1

public Byte[] GetPixels() #

../../../../_/OfficeIMO.Core/Raster/OfficeRasterImage.cs:41

Returns: Byte[]

Returns a copy of the RGBA pixels.

public Void SetPixel(Int32 x, Int32 y, OfficeColor color) #

../../../../_/OfficeIMO.Core/Raster/OfficeRasterImage.cs:72

Returns: Void

Sets a pixel without alpha blending.

Parameters

x System.Int32 requiredposition: 0
y System.Int32 requiredposition: 1
color OfficeIMO.Drawing.OfficeColor requiredposition: 2

Inherited Methods

Properties

public Int32 Width { get; } #

../../../../_/OfficeIMO.Core/Raster/OfficeRasterImage.cs:34

Image width in pixels.

public Int32 Height { get; } #

../../../../_/OfficeIMO.Core/Raster/OfficeRasterImage.cs:37

Image height in pixels.