Method GetBitmap

Namespace

PaintDotNet.Effects

Assembly

PaintDotNet.Effects.Core.dll

GetBitmap(in PixelFormat)

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).

IEffectInputBitmap GetBitmap(in PixelFormat pixelFormat)

Parameters

pixelFormat PixelFormat

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

Returns

IEffectInputBitmap

The bitmap.

Remarks

When retrieving a bitmap in a floating-point pixel format, such as Rgba128Float, the bitmap will be converted to linear gamma. If the working space of the document (ColorContext) cannot be linearized, then scRGB (aka linearized sRGB) will be used instead.