KGy SOFT Drawing Libraries Help
Icon
Extracts the nearest image of specified size and pixel format from an Icon instance.
Definition
Namespace: KGySoft.Drawing
Assembly: KGySoft.Drawing (in KGySoft.Drawing.dll) Version: 10.1.0
An Bitmap instance, which was extracted from the icon. If no icon was found with the specified size and format the nearest image (pixelFormat matches first, then size) is returned.
Assembly: KGySoft.Drawing (in KGySoft.Drawing.dll) Version: 10.1.0
C#
public static Bitmap ExtractNearestBitmap(
this Icon icon,
Size size,
PixelFormat pixelFormat,
bool keepOriginalFormat = false
)VB
<ExtensionAttribute>
Public Shared Function ExtractNearestBitmap (
icon As Icon,
size As Size,
pixelFormat As PixelFormat,
Optional keepOriginalFormat As Boolean = false
) As BitmapC++
public:
[ExtensionAttribute]
static Bitmap^ ExtractNearestBitmap(
Icon^ icon,
Size size,
PixelFormat pixelFormat,
bool keepOriginalFormat = false
)F#
[<ExtensionAttribute>]
static member ExtractNearestBitmap :
icon : Icon *
size : Size *
pixelFormat : PixelFormat *
?keepOriginalFormat : bool
(* Defaults:
let _keepOriginalFormat = defaultArg keepOriginalFormat false
*)
-> Bitmap Parameters
- icon Icon
- The icon that may contain multiple images.
- size Size
- The required icon size to retrieve.
- pixelFormat PixelFormat
- The required pixel format to retrieve
- keepOriginalFormat Boolean (Optional)
- If , returns the actual icon image with its underlying pixel format, without applying the transparency mask.
Possible transparent pixels of non-32 bpp ARGB icon images will be opaque. If , always returns 32 bpp images with transparency. This parameter is optional.
Default value: .
Return Value
BitmapAn Bitmap instance, which was extracted from the icon. If no icon was found with the specified size and format the nearest image (pixelFormat matches first, then size) is returned.