BitmapDataFactoryCreateBitmapDataT(Array2DT, Int32, KnownPixelFormat, Color32, Byte, Action) Method

Creates an IReadWriteBitmapData instance wrapping the specified buffer and using the specified parameters.
See the Remarks section of the CreateBitmapData(Size, KnownPixelFormat, WorkingColorSpace, Color32, Byte) 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>(
	Array2D<T> buffer,
	int pixelWidth,
	KnownPixelFormat pixelFormat = KnownPixelFormat.Format32bppArgb,
	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,
	Optional pixelFormat As KnownPixelFormat = KnownPixelFormat.Format32bppArgb,
	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, 
	KnownPixelFormat pixelFormat = KnownPixelFormat::Format32bppArgb, 
	Color32 backColor = Color32(), 
	unsigned char alphaThreshold = 128, 
	Action^ disposeCallback = nullptr
)

static member CreateBitmapData : 
        buffer : Array2D<'T> * 
        pixelWidth : int * 
        ?pixelFormat : KnownPixelFormat * 
        ?backColor : Color32 * 
        ?alphaThreshold : byte * 
        ?disposeCallback : Action 
(* Defaults:
        let _pixelFormat = defaultArg pixelFormat KnownPixelFormat.Format32bppArgb
        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.
pixelFormat KnownPixelFormat (Optional): The pixel format in buffer and the bitmap data to create. This parameter is optional.
Default value: Format32bppArgb.
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 .
ArgumentOutOfRangeException	pixelWidth is too large for the specified buffer and pixelFormat -or- pixelFormat is not one of the valid formats.
ArgumentException	buffer is empty.