ColorConvertedBitmap Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Changes the color space of a BitmapSource.
public ref class ColorConvertedBitmap sealed : System::Windows::Media::Imaging::BitmapSource, System::ComponentModel::ISupportInitializepublic sealed class ColorConvertedBitmap : System.Windows.Media.Imaging.BitmapSource, System.ComponentModel.ISupportInitializetype ColorConvertedBitmap = class
inherit BitmapSource
interface ISupportInitializePublic NotInheritable Class ColorConvertedBitmap
Inherits BitmapSource
Implements ISupportInitialize- Inheritance
-
ColorConvertedBitmap
- Implements
Examples
The following example shows how to create an instance of ColorConvertedBitmap and use it to convert color.
Stream imageStream = new FileStream("tulipfarm.jpg", FileMode.Open, FileAccess.Read, FileShare.Read);
BitmapSource myBitmapSource = BitmapFrame.Create(imageStream);
BitmapFrame myBitmapSourceFrame = (BitmapFrame)myBitmapSource;
ColorContext sourceColorContext = myBitmapSourceFrame.ColorContexts[0];
ColorContext destColorContext = new ColorContext(PixelFormats.Bgra32);
ColorConvertedBitmap ccb = new ColorConvertedBitmap(myBitmapSource, sourceColorContext, destColorContext, PixelFormats.Pbgra32);
Image myImage3 = new Image();
myImage3.Source = ccb;
myImage3.Stretch = Stretch.None;
imageStream.Close();
Dim imageStream As New FileStream("tulipfarm.jpg", FileMode.Open, FileAccess.Read, FileShare.Read)
Dim myBitmapSource As BitmapSource = BitmapFrame.Create(imageStream)
Dim myBitmapSourceFrame As BitmapFrame = CType(myBitmapSource, BitmapFrame)
Dim sourceColorContext As ColorContext = myBitmapSourceFrame.ColorContexts(0)
Dim destColorContext As New ColorContext(PixelFormats.Bgra32)
Dim ccb As New ColorConvertedBitmap(myBitmapSource, sourceColorContext, destColorContext, PixelFormats.Pbgra32)
Dim myImage3 As New Image()
myImage3.Source = ccb
myImage3.Stretch = Stretch.None
imageStream.Close()
Remarks
For XAML usage information, see ColorConvertedBitmap Markup Extension.
ColorConvertedBitmap implements the ISupportInitialize interface to optimize initialization on multiple properties. Property changes can only occur 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.
ColorConvertedBitmap objects created using the ColorConvertedBitmap(BitmapSource, ColorContext, ColorContext, PixelFormat) constructor are automatically initialized, and property changes are ignored.
A ColorConvertedBitmap is never cached.
Constructors
| ColorConvertedBitmap() |
Initializes a new instance of the ColorConvertedBitmap class. |
| ColorConvertedBitmap(BitmapSource, ColorContext, ColorContext, PixelFormat) |
Initializes a new instance of the ColorConvertedBitmap class by using the specified values. |
Fields
| DestinationColorContextProperty |
Identifies the DestinationColorContext dependency property. |
| DestinationFormatProperty |
Identifies the DestinationFormat dependency property. |
| SourceColorContextProperty |
Identifies the SourceColorContext dependency property. |
| SourceProperty |
Identifies the Source dependency property. |
Properties
| 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) |
| DestinationColorContext |
Gets or sets a value that identifies the color profile, as defined by the ColorContext class, of the converted bitmap. |
| DestinationFormat |
Gets or sets a value that represents the PixelFormat of the converted bitmap. |
| 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 a value that identifies the source bitmap that is converted. |
| SourceColorContext |
Gets or sets a value that identifies the color profile of the source bitmap. |
| Width |
Gets the width of the bitmap in device-independent units (1/96th inch per unit). (Inherited from BitmapSource) |
Methods
| 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 ColorConvertedBitmap initialization. |
| CheckAccess() |
Determines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject) |
| CheckIfSiteOfOrigin() |
Checks whether the bitmap source content is from a known site of origin. This method is used to make sure that pixel copying operations are safe. (Inherited from BitmapSource) |
| 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 ColorConvertedBitmap, 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. |
| CloneCore(Freezable) |
Makes this instance a deep copy of the specified BitmapSource. 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. (Inherited from BitmapSource) |
| CloneCurrentValue() |
Creates a modifiable clone of this ColorConvertedBitmap object, making deep copies of this object's current values. Resource references, data bindings, and animations are not copied, but their current values are. |
| CloneCurrentValueCore(Freezable) |
Makes this instance a modifiable deep copy of the specified BitmapSource using current property values. Resource references, data bindings, and animations are not copied, but their current values are. (Inherited from BitmapSource) |
| CoerceValue(DependencyProperty) |
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) |
| CreateInstance() |
Initializes a new instance of the Freezable class. (Inherited from Freezable) |
| CreateInstanceCore() |
When implemented in a derived class, creates a new instance of the Freezable derived class. (Inherited from Freezable) |
| EndInit() |
Signals the end of the ColorConvertedBitmap initialization. |
| Equals(Object) |
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 |
| FreezeCore(Boolean) |
Makes an instance of BitmapSource or a derived class immutable. (Inherited from BitmapSource) |
| GetAnimationBaseValue(DependencyProperty) |
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) |
| GetAsFrozenCore(Freezable) |
Makes this instance a clone of the specified BitmapSource object. (Inherited from BitmapSource) |
| 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) |
| GetCurrentValueAsFrozenCore(Freezable) |
Makes this instance a frozen clone of the specified BitmapSource. Resource references, data bindings, and animations are not copied, but their current values are. (Inherited from BitmapSource) |
| 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(DependencyProperty) |
Returns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject) |
| InvalidateProperty(DependencyProperty) |
Re-evaluates the effective value for the specified dependency property. (Inherited from DependencyObject) |
| MemberwiseClone() |
Creates a shallow copy of the current Object. (Inherited from Object) |
| OnChanged() |
Called when the current Freezable object is modified. (Inherited from Freezable) |
| OnFreezablePropertyChanged(DependencyObject, DependencyObject) |
Ensures that appropriate context pointers are established for a DependencyObjectType data member that has just been set. (Inherited from Freezable) |
| OnFreezablePropertyChanged(DependencyObject, DependencyObject, DependencyProperty) |
This member supports the Windows Presentation Foundation (WPF) infrastructure and is not intended to be used directly from your code. (Inherited from Freezable) |
| OnPropertyChanged(DependencyPropertyChangedEventArgs) |
Overrides the DependencyObject implementation of OnPropertyChanged(DependencyPropertyChangedEventArgs) to also invoke any Changed handlers in response to a changing dependency property of type Freezable. (Inherited from Freezable) |
| ReadLocalValue(DependencyProperty) |
Returns the local value of a dependency property, if it exists. (Inherited from DependencyObject) |
| ReadPreamble() |
Ensures that the Freezable is being accessed from a valid thread. Inheritors of Freezable must call this method at the beginning of any API that reads data members that are not dependency properties. (Inherited from Freezable) |
| SetCurrentValue(DependencyProperty, Object) |
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(DependencyProperty) |
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 |
| VerifyAccess() |
Enforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject) |
| WritePostscript() |
Raises the Changed event for the Freezable and invokes its OnChanged() method. Classes that derive from Freezable should call this method at the end of any API that modifies class members that are not stored as dependency properties. (Inherited from Freezable) |
| WritePreamble() |
Verifies that the Freezable is not frozen and that it is being accessed from a valid threading context. Freezable inheritors should call this method at the beginning of any API that writes to data members that are not dependency properties. (Inherited from Freezable) |
Events
| 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) |
Explicit Interface Implementations
| IFormattable.ToString(String, IFormatProvider) |
Formats the value of the current instance using the specified format. (Inherited from ImageSource) |
