BitmapDataFactoryCreateBitmapDataT(ArraySectionT, Size, Int32, KnownPixelFormat, Palette, FuncPalette, Boolean, Action) Method

Creates an IReadWriteBitmapData instance wrapping the specified buffer and using the specified parameters.

Definition

Namespace: KGySoft.Drawing.Imaging
Assembly: KGySoft.Drawing.Core (in KGySoft.Drawing.Core.dll) Version: 8.1.0
C#
public static IReadWriteBitmapData CreateBitmapData<T>(
	ArraySection<T> buffer,
	Size size,
	int stride,
	KnownPixelFormat pixelFormat,
	Palette? palette,
	Func<Palette, bool>? trySetPaletteCallback = null,
	Action? disposeCallback = null
)
where T : struct, new()

Parameters

buffer  ArraySectionT
An ArraySection<T> to be used as the underlying buffer for the returned IReadWriteBitmapData. It can be larger than it is required for the specified parameters.
size  Size
The size of the bitmap data to create in pixels.
stride  Int32
The size of a row in bytes. It allows to have some padding at the end of each row.
pixelFormat  KnownPixelFormat
The pixel format in buffer and the bitmap data to create.
palette  Palette
If pixelFormat represents an indexed format, then specifies the desired Palette of the returned IReadWriteBitmapData instance. It determines also the BackColor and AlphaThreshold properties of the result.
trySetPaletteCallback  FuncPalette, Boolean  (Optional)
A delegate to be called when the palette is attempted to be replaced by the TrySetPalette method. If buffer belongs to some custom bitmap implementation, it can be used to update its original palette. This parameter is optional.
Default value: .
disposeCallback  Action  (Optional)
A delegate to be called when the returned IReadWriteBitmapData is disposed or finalized. This parameter is optional.
Default value: .

Type Parameters

T
The type of the elements in buffer.

Return Value

IReadWriteBitmapData
An IReadWriteBitmapData instance wrapping the specified buffer and using the provided parameters.

Exceptions

ArgumentNullExceptionbuffer is Null.
ArgumentOutOfRangeExceptionsize has a zero or negative width or height
-or-
pixelFormat is not one of the valid formats
-or-
stride is too small for the specified width and pixelFormat.
ArgumentExceptionbuffer is too small for the specified size, pixelFormat and stride
-or-
stride is not a multiple of the size of T
-or-
palette is too large for the specified pixelFormat.

See Also