Class ImageContext

Namespace

NAPS2.Images

Assembly

NAPS2.Images.dll

public abstract class ImageContext

Inheritance

object

ImageContext

Derived

GdiImageContext

GtkImageContext

ImageSharpImageContext

MacImageContext

WpfImageContext

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ImageContext(Type)

protected ImageContext(Type imageType)

Parameters

imageType Type

Properties

ImageType

public Type ImageType { get; }

Property Value

Type

SupportsJpeg2000

protected virtual bool SupportsJpeg2000 { get; }

Property Value

bool

SupportsTiff

protected virtual bool SupportsTiff { get; }

Property Value

bool

TiffWriter

public virtual ITiffWriter TiffWriter { get; }

Property Value

ITiffWriter

Methods

CheckSupportsFormat(ImageFileFormat)

public void CheckSupportsFormat(ImageFileFormat format)

Parameters

format ImageFileFormat

Create(int, int, ImagePixelFormat)

Creates a new empty image.

public abstract IMemoryImage Create(int width, int height, ImagePixelFormat pixelFormat)

Parameters

width int

The image width in pixels.

height int

The image height in pixels.

pixelFormat ImagePixelFormat

The image's pixel format.

Returns

IMemoryImage

GetFileFormatFromExtension(string)

public static ImageFileFormat GetFileFormatFromExtension(string path)

Parameters

path string

Returns

ImageFileFormat

GetFileFormatFromFirstBytes(byte[])

public static ImageFileFormat GetFileFormatFromFirstBytes(byte[] firstBytes)

Parameters

firstBytes byte[]

Returns

ImageFileFormat

Load(byte[])

public IMemoryImage Load(byte[] bytes)

Parameters

bytes byte[]

Returns

IMemoryImage

Load(Stream)

Decodes an image from the given stream.

public IMemoryImage Load(Stream stream)

Parameters

stream Stream

The image data, in a common format (JPEG, PNG, etc).

Returns

IMemoryImage

Load(string)

Loads an image from the given file path.

public IMemoryImage Load(string path)

Parameters

path string

The image path.

Returns

IMemoryImage

LoadCore(Stream, ImageFileFormat)

protected abstract IMemoryImage LoadCore(Stream stream, ImageFileFormat format)

Parameters

stream Stream

format ImageFileFormat

Returns

IMemoryImage

LoadFrames(Stream, ProgressHandler)

Loads an image that may have multiple frames (e.g. a TIFF file) from the given stream.

public IAsyncEnumerable<IMemoryImage> LoadFrames(Stream stream, ProgressHandler progress = default)

Parameters

stream Stream

The image data, in a common format (JPEG, PNG, etc).

progress ProgressHandler

The progress callback and/or cancellation token.

Returns

IAsyncEnumerable<IMemoryImage>

LoadFrames(string, ProgressHandler)

Loads an image that may have multiple frames (e.g. a TIFF file) from the given file path.

public IAsyncEnumerable<IMemoryImage> LoadFrames(string path, ProgressHandler progress = default)

Parameters

path string

The image path.

progress ProgressHandler

The progress callback and/or cancellation token.

Returns

IAsyncEnumerable<IMemoryImage>

LoadFramesCore(Action<IMemoryImage>, Stream, ImageFileFormat, ProgressHandler)

protected abstract void LoadFramesCore(Action<IMemoryImage> produceImage, Stream stream, ImageFileFormat format, ProgressHandler progress)

Parameters

produceImage Action<IMemoryImage>

stream Stream

format ImageFileFormat

progress ProgressHandler

PerformAllTransforms(IMemoryImage, IEnumerable<Transform>)

Performs the specified transformations on the specified image using a compatible transformer.

public IMemoryImage PerformAllTransforms(IMemoryImage image, IEnumerable<Transform> transforms)

Parameters

image IMemoryImage

transforms IEnumerable<Transform>

Returns

IMemoryImage

PerformTransform(IMemoryImage, Transform)

Performs the specified transformation on the specified image using a compatible transformer.

public abstract IMemoryImage PerformTransform(IMemoryImage image, Transform transform)

Parameters

image IMemoryImage

transform Transform

Returns

IMemoryImage

Render(IRenderableImage)

public IMemoryImage Render(IRenderableImage image)

Parameters

image IRenderableImage

Returns

IMemoryImage

RenderWithoutTransforms(IRenderableImage)

public IMemoryImage RenderWithoutTransforms(IRenderableImage image)

Parameters

image IRenderableImage

Returns

IMemoryImage

SupportsFormat(ImageFileFormat)

public bool SupportsFormat(ImageFileFormat format)

Parameters

format ImageFileFormat

Returns

bool