BmpBitmapEncoder Class
Defines an encoder that is used to encode bitmap (BMP) format images.
System.Windows.Threading::DispatcherObject
System.Windows.Media.Imaging::BitmapEncoder
System.Windows.Media.Imaging::BmpBitmapEncoder
Assembly: PresentationCore (in PresentationCore.dll)
XMLNS for XAML: http://schemas.microsoft.com/winfx/2006/xaml/presentation, http://schemas.microsoft.com/netfx/2007/xaml/presentation
The BmpBitmapEncoder type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | CodecInfo | Gets information that describes this codec. (Inherited from BitmapEncoder.) |
![]() | ColorContexts | Gets or sets a value that represents the color profile that is associated with this encoder. (Inherited from BitmapEncoder.) |
![]() | Dispatcher | Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.) |
![]() | Frames | Gets or sets the individual frames within an image. (Inherited from BitmapEncoder.) |
![]() | Metadata | Gets or sets the metadata that will be associated with this bitmap during encoding. (Inherited from BitmapEncoder.) |
![]() | Palette | Gets or sets a value that represents the BitmapPalette of an encoded bitmap. (Inherited from BitmapEncoder.) |
![]() | Preview | Gets or sets a BitmapSource that represents the global preview of a bitmap, if there is one. (Inherited from BitmapEncoder.) |
![]() | Thumbnail | Gets or sets a BitmapSource that represents the global embedded thumbnail. (Inherited from BitmapEncoder.) |
| Name | Description | |
|---|---|---|
![]() | CheckAccess | Determines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.) |
![]() | Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | Save | Encodes a bitmap image to a specified Stream. (Inherited from BitmapEncoder.) |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
![]() | VerifyAccess | Enforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.) |
Bitmap (BMP) format does not support features that are supported by other bitmap formats, including global preview, global thumbnail, global metadata, frame level thumbnails, multiple frames, and frame level metadata.
Encoding does not work in partial trust. See WPF Partial Trust Security for information on partial trust.
The following examples show how to decode and encode a bitmap (BMP) image using the specific BmpBitmapDecoder and BmpBitmapEncoder objects.
This example demonstrates how to decode a BMP image using a BmpBitmapDecoder from a Uri.
// Open a Uri and decode a BMP image System::Uri^ myUri = gcnew System::Uri("tulipfarm.bmp", UriKind::RelativeOrAbsolute); BmpBitmapDecoder^ decoder2 = gcnew BmpBitmapDecoder(myUri, BitmapCreateOptions::PreservePixelFormat, BitmapCacheOption::Default); BitmapSource^ bitmapSource2 = decoder2->Frames[0]; // Draw the Image Image^ myImage2 = gcnew Image(); myImage2->Source = bitmapSource2; myImage2->Stretch = Stretch::None; myImage2->Margin = System::Windows::Thickness(20);
This example demonstrates how to encode a BitmapSource into a BMP image using a BmpBitmapEncoder.
int width = 128;
int height = width;
int stride = width / 8;
array<System::Byte>^ pixels = gcnew array<System::Byte>(height * stride);
List<Color>^ colors = gcnew List<Color>();
colors->Add(Colors::Red);
colors->Add(Colors::Blue);
colors->Add(Colors::Green);
BitmapPalette^ myPalette = gcnew BitmapPalette(colors);
// Creates a new empty image with the pre-defined palette
BitmapSource^ image = BitmapSource::Create(
width,
height,
96,
96,
PixelFormats::Indexed1,
myPalette,
pixels,
stride);
FileStream^ stream = gcnew FileStream("new.bmp", FileMode::Create);
BmpBitmapEncoder^ encoder = gcnew BmpBitmapEncoder();
TextBlock^ myTextBlock = gcnew TextBlock();
myTextBlock->Text = "Codec Author is: " + encoder->CodecInfo->Author->ToString();
encoder->Frames->Add(BitmapFrame::Create(image));
encoder->Save(stream);
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
