WriteableBitmap Class
Definition
Provides a BitmapSource that can be written to and updated.
Equivalent WinUI class: Microsoft.UI.Xaml.Media.Imaging.WriteableBitmap.
public ref class WriteableBitmap sealed : BitmapSource/// [Windows.Foundation.Metadata.Activatable(Windows.UI.Xaml.Media.Imaging.IWriteableBitmapFactory, 65536, Windows.Foundation.UniversalApiContract)]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.WebHostHidden]
class WriteableBitmap sealed : BitmapSource/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.WebHostHidden]
/// [Windows.Foundation.Metadata.Activatable(Windows.UI.Xaml.Media.Imaging.IWriteableBitmapFactory, 65536, "Windows.Foundation.UniversalApiContract")]
class WriteableBitmap sealed : BitmapSource[Windows.Foundation.Metadata.Activatable(typeof(Windows.UI.Xaml.Media.Imaging.IWriteableBitmapFactory), 65536, typeof(Windows.Foundation.UniversalApiContract))]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.WebHostHidden]
public sealed class WriteableBitmap : BitmapSource[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.WebHostHidden]
[Windows.Foundation.Metadata.Activatable(typeof(Windows.UI.Xaml.Media.Imaging.IWriteableBitmapFactory), 65536, "Windows.Foundation.UniversalApiContract")]
public sealed class WriteableBitmap : BitmapSourcePublic NotInheritable Class WriteableBitmap
Inherits BitmapSource- Inheritance
- Attributes
Windows 10 requirements
| Device family |
Windows 10 (introduced in 10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced in v1.0)
|
Examples
For code examples in C#, C++/WinRT, and C++/CX, see WriteableBitmap.PixelBuffer.
Remarks
The image source data of a WriteableBitmap is an underlying pixel buffer.
The IBuffer returned by WriteableBitmap.PixelBuffer can't be written to directly. But you can use language-specific techniques to write to the underlying pixel content in the buffer. For details, see the Remarks section of WriteableBitmap.PixelBuffer.
Some of the scenarios where you might have used a WriteableBitmap class in previous XAML frameworks can be accomplished in the Windows Runtime by using the RenderTargetBitmap class instead. For more info see RenderTargetBitmap.
Constructors
| WriteableBitmap(Int32, Int32) |
Initializes a new instance of the WriteableBitmap class. Equivalent WinUI constructor: Microsoft.UI.Xaml.Media.Imaging.WriteableBitmap.WriteableBitmap. |
Properties
| Dispatcher |
Gets the CoreDispatcher that this object is associated with. The CoreDispatcher represents a facility that can access the DependencyObject on the UI thread even if the code is initiated by a non-UI thread. Equivalent WinUI property: Microsoft.UI.Xaml.DependencyObject.Dispatcher. (Inherited from DependencyObject) |
| PixelBuffer |
Gets an access for the direct buffer where each pixel of the WriteableBitmap is written to. Equivalent WinUI property: Microsoft.UI.Xaml.Media.Imaging.WriteableBitmap.PixelBuffer. |
| PixelHeight |
Gets the height of the bitmap in pixels. Equivalent WinUI property: Microsoft.UI.Xaml.Media.Imaging.BitmapSource.PixelHeight. (Inherited from BitmapSource) |
| PixelWidth |
Gets the width of the bitmap in pixels. Equivalent WinUI property: Microsoft.UI.Xaml.Media.Imaging.BitmapSource.PixelWidth. (Inherited from BitmapSource) |
Methods
| ClearValue(DependencyProperty) |
Clears the local value of a dependency property. Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.ClearValue. (Inherited from DependencyObject) |
| GetAnimationBaseValue(DependencyProperty) |
Returns any base value established for a dependency property, which would apply in cases where an animation is not active. Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.GetAnimationBaseValue. (Inherited from DependencyObject) |
| GetValue(DependencyProperty) |
Returns the current effective value of a dependency property from a DependencyObject. Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.GetValue. (Inherited from DependencyObject) |
| Invalidate() |
Requests a draw or redraw of the entire bitmap. Equivalent WinUI method: Microsoft.UI.Xaml.Media.Imaging.WriteableBitmap.Invalidate. |
| ReadLocalValue(DependencyProperty) |
Returns the local value of a dependency property, if a local value is set. Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.ReadLocalValue. (Inherited from DependencyObject) |
| RegisterPropertyChangedCallback(DependencyProperty, DependencyPropertyChangedCallback) |
Registers a notification function for listening to changes to a specific DependencyProperty on this DependencyObject instance. Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.RegisterPropertyChangedCallback. (Inherited from DependencyObject) |
| SetSource(IRandomAccessStream) |
Sets the source image for a BitmapSource by accessing a stream. Most callers should use SetSourceAsync instead. Equivalent WinUI method: Microsoft.UI.Xaml.Media.Imaging.BitmapSource.SetSource. (Inherited from BitmapSource) |
| SetSourceAsync(IRandomAccessStream) |
Sets the source image for a BitmapSource by accessing a stream and processing the result asynchronously. Equivalent WinUI method: Microsoft.UI.Xaml.Media.Imaging.BitmapSource.SetSourceAsync. (Inherited from BitmapSource) |
| SetValue(DependencyProperty, Object) |
Sets the local value of a dependency property on a DependencyObject. Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.SetValue. (Inherited from DependencyObject) |
| UnregisterPropertyChangedCallback(DependencyProperty, Int64) |
Cancels a change notification that was previously registered by calling RegisterPropertyChangedCallback. Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.UnregisterPropertyChangedCallback. (Inherited from DependencyObject) |