Method GetBitmap

Namespace

PaintDotNet.Effects

Assembly

PaintDotNet.Effects.Core.dll

GetBitmap<TPixel>(IEffectDocumentInfo)

Gets a bitmap that renders the document in the requested pixel format. This is the full composition of the document, including all of the layers with their rendering properties applied (blend mode, opacity, and visibility).

public static IEffectInputBitmap<TPixel> GetBitmap<TPixel>(this IEffectDocumentInfo document) where TPixel : unmanaged, INaturalPixelInfo

Parameters

document IEffectDocumentInfo

The document.

Returns

IEffectInputBitmap<TPixel>

The bitmap.

Type Parameters

TPixel

The requested pixel struct for the bitmap. The native pixel struct used by Paint.NET is currently ColorBgra32, which corresponds to the Bgra32 pixel format. Specifying a different pixel struct/format is valid, but will incur conversion overhead.