Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, CLI, Studio and browser tools 573 stars PSWriteOfficePowerShell module 165 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/

API Reference

Class

OfficeRasterImage

Edit on GitHub
Namespace OfficeIMO.Drawing
Assembly OfficeIMO.Core
Source OfficeRasterImage.cs:18
Modifiers sealed

Dependency-free RGBA raster image buffer.

Inheritance

  • Object
  • OfficeRasterImage

Remarks

Pixels use tightly packed, top-to-bottom, straight-alpha RGBA bytes. The mutable image is not thread-safe. Pixel writes outside the canvas are clipped; pixel reads require in-bounds coordinates.

Usage

Explore 123 API references to this type

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

Returned or exposed by 46

Accepted by parameters 77

Constructors

public OfficeRasterImage(Int32 width, Int32 height, OfficeColor? background = null) #
OfficeRasterImage.cs:18

Creates a new RGBA image buffer.

Parameters

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

Methods

public Void BlendPixel(Int32 x, Int32 y, OfficeColor color) #
OfficeRasterImage.cs:99
Returns: Void

Alpha blends a pixel over the current pixel. Coordinates outside the canvas are ignored.

Parameters

x System.Int32 requiredposition: 0
y System.Int32 requiredposition: 1
color OfficeIMO.Drawing.OfficeColor requiredposition: 2
public OfficeRasterImage Clone() #
OfficeRasterImage.cs:63
Returns: OfficeRasterImage

Returns an independent image with the same dimensions and RGBA samples.

public Void Fill(OfficeColor color) #
OfficeRasterImage.cs:128
Returns: Void

Fills the whole image with a color.

Parameters

color OfficeIMO.Drawing.OfficeColor requiredposition: 0
public static OfficeRasterImage FromRgba32(Int32 width, Int32 height, Byte[] pixels) #
OfficeRasterImage.cs:54
Returns: OfficeRasterImage

Creates an image from tightly packed, top-to-bottom RGBA bytes, copying the caller's buffer.

Parameters

width System.Int32 requiredposition: 0
height System.Int32 requiredposition: 1
pixels System.Byte[] requiredposition: 2
public OfficeColor GetPixel(Int32 x, Int32 y) #
OfficeRasterImage.cs:79
Returns: OfficeColor

Gets the color of a pixel.

Parameters

x System.Int32 requiredposition: 0
y System.Int32 requiredposition: 1
public Byte[] GetPixels() #
OfficeRasterImage.cs:45
Returns: Byte[]

Returns an independent copy of the tightly packed RGBA pixels.

public Void SetPixel(Int32 x, Int32 y, OfficeColor color) #
OfficeRasterImage.cs:86
Returns: Void

Sets a pixel without alpha blending. Coordinates outside the canvas are ignored.

Parameters

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

Properties

public Int32 Width { get; } #
OfficeRasterImage.cs:37

Image width in pixels.

public Int32 Height { get; } #
OfficeRasterImage.cs:40

Image height in pixels.