BitmapDataFactoryCreateBitmapDataT(T, Size, Int32, PixelFormatInfo, FuncICustomBitmapDataRowT, Int32, Int32, ActionICustomBitmapDataRowT, Int32, Int32, Palette, FuncPalette, Boolean, Action) Method

Creates an IReadWriteBitmapData instance with a custom indexed pixel format for a preallocated one dimensional array with the specified parameters. If you can ensure that the delegates don't capture buffer use the CreateBitmapDataT(T, Size, Int32, CustomIndexedBitmapDataConfig) overload instead.
See the Remarks section of the CreateBitmapDataT(T, Size, Int32, CustomIndexedBitmapDataConfig) overload for details.

Definition

Namespace: KGySoft.Drawing.Imaging
Assembly: KGySoft.Drawing.Core (in KGySoft.Drawing.Core.dll) Version: 8.2.0

public static IReadWriteBitmapData CreateBitmapData<T>(
	T[] buffer,
	Size size,
	int stride,
	PixelFormatInfo pixelFormatInfo,
	Func<ICustomBitmapDataRow<T>, int, int>? rowGetColorIndex,
	Action<ICustomBitmapDataRow<T>, int, int>? rowSetColorIndex,
	Palette? palette = null,
	Func<Palette, bool>? trySetPaletteCallback = null,
	Action? disposeCallback = null
)
where T : struct, new()

Public Shared Function CreateBitmapData(Of T As {Structure, New}) ( 
	buffer As T(),
	size As Size,
	stride As Integer,
	pixelFormatInfo As PixelFormatInfo,
	rowGetColorIndex As Func(Of ICustomBitmapDataRow(Of T), Integer, Integer),
	rowSetColorIndex As Action(Of ICustomBitmapDataRow(Of T), Integer, Integer),
	Optional palette As Palette = Nothing,
	Optional trySetPaletteCallback As Func(Of Palette, Boolean) = Nothing,
	Optional disposeCallback As Action = Nothing
) As IReadWriteBitmapData

C++

public:
generic<typename T>
where T : value class, gcnew()
static IReadWriteBitmapData^ CreateBitmapData(
	array<T>^ buffer, 
	Size size, 
	int stride, 
	PixelFormatInfo pixelFormatInfo, 
	Func<ICustomBitmapDataRow<T>^, int, int>^ rowGetColorIndex, 
	Action<ICustomBitmapDataRow<T>^, int, int>^ rowSetColorIndex, 
	Palette^ palette = nullptr, 
	Func<Palette^, bool>^ trySetPaletteCallback = nullptr, 
	Action^ disposeCallback = nullptr
)

static member CreateBitmapData : 
        buffer : 'T[] * 
        size : Size * 
        stride : int * 
        pixelFormatInfo : PixelFormatInfo * 
        rowGetColorIndex : Func<ICustomBitmapDataRow<'T>, int, int> * 
        rowSetColorIndex : Action<ICustomBitmapDataRow<'T>, int, int> * 
        ?palette : Palette * 
        ?trySetPaletteCallback : Func<Palette, bool> * 
        ?disposeCallback : Action 
(* Defaults:
        let _palette = defaultArg palette null
        let _trySetPaletteCallback = defaultArg trySetPaletteCallback null
        let _disposeCallback = defaultArg disposeCallback null
*)
-> IReadWriteBitmapData  when 'T : struct, new()

Parameters

buffer T: A preallocated array to be used as the underlying buffer for the returned IReadWriteBitmapData. It can be larger than it is required for the specified parameters. If the actual image data starts at some offset use the CreateBitmapDataT(ArraySectionT, Size, Int32, PixelFormatInfo, FuncICustomBitmapDataRowT, Int32, Int32, ActionICustomBitmapDataRowT, Int32, Int32, Palette, FuncPalette, Boolean, Action) overload instead.
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.
pixelFormatInfo PixelFormatInfo: A PixelFormatInfo instance that describes the pixel format.
rowGetColorIndex FuncICustomBitmapDataRowT, Int32, Int32: A delegate that can get the color index of a pixel in a row of the bitmap data. If , then the returned instance will be write-only (can be cast to IWritableBitmapData).
rowSetColorIndex ActionICustomBitmapDataRowT, Int32, Int32: A delegate that can set the color index of a pixel in a row of the bitmap data. If , then the returned instance will be read-only (can be cast to IReadableBitmapData).
palette Palette (Optional): Specifies the desired Palette of the returned IReadWriteBitmapData instance. It determines also the BackColor and AlphaThreshold properties of the result. This parameter is optional.
Default value: .
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

ArgumentNullException	buffer is . -or- Both rowGetColorIndex and rowSetColorIndex are .
ArgumentOutOfRangeException	size has a zero or negative width or height -or- stride is too small for the specified width and pixelFormatInfo
ArgumentException	buffer is too small for the specified size, pixelFormatInfo and stride -or- stride is not a multiple of the size of T -or- palette is too large for the specified pixelFormatInfo -or- pixelFormatInfo is not indexed or its BitsPerPixel is not between 1 and 16.