Property OutputPixelFormat
- Namespace
- PaintDotNet.Effects
- Assembly
- PaintDotNet.Effects.Core.dll
OutputPixelFormat
Specifies the pixel format for the output buffer.
PixelFormat OutputPixelFormat { get; set; }Property Value
Remarks
If the effect does not set this property, the output buffer will default to Bgra32.
The effect must use the same pixel format when retrieving its output buffer with
Lock(in PixelFormat).
Setting this value does not guarantee that the effect's output will be stored in any particular pixel
format, but it permits the effect infrastructure to know ahead-of-time the format and precision that
is optimal for the effect.
When specifying a floating-point pixel format, such as Rgba128Float, the
effect must operate in linear gamma mode. If the working space of the document
(ColorContext cannot be linearized, then scRGB (aka linearized
sRGB) must be used instead.
Exceptions
- UnsupportedPixelFormatException
The pixel format is not supported.