FormatConvertedBitmap Class
Provides pixel format conversion functionality for a BitmapSource.
System.Windows.Threading.DispatcherObject
System.Windows.DependencyObject
System.Windows.Freezable
System.Windows.Media.Animation.Animatable
System.Windows.Media.ImageSource
System.Windows.Media.Imaging.BitmapSource
System.Windows.Media.Imaging.FormatConvertedBitmap
Namespace: System.Windows.Media.Imaging
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 FormatConvertedBitmap type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | FormatConvertedBitmap() | Initializes a new instance of the FormatConvertedBitmap class. |
![]() | FormatConvertedBitmap(BitmapSource, PixelFormat, BitmapPalette, Double) | Initializes a new instance of the FormatConvertedBitmap class that has the specified Source, DestinationFormat, DestinationPalette, and AlphaThreshold. |
| Name | Description | |
|---|---|---|
![]() | AlphaThreshold | Gets or sets the alpha channel threshold of a bitmap when converting to palletized formats that recognizes an alpha color. |
![]() | CanFreeze | Gets a value that indicates whether the object can be made unmodifiable. (Inherited from Freezable.) |
![]() | DependencyObjectType | Gets the DependencyObjectType that wraps the CLR type of this instance. (Inherited from DependencyObject.) |
![]() | DestinationFormat | Gets or sets the pixel format to convert the bitmap to. |
![]() | DestinationPalette | Gets or sets the palette to apply to the bitmap if the format is indexed. |
![]() | Dispatcher | Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.) |
![]() | DpiX | Gets the horizontal dots per inch (dpi) of the image. (Inherited from BitmapSource.) |
![]() | DpiY | Gets the vertical dots per inch (dpi) of the image. (Inherited from BitmapSource.) |
![]() | Format | Gets the native PixelFormat of the bitmap data. (Inherited from BitmapSource.) |
![]() | HasAnimatedProperties | Gets a value that indicates whether one or more AnimationClock objects is associated with any of this object's dependency properties. (Inherited from Animatable.) |
![]() | Height | Gets the height of the source bitmap in device-independent units (1/96th inch per unit). (Inherited from BitmapSource.) |
![]() | IsDownloading | Gets a value that indicates whether the BitmapSource content is currently downloading. (Inherited from BitmapSource.) |
![]() | IsFrozen | Gets a value that indicates whether the object is currently modifiable. (Inherited from Freezable.) |
![]() | IsSealed | Gets a value that indicates whether this instance is currently sealed (read-only). (Inherited from DependencyObject.) |
![]() | Metadata | Gets the metadata that is associated with this bitmap image. (Inherited from BitmapSource.) |
![]() | Palette | Gets the color palette of the bitmap, if one is specified. (Inherited from BitmapSource.) |
![]() | PixelHeight | Gets the height of the bitmap in pixels. (Inherited from BitmapSource.) |
![]() | PixelWidth | Gets the width of the bitmap in pixels. (Inherited from BitmapSource.) |
![]() | Source | Gets or sets the source for the bitmap. |
![]() | Width | Gets the width of the bitmap in device-independent units (1/96th inch per unit). (Inherited from BitmapSource.) |
| Name | Description | |
|---|---|---|
![]() | ApplyAnimationClock(DependencyProperty, AnimationClock) | Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the SnapshotAndReplace handoff behavior is used. (Inherited from Animatable.) |
![]() | ApplyAnimationClock(DependencyProperty, AnimationClock, HandoffBehavior) | Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the specified HandoffBehavior is used. (Inherited from Animatable.) |
![]() | BeginAnimation(DependencyProperty, AnimationTimeline) | Applies an animation to the specified DependencyProperty. The animation is started when the next frame is rendered. If the specified property is already animated, the SnapshotAndReplace handoff behavior is used. (Inherited from Animatable.) |
![]() | BeginAnimation(DependencyProperty, AnimationTimeline, HandoffBehavior) | Applies an animation to the specified DependencyProperty. The animation is started when the next frame is rendered. If the specified property is already animated, the specified HandoffBehavior is used. (Inherited from Animatable.) |
![]() | BeginInit | Signals the start of the FormatConvertedBitmap initialization. |
![]() | CheckAccess | Determines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.) |
![]() | ClearValue(DependencyProperty) | Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject.) |
![]() | ClearValue(DependencyPropertyKey) | Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject.) |
![]() | Clone | Creates a modifiable clone of this FormatConvertedBitmap, making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. |
![]() | CloneCurrentValue | Creates a modifiable clone of this FormatConvertedBitmap object, making deep copies of this object's current values. Resource references, data bindings, and animations are not copied, but their current values are. |
![]() | CoerceValue | Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject. (Inherited from DependencyObject.) |
![]() | CopyPixels(Array, Int32, Int32) | Copies the bitmap pixel data into an array of pixels with the specified stride, starting at the specified offset. (Inherited from BitmapSource.) |
![]() | CopyPixels(Int32Rect, Array, Int32, Int32) | Copies the bitmap pixel data within the specified rectangle into an array of pixels that has the specified stride starting at the specified offset. (Inherited from BitmapSource.) |
![]() | CopyPixels(Int32Rect, IntPtr, Int32, Int32) | Copies the bitmap pixel data within the specified rectangle (Inherited from BitmapSource.) |
![]() | EndInit | Signals the end of the FormatConvertedBitmap initialization. |
![]() | Equals | Determines whether a provided DependencyObject is equivalent to the current DependencyObject. (Inherited from DependencyObject.) |
![]() | Freeze() | Makes the current object unmodifiable and sets its IsFrozen property to true. (Inherited from Freezable.) |
![]() | GetAnimationBaseValue | Returns the non-animated value of the specified DependencyProperty. (Inherited from Animatable.) |
![]() | GetAsFrozen | Creates a frozen copy of the Freezable, using base (non-animated) property values. Because the copy is frozen, any frozen sub-objects are copied by reference. (Inherited from Freezable.) |
![]() | GetCurrentValueAsFrozen | Creates a frozen copy of the Freezable using current property values. Because the copy is frozen, any frozen sub-objects are copied by reference. (Inherited from Freezable.) |
![]() | GetHashCode | Gets a hash code for this DependencyObject. (Inherited from DependencyObject.) |
![]() | GetLocalValueEnumerator | Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | GetValue | Returns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject.) |
![]() | InvalidateProperty | Re-evaluates the effective value for the specified dependency property (Inherited from DependencyObject.) |
![]() | ReadLocalValue | Returns the local value of a dependency property, if it exists. (Inherited from DependencyObject.) |
![]() | SetCurrentValue | Sets the value of a dependency property without changing its value source. (Inherited from DependencyObject.) |
![]() | SetValue(DependencyProperty, Object) | Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject.) |
![]() | SetValue(DependencyPropertyKey, Object) | Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject.) |
![]() | ShouldSerializeProperty | Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property. (Inherited from DependencyObject.) |
![]() | ToString() | Creates a string representation of this object based on the current culture. (Inherited from ImageSource.) |
![]() | ToString(IFormatProvider) | Creates a string representation of this object based on the IFormatProvider passed in. If the provider is null, the CurrentCulture is used. (Inherited from ImageSource.) |
![]() | VerifyAccess | Enforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.) |
| Name | Description | |
|---|---|---|
![]() | Changed | Occurs when the Freezable or an object it contains is modified. (Inherited from Freezable.) |
![]() | DecodeFailed | Occurs when the image fails to load, due to a corrupt image header. (Inherited from BitmapSource.) |
![]() | DownloadCompleted | Occurs when the bitmap content has been completely downloaded. (Inherited from BitmapSource.) |
![]() | DownloadFailed | Occurs when the bitmap content failed to download. (Inherited from BitmapSource.) |
![]() | DownloadProgress | Occurs when the download progress of the bitmap content has changed. (Inherited from BitmapSource.) |
| Name | Description | |
|---|---|---|
![]() ![]() | AlphaThresholdProperty | Identifies the AlphaThreshold dependency property. |
![]() ![]() | DestinationFormatProperty | Identifies the DestinationFormat dependency property. |
![]() ![]() | DestinationPaletteProperty | Identifies the DestinationPalette dependency property. |
![]() ![]() | SourceProperty | Identifies the Source dependency property. |
| Name | Description | |
|---|---|---|
![]() ![]() | IFormattable.ToString | Formats the value of the current instance using the specified format. (Inherited from ImageSource.) |
FormatConvertedBitmap implements the ISupportInitialize interface to optimize initialization on multiple properties. Property changes can occur only during object initialization. Call BeginInit to signal that initialization has begun and EndInit to signal that initialization has completed. After initialization, property changes are ignored.
FormatConvertedBitmap objects created using the FormatConvertedBitmap(BitmapSource, PixelFormat, BitmapPalette, Double) constructor are automatically initialized, and property changes are ignored.
For format conversions between RGB color spaces with different characteristics, the ColorConvertedBitmap class should be used. Conversions between color spaces need a source color profile and destination color profile for gamut mapping to provide a reliable color conversion. The color profiles are provided by the ColorContext parameters of the ColorConvertedBitmap or by the DestinationColorContext and SourceColorContext properties.
Metadata tags related to image data must be updated if an image is saved to a file after a transform is applied.
This example shows how to convert an image to grayscale using FormatConvertedBitmap.
<Page xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"> <Page.Resources> <!-- This resource defines a BitmapImage with a source and a DecodePixelWidth of 200. This property is set to the same value as the desired width of the image to save on memory use. This BitmapImage is used as the base for the other BitmapSource resources. --> <BitmapImage x:Key="masterImage" DecodePixelWidth="200" UriSource="C:\Documents and Settings\All Users\Documents\My Pictures\Sample Pictures\Forest.jpg"/> <!-- This FormatConvertedBitmap uses the BitmapImage defined above and changes the format to Gray32Float (grayscale). --> <FormatConvertedBitmap x:Key="convertFormatImage" Source="{StaticResource masterImage}" DestinationFormat="Gray32Float" /> </Page.Resources> <StackPanel> <!-- Apply the "convertFormatImage" resource defined above to this image. --> <Image Width="200" Source="{StaticResource convertFormatImage}" /> </StackPanel> </Page>
using System; using System.Windows; using System.Windows.Controls; using System.Windows.Media; using System.Windows.Media.Imaging; namespace SDKSample { public partial class FormatConvertedBitmapExample : Page { public FormatConvertedBitmapExample() { ///// Create a BitmapImage and set it's DecodePixelWidth to 200. Use ///// ///// this BitmapImage as a source for other BitmapSource objects. ///// BitmapImage myBitmapImage = new BitmapImage(); // BitmapSource objects like BitmapImage can only have their properties // changed within a BeginInit/EndInit block. myBitmapImage.BeginInit(); myBitmapImage.UriSource = new Uri(@"sampleImages/WaterLilies.jpg",UriKind.Relative); // To save significant application memory, set the DecodePixelWidth or // DecodePixelHeight of the BitmapImage value of the image source to the desired // height or width of the rendered image. If you don't do this, the application will // cache the image as though it were rendered as its normal size rather then just // the size that is displayed. // Note: In order to preserve aspect ratio, set DecodePixelWidth // or DecodePixelHeight but not both. myBitmapImage.DecodePixelWidth = 200; myBitmapImage.EndInit(); ////////// Convert the BitmapSource to a new format //////////// // Use the BitmapImage created above as the source for a new BitmapSource object // which is set to a gray scale format using the FormatConvertedBitmap BitmapSource. // Note: New BitmapSource does not cache. It is always pulled when required. FormatConvertedBitmap newFormatedBitmapSource = new FormatConvertedBitmap(); // BitmapSource objects like FormatConvertedBitmap can only have their properties // changed within a BeginInit/EndInit block. newFormatedBitmapSource.BeginInit(); // Use the BitmapSource object defined above as the source for this new // BitmapSource (chain the BitmapSource objects together). newFormatedBitmapSource.Source = myBitmapImage; // Set the new format to Gray32Float (grayscale). newFormatedBitmapSource.DestinationFormat = PixelFormats.Gray32Float; newFormatedBitmapSource.EndInit(); // Create Image Element Image myImage = new Image(); myImage.Width = 200; //set image source myImage.Source = newFormatedBitmapSource; // Add Image to the UI StackPanel myStackPanel = new StackPanel(); myStackPanel.Children.Add(myImage); this.Content = myStackPanel; } } }
More Code
| How to: Convert a BitmapSource to an Indexed Pixel Format | This example shows how to convert a BitmapSource to an indexed pixel format. |
| How to: Chain BitmapSource Objects Together | This example shows how you can apply a variety of effects to an image source by chaining multiple BitmapSource derived objects together. |
Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.







