WriteableBitmap 类

定义

提供一个可写入并可更新的 BitmapSource

public ref class WriteableBitmap sealed : System::Windows::Media::Imaging::BitmapSource
public sealed class WriteableBitmap : System.Windows.Media.Imaging.BitmapSource
type WriteableBitmap = class
    inherit BitmapSource
Public NotInheritable Class WriteableBitmap
Inherits BitmapSource
继承

示例

以下示例演示了如何在 WriteableBitmap 鼠标移动时将 用作 的 Image 源来绘制像素。

using System;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Media;
using System.Windows.Media.Imaging;
using System.Windows.Input;

namespace WriteableBitmapDemo
{
    class Program
    {
        static WriteableBitmap writeableBitmap;
        static Window w;
        static Image i;

        [STAThread]
        static void Main(string[] args)
        {
            i = new Image();
            RenderOptions.SetBitmapScalingMode(i, BitmapScalingMode.NearestNeighbor);
            RenderOptions.SetEdgeMode(i, EdgeMode.Aliased);
           
            w = new Window();
            w.Content = i;
            w.Show();

            writeableBitmap = new WriteableBitmap(
                (int)w.ActualWidth, 
                (int)w.ActualHeight, 
                96, 
                96, 
                PixelFormats.Bgr32, 
                null);

            i.Source = writeableBitmap;

            i.Stretch = Stretch.None;
            i.HorizontalAlignment = HorizontalAlignment.Left;
            i.VerticalAlignment = VerticalAlignment.Top;

            i.MouseMove += new MouseEventHandler(i_MouseMove);
            i.MouseLeftButtonDown += 
                new MouseButtonEventHandler(i_MouseLeftButtonDown);
            i.MouseRightButtonDown += 
                new MouseButtonEventHandler(i_MouseRightButtonDown);

            w.MouseWheel += new MouseWheelEventHandler(w_MouseWheel);

            Application app = new Application();
            app.Run();
        }

        // The DrawPixel method updates the WriteableBitmap by using
        // unsafe code to write a pixel into the back buffer.
        static void DrawPixel(MouseEventArgs e)
        {
            int column = (int)e.GetPosition(i).X;
            int row = (int)e.GetPosition(i).Y;

            try{
                // Reserve the back buffer for updates.
                writeableBitmap.Lock();

                unsafe
                {
                    // Get a pointer to the back buffer.
                    IntPtr pBackBuffer = writeableBitmap.BackBuffer;

                    // Find the address of the pixel to draw.
                    pBackBuffer += row * writeableBitmap.BackBufferStride;
                    pBackBuffer += column * 4;

                    // Compute the pixel's color.
                    int color_data = 255 << 16; // R
                    color_data |= 128 << 8;   // G
                    color_data |= 255 << 0;   // B

                    // Assign the color data to the pixel.
                    *((int*) pBackBuffer) = color_data;
                }
    
                // Specify the area of the bitmap that changed.
                writeableBitmap.AddDirtyRect(new Int32Rect(column, row, 1, 1));
            }
            finally{
                // Release the back buffer and make it available for display.
                writeableBitmap.Unlock();
            }
        }

        static void ErasePixel(MouseEventArgs e)
        {
            byte[] ColorData = { 0, 0, 0, 0 }; // B G R

            Int32Rect rect = new Int32Rect(
                    (int)(e.GetPosition(i).X), 
                    (int)(e.GetPosition(i).Y), 
                    1, 
                    1);

            writeableBitmap.WritePixels( rect, ColorData, 4, 0);
        }

        static void i_MouseRightButtonDown(object sender, MouseButtonEventArgs e)
        {
            ErasePixel(e);
        }

        static void i_MouseLeftButtonDown(object sender, MouseButtonEventArgs e)
        {
            DrawPixel(e);
        }

        static void i_MouseMove(object sender, MouseEventArgs e)
        {
            if (e.LeftButton == MouseButtonState.Pressed)
            {
                DrawPixel(e);
            }
            else if (e.RightButton == MouseButtonState.Pressed)
            {
                ErasePixel(e);
            }
        }

        static void w_MouseWheel(object sender, MouseWheelEventArgs e)
        {
            System.Windows.Media.Matrix m = i.RenderTransform.Value;

            if (e.Delta > 0)
            {
                m.ScaleAt(
                    1.5, 
                    1.5, 
                    e.GetPosition(w).X, 
                    e.GetPosition(w).Y);
            }
            else
            {
                m.ScaleAt(
                    1.0 / 1.5, 
                    1.0 / 1.5, 
                    e.GetPosition(w).X, 
                    e.GetPosition(w).Y);
            }

            i.RenderTransform = new MatrixTransform(m);
        }
    }
}

注解

WriteableBitmap使用 类可按帧更新和呈现位图。 这对于生成算法内容(如分形图像)和数据可视化(如音乐可视化工具)非常有用。

WriteableBitmap 使用两个缓冲区。 后台缓冲区在系统内存中分配,并累积当前未显示的内容。 前端缓冲区在系统内存中分配,并包含当前显示的内容。 呈现系统将前缓冲区复制到视频内存中以供显示。

两个线程使用这些缓冲区。 用户界面 (UI) 线程生成 UI,但不会将其呈现在屏幕上。 UI 线程响应用户输入、计时器和其他事件。 一个应用程序可以有多个 UI 线程。 呈现线程编写和呈现来自 UI 线程的更改。 每个应用程序只有一个呈现线程。

UI 线程将内容写入后台缓冲区。 呈现线程从前缓冲区读取内容并将其复制到视频内存。 使用更改的矩形区域跟踪对后台缓冲区所做的更改。

调用其中 WritePixels 一个重载以自动更新和显示后台缓冲区中的内容。

为了更好地控制更新,并且要对后台缓冲区进行多线程访问,请使用以下工作流。

  1. Lock调用 方法以保留更新的后台缓冲区。

  2. 通过访问 属性获取指向后台缓冲区的 BackBuffer 指针。

  3. 将更改写入后台缓冲区。 锁定时 WriteableBitmap ,其他线程可能会将更改写入后台缓冲区。

  4. AddDirtyRect调用 方法以指示已更改的区域。

  5. Unlock调用 方法以释放后台缓冲区并允许在屏幕上演示。

将更新发送到呈现线程时,呈现线程会将更改后的矩形从后缓冲区复制到前缓冲区。 呈现系统控制此交换以避免死锁和重绘项目,例如“撕裂”。

构造函数

WriteableBitmap(BitmapSource)

使用给定的 WriteableBitmap 初始化 BitmapSource 类的新实例。

WriteableBitmap(Int32, Int32, Double, Double, PixelFormat, BitmapPalette)

使用指定的参数初始化 WriteableBitmap 类的新实例。

属性

BackBuffer

获取指向后台缓冲区的指针。

BackBufferStride

获取一个值,该值指示单行像素数据中的字节数。

CanFreeze

获取一个值,该值指示是否可将对象变为不可修改。

(继承自 Freezable)
DependencyObjectType

获取 DependencyObjectType 包装此实例的 CLR 类型的 。

(继承自 DependencyObject)
Dispatcher

获取与此 Dispatcher 关联的 DispatcherObject

(继承自 DispatcherObject)
DpiX

获取图像) dpi (每英寸的水平点数。

(继承自 BitmapSource)
DpiY

获取图像) dpi (每英寸垂直点数。

(继承自 BitmapSource)
Format

获取位图数据的本机 PixelFormat

(继承自 BitmapSource)
HasAnimatedProperties

获取一个值,该值指示一个或多个 AnimationClock 对象是否与此对象的任何依赖项属性相关联。

(继承自 Animatable)
Height

获取源位图的高度(以与设备无关的单位 (每单位) 1/96 英寸)。

(继承自 BitmapSource)
IsDownloading

获取一个值,该值指示 BitmapSource 内容当前是否正在下载。

(继承自 BitmapSource)
IsFrozen

获取一个值,该值指示对象当前是否可修改。

(继承自 Freezable)
IsSealed

获取一个值,该值指示此实例当前是否为密封的(只读)。

(继承自 DependencyObject)
Metadata

获取与此位图图像关联的元数据。

(继承自 BitmapSource)
Palette

获取位图的调色板(如果指定了调色板)。

(继承自 BitmapSource)
PixelHeight

获取位图的高度(以像素为单位)。

(继承自 BitmapSource)
PixelWidth

获取位图的宽度(以像素为单位)。

(继承自 BitmapSource)
Width

获取位图的宽度(以设备无关单位 (单位) 1/96 英寸)。

(继承自 BitmapSource)

方法

AddDirtyRect(Int32Rect)

指定更改的位图区域。

ApplyAnimationClock(DependencyProperty, AnimationClock)

AnimationClock 应用到指定的 DependencyProperty。 如果该属性已进行动画处理,则使用 SnapshotAndReplace 切换行为。

(继承自 Animatable)
ApplyAnimationClock(DependencyProperty, AnimationClock, HandoffBehavior)

AnimationClock 应用到指定的 DependencyProperty。 如果该属性已进行动画处理,则使用指定的 HandoffBehavior

(继承自 Animatable)
BeginAnimation(DependencyProperty, AnimationTimeline)

将动画应用于指定 DependencyProperty。 动画会在呈现下一帧时启动。 如果指定属性已进行动画处理,则使用 SnapshotAndReplace 切换行为。

(继承自 Animatable)
BeginAnimation(DependencyProperty, AnimationTimeline, HandoffBehavior)

将动画应用于指定 DependencyProperty。 动画会在呈现下一帧时启动。 如果指定的属性已进行动画处理,则使用指定的 HandoffBehavior

(继承自 Animatable)
CheckAccess()

确定调用线程是否可以访问此 DispatcherObject

(继承自 DispatcherObject)
CheckIfSiteOfOrigin()

检查位图源内容是否来自已知源的站点。 此方法用于确保像素复制操作的安全。

(继承自 BitmapSource)
ClearValue(DependencyProperty)

清除属性的本地值。 要清除的属性由 DependencyProperty 标识符指定。

(继承自 DependencyObject)
ClearValue(DependencyPropertyKey)

清除只读属性的本地值。 要清除的属性由 DependencyPropertyKey 指定。

(继承自 DependencyObject)
Clone()

创建此 WriteableBitmap 的可修改克隆,从而深度复制此对象的值。 在复制依赖项属性时,此方法会复制资源引用和数据绑定(但可能不再解析),但不复制动画或其当前值。

CloneCore(Freezable)

使此实例成为指定 BitmapSource 的深层副本。 在复制依赖项属性时,此方法会复制资源引用和数据绑定(但可能不再解析),但不复制动画或其当前值。

(继承自 BitmapSource)
CloneCurrentValue()

创建此 ByteAnimationUsingKeyFrames 对象的可修改复本,从而深度复制此对象的当前值。 不复制资源引用、数据绑定和动画,而是复制其当前值。

CloneCurrentValueCore(Freezable)

使用当前的属性值使该实例成为指定 BitmapSource 的可修改深层副本。 不复制资源引用、数据绑定和动画,而是复制其当前值。

(继承自 BitmapSource)
CoerceValue(DependencyProperty)

对指定依赖属性的值进行强制。 通过对调用方 DependencyObject 上存在的依赖属性的属性元数据中所指定的任何 CoerceValueCallback 函数进行调用来完成此操作。

(继承自 DependencyObject)
CopyPixels(Array, Int32, Int32)

将位图像素数据复制到具有从指定偏移量开始的指定跨距的像素数组中。

(继承自 BitmapSource)
CopyPixels(Int32Rect, Array, Int32, Int32)

将指定矩形中的位图像素数据复制到具有从指定偏移量开始的指定跨距的像素数组中。

(继承自 BitmapSource)
CopyPixels(Int32Rect, IntPtr, Int32, Int32)

复制指定矩形中的位图像素数据。

(继承自 BitmapSource)
CreateInstance()

初始化 Freezable 类的新实例。

(继承自 Freezable)
CreateInstanceCore()

在派生类中实现时,创建 Freezable 派生类的新实例。

(继承自 Freezable)
Equals(Object)

确定提供的 DependencyObject 是否等效于当前 DependencyObject

(继承自 DependencyObject)
Freeze()

使当前对象不可修改,并且将其 IsFrozen 属性设置为 true

(继承自 Freezable)
FreezeCore(Boolean)

使 BitmapSource 实例或派生类为不可变的。

(继承自 BitmapSource)
GetAnimationBaseValue(DependencyProperty)

返回指定的 DependencyProperty 的未经过动画处理的值。

(继承自 Animatable)
GetAsFrozen()

使用基(未经过动画处理的)属性值创建 Freezable 的冻结副本。 由于副本已冻结,因此将通过引用复制任何冻结的子对象。

(继承自 Freezable)
GetAsFrozenCore(Freezable)

使此实例成为指定的 BitmapSource 对象的克隆。

(继承自 BitmapSource)
GetCurrentValueAsFrozen()

使用当前属性值创建 Freezable 的冻结副本。 由于副本已冻结,因此将通过引用复制任何冻结的子对象。

(继承自 Freezable)
GetCurrentValueAsFrozenCore(Freezable)

使此实例成为指定 BitmapSource 的冻结复本。 不复制资源引用、数据绑定和动画,而是复制其当前值。

(继承自 BitmapSource)
GetHashCode()

获取此 DependencyObject 的哈希代码。

(继承自 DependencyObject)
GetLocalValueEnumerator()

创建一个专用的枚举数,用于确定哪些依赖项属性在此 DependencyObject 上具有以本地方式设置的值。

(继承自 DependencyObject)
GetType()

获取当前实例的 Type

(继承自 Object)
GetValue(DependencyProperty)

DependencyObject 的此实例返回依赖属性的当前有效值。

(继承自 DependencyObject)
InvalidateProperty(DependencyProperty)

重新评估指定依赖属性的有效值。

(继承自 DependencyObject)
Lock()

保留后台缓冲区用于更新。

MemberwiseClone()

创建当前 Object 的浅表副本。

(继承自 Object)
OnChanged()

修改当前 Freezable 对象时调用。

(继承自 Freezable)
OnFreezablePropertyChanged(DependencyObject, DependencyObject)

确保为刚刚设置的 DependencyObjectType 数据成员建立适当的上下文指针。

(继承自 Freezable)
OnFreezablePropertyChanged(DependencyObject, DependencyObject, DependencyProperty)

此成员支持Windows Presentation Foundation (WPF) 基础结构,不应直接从代码中使用。

(继承自 Freezable)
OnPropertyChanged(DependencyPropertyChangedEventArgs)

重写 OnPropertyChanged(DependencyPropertyChangedEventArgs)DependencyObject 实现,以同时调用任何响应类型 Freezable 不断变化的依赖属性的 Changed 处理程序。

(继承自 Freezable)
ReadLocalValue(DependencyProperty)

如果存在,则返回依赖属性的本地值。

(继承自 DependencyObject)
ReadPreamble()

确保正在从有效的线程访问 FreezableFreezable 的继承者必须在任何 API 一开始读取不属于依赖项对象的数据成员时调用此方法。

(继承自 Freezable)
SetCurrentValue(DependencyProperty, Object)

设置依赖属性的值而不更改其值源。

(继承自 DependencyObject)
SetValue(DependencyProperty, Object)

设置依赖属性的本地值,该值由其依赖属性标识符指定。

(继承自 DependencyObject)
SetValue(DependencyPropertyKey, Object)

设置一个只读依赖属性的本地值,该值由依赖属性的 DependencyPropertyKey 标识符指定。

(继承自 DependencyObject)
ShouldSerializeProperty(DependencyProperty)

返回一个值,该值指示序列化进程是否应序列化所提供的依赖属性的值。

(继承自 DependencyObject)
ToString()

基于当前区域性创建此对象的字符串表示形式。

(继承自 ImageSource)
ToString(IFormatProvider)

基于传入的 IFormatProvider 创建此对象的字符串表示形式。 如果提供程序为 null,则使用 CurrentCulture

(继承自 ImageSource)
TryLock(Duration)

尝试锁定位图,等待不超过指定的时间长度。

Unlock()

释放后台缓冲区,以使之可用于显示。

VerifyAccess()

强制调用线程具有此 DispatcherObject 的访问权限。

(继承自 DispatcherObject)
WritePixels(Int32Rect, Array, Int32, Int32)

更新位图指定区域中的像素。

WritePixels(Int32Rect, Array, Int32, Int32, Int32)

更新位图指定区域中的像素。

WritePixels(Int32Rect, IntPtr, Int32, Int32)

更新位图指定区域中的像素。

WritePixels(Int32Rect, IntPtr, Int32, Int32, Int32, Int32)

更新位图指定区域中的像素。

WritePostscript()

引发 FreezableChanged 事件并调用其 OnChanged() 方法。 从 Freezable 派生的类应在修改的类成员不存储为依赖属性的任何 API 的末尾调用此方法。

(继承自 Freezable)
WritePreamble()

验证 Freezable 是否未被冻结,并且是否正在从有效的线程上下文中访问它。 Freezable 的继承项应当在任何 API 一开始写入不属于依赖项属性的数据成员时调用此方法。

(继承自 Freezable)

事件

Changed

在修改 Freezable 或其包含的对象时发生。

(继承自 Freezable)
DecodeFailed

在由于图像标题损坏而无法下载图像时发生。

(继承自 BitmapSource)
DownloadCompleted

在下载完位图内容时发生。

(继承自 BitmapSource)
DownloadFailed

在无法下载位图内容时发生。

(继承自 BitmapSource)
DownloadProgress

在下载位图内容的进度有变化时发生。

(继承自 BitmapSource)

显式接口实现

IFormattable.ToString(String, IFormatProvider)

使用指定格式对当前实例的值设置格式。

(继承自 ImageSource)

适用于

另请参阅