BitmapDataFactoryCreateBitmapDataT(Array2DT, Int32, PixelFormatInfo, FuncICustomBitmapDataRowT, Int32, Color32, ActionICustomBitmapDataRowT, Int32, Color32, Color32, Byte, Action) Method

Creates an IReadWriteBitmapData instance with a custom non-indexed pixel format wrapping the specified buffer and using the specified parameters.
See the Remarks section of the CreateBitmapDataT(T, Size, Int32, PixelFormatInfo, FuncICustomBitmapDataRowT, Int32, Color32, ActionICustomBitmapDataRowT, Int32, Color32, Color32, Byte, Action) overload for details.

Definition

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

public static IReadWriteBitmapData CreateBitmapData<T>(
	Array2D<T> buffer,
	int pixelWidth,
	PixelFormatInfo pixelFormatInfo,
	Func<ICustomBitmapDataRow<T>, int, Color32> rowGetColor,
	Action<ICustomBitmapDataRow<T>, int, Color32> rowSetColor,
	Color32 backColor = default,
	byte alphaThreshold = 128,
	Action? disposeCallback = null
)
where T : struct, new()

Public Shared Function CreateBitmapData(Of T As {Structure, New}) ( 
	buffer As Array2D(Of T),
	pixelWidth As Integer,
	pixelFormatInfo As PixelFormatInfo,
	rowGetColor As Func(Of ICustomBitmapDataRow(Of T), Integer, Color32),
	rowSetColor As Action(Of ICustomBitmapDataRow(Of T), Integer, Color32),
	Optional backColor As Color32 = Nothing,
	Optional alphaThreshold As Byte = 128,
	Optional disposeCallback As Action = Nothing
) As IReadWriteBitmapData

C++

public:
generic<typename T>
where T : value class, gcnew()
static IReadWriteBitmapData^ CreateBitmapData(
	Array2D<T> buffer, 
	int pixelWidth, 
	PixelFormatInfo pixelFormatInfo, 
	Func<ICustomBitmapDataRow<T>^, int, Color32>^ rowGetColor, 
	Action<ICustomBitmapDataRow<T>^, int, Color32>^ rowSetColor, 
	Color32 backColor = Color32(), 
	unsigned char alphaThreshold = 128, 
	Action^ disposeCallback = nullptr
)

static member CreateBitmapData : 
        buffer : Array2D<'T> * 
        pixelWidth : int * 
        pixelFormatInfo : PixelFormatInfo * 
        rowGetColor : Func<ICustomBitmapDataRow<'T>, int, Color32> * 
        rowSetColor : Action<ICustomBitmapDataRow<'T>, int, Color32> * 
        ?backColor : Color32 * 
        ?alphaThreshold : byte * 
        ?disposeCallback : Action 
(* Defaults:
        let _backColor = defaultArg backColor new Color32()
        let _alphaThreshold = defaultArg alphaThreshold 128
        let _disposeCallback = defaultArg disposeCallback null
*)
-> IReadWriteBitmapData  when 'T : struct, new()

Parameters

buffer Array2DT: An Array2D<T> to be used as the underlying buffer for the returned IReadWriteBitmapData.
pixelWidth Int32: The width of the bitmap data to create in pixels.
pixelFormatInfo PixelFormatInfo: A PixelFormatInfo instance that describes the pixel format.
rowGetColor FuncICustomBitmapDataRowT, Int32, Color32: A delegate that can get the color of a pixel in a row of the bitmap data.
rowSetColor ActionICustomBitmapDataRowT, Int32, Color32: A delegate that can set the color of a pixel in a row of the bitmap data.
backColor Color32 (Optional): For pixel formats without alpha gradient support specifies the BackColor value of the returned IReadWriteBitmapData instance. It does not affect the actual returned bitmap content. See the Remarks section of the CreateBitmapData(Size, KnownPixelFormat, WorkingColorSpace, Color32, Byte) overload for details. The alpha value (Color32.A field) of the specified background color is ignored. This parameter is optional.
Default value: The default value of the Color32 type, which has the same RGB values as Black.
alphaThreshold Byte (Optional): For pixel formats without alpha gradient support specifies the AlphaThreshold value of the returned IReadWriteBitmapData instance. See the Remarks section of the CreateBitmapData(Size, KnownPixelFormat, WorkingColorSpace, Color32, Byte) overload for details. This parameter is optional.
Default value: 128.
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	The IsNull property of buffer is . -or- rowGetColor or rowSetColor is .
ArgumentOutOfRangeException	pixelWidth is too large for the specified buffer and pixelFormatInfo.
ArgumentException	buffer is empty -or- pixelFormatInfo is indexed or its BitsPerPixel is 0.