WriteableBitmap WriteableBitmap WriteableBitmap WriteableBitmap Class

Definition

Provides a BitmapSource that can be written to and updated.

public : sealed class WriteableBitmap : BitmapSource
struct winrt::Windows::UI::Xaml::Media::Imaging::WriteableBitmap : BitmapSource
public sealed class WriteableBitmap : BitmapSource
Public NotInheritable Class WriteableBitmap Inherits BitmapSource
Inheritance
WriteableBitmapWriteableBitmapWriteableBitmapWriteableBitmap
Attributes

Windows 10 requirements

Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

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) WriteableBitmap(Int32, Int32) WriteableBitmap(Int32, Int32) WriteableBitmap(Int32, Int32)

Initializes a new instance of the WriteableBitmap class.

Properties

Dispatcher Dispatcher Dispatcher 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.

(Inherited from DependencyObject)
PixelBuffer PixelBuffer PixelBuffer PixelBuffer

Gets an access for the direct buffer where each pixel of the WriteableBitmap is written to.

PixelHeight PixelHeight PixelHeight PixelHeight

Gets the height of the bitmap in pixels.

(Inherited from BitmapSource)
PixelHeightProperty PixelHeightProperty PixelHeightProperty PixelHeightProperty

Identifies the PixelHeight dependency property.

(Inherited from BitmapSource)
PixelWidth PixelWidth PixelWidth PixelWidth

Gets the width of the bitmap in pixels.

(Inherited from BitmapSource)
PixelWidthProperty PixelWidthProperty PixelWidthProperty PixelWidthProperty

Identifies the PixelWidth dependency property.

(Inherited from BitmapSource)

Methods

ClearValue(DependencyProperty) ClearValue(DependencyProperty) ClearValue(DependencyProperty) ClearValue(DependencyProperty)

Clears the local value of a dependency property.

(Inherited from DependencyObject)
GetAnimationBaseValue(DependencyProperty) GetAnimationBaseValue(DependencyProperty) GetAnimationBaseValue(DependencyProperty) GetAnimationBaseValue(DependencyProperty)

Returns any base value established for a dependency property, which would apply in cases where an animation is not active.

(Inherited from DependencyObject)
GetValue(DependencyProperty) GetValue(DependencyProperty) GetValue(DependencyProperty) GetValue(DependencyProperty)

Returns the current effective value of a dependency property from a DependencyObject.

(Inherited from DependencyObject)
Invalidate() Invalidate() Invalidate() Invalidate()

Requests a draw or redraw of the entire bitmap.

ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty)

Returns the local value of a dependency property, if a local value is set.

(Inherited from DependencyObject)
RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback)

Registers a notification function for listening to changes to a specific DependencyProperty on this DependencyObject instance.

(Inherited from DependencyObject)
SetSource(IRandomAccessStream) SetSource(IRandomAccessStream) SetSource(IRandomAccessStream) SetSource(IRandomAccessStream)

Sets the source image for a BitmapSource by accessing a stream. Most callers should use SetSourceAsync instead.

(Inherited from BitmapSource)
SetSourceAsync(IRandomAccessStream) SetSourceAsync(IRandomAccessStream) SetSourceAsync(IRandomAccessStream) SetSourceAsync(IRandomAccessStream)

Sets the source image for a BitmapSource by accessing a stream and processing the result asynchronously.

(Inherited from BitmapSource)
SetValue(DependencyProperty,Object) SetValue(DependencyProperty,Object) SetValue(DependencyProperty,Object) SetValue(DependencyProperty,Object)

Sets the local value of a dependency property on a DependencyObject.

(Inherited from DependencyObject)
UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64)

Cancels a change notification that was previously registered by calling RegisterPropertyChangedCallback.

(Inherited from DependencyObject)

See also