dotnet 讀 WPF 源代碼筆記 渲染收集是如何觸發

在 WPF 裡面，渲染可以從架構上劃分為兩層。上層是 WPF 框架的 OnRender 之類的函數，作用是收集應用程式渲染的命令。上層將收集到的應用程式繪製渲染的命令傳給下層，下層是 WPF 的 GFX 層，作用是根據收到的渲染的命令繪製出界面。本文所聊的是渲染上層部分，在 WPF 框架是如何做到界面刷新渲染，包括此調用的順序以及框架邏輯

閱讀本文之前，我期望讀者有一定的 WPF 渲染基礎，以及瞭解 WPF 的大架構。本文不會涉及到任何底層渲染相關的知識。閱讀本文，你將瞭解到依賴屬性和 WPF 渲染層之間的關係

在開始之前，必須明確一點的是，不是所有的 WPF 應用行為，如依賴屬性變更，都會觸發渲染變更。有渲染變更不代表立刻將會觸發界面刷新，從觸發渲染變更到界面刷新，還有以下步驟： 觸發渲染，渲染上層收集應用層的繪製渲染的命令，觸發渲染線程接收繪製渲染的命令，渲染的下層根據繪製渲染的命令進入 DirectX 渲染管線，由 DirectX 完成後續渲染步驟

本文所聊到的僅僅只是以上的觸發渲染，渲染上層收集應用層的繪製渲染的命令這兩個步驟。關於 WPF 渲染部分的大框架還請參閱 WPF 渲染原理

本篇博客基於 WPF 更改 DrawingVisual 的 RenderOpen 用到的對象的內容將持續影響渲染效果 博客進行更深入 WPF 框架源代碼探討

為了能更好說明 WPF 框架的行為，本文開始先介紹一個測試代碼用來測試 WPF 的行為

在本文實際開始之前，還請大家思考一個問題，在 WPF 中，調用 DrawingVisual 的 RenderOpen 方法返回的 DrawingContext 對象裡面，傳入的參數的屬性值影響渲染結果，是一次性的，還是持續的？什麼是一次性的，什麼是持續的？換個問法是如果傳入的值在 DrawingContext 關閉之後，變更屬性，此時是否還會影響到渲染結果。答案的是或否就決定了 WPF 底層的實現行為，是否在 DrawingContext 關閉的時候，就直接觸發渲染模塊，或者就取出了傳入的值的數據，斷開和傳入值之間的影響。如下麵最簡單的代碼

            var drawingVisual = new DrawingVisual();
            var translateTransform = new TranslateTransform();
            using (var drawingContext = drawingVisual.RenderOpen())
            {
                drawingContext.PushTransform(translateTransform);

                var rectangleGeometry = new RectangleGeometry(new Rect(0, 0, 10, 10));
                drawingContext.DrawGeometry(Brushes.Red, null, rectangleGeometry);

                drawingContext.Pop();
            }

            SetTranslateTransform(translateTransform);

        private async void SetTranslateTransform(TranslateTransform translateTransform)
        {
            while (true)
            {
                translateTransform.X++;

                await Task.Delay(TimeSpan.FromMilliseconds(10));
            }
        }

以上代碼在 SetTranslateTransform 函數裡面，不斷修改 TranslateTransform 的屬性，是否還會影響到 DrawingVisual 的渲染效果？帶著這個問題，進入到本文的開始

眾所周知，只有在渲染收集觸發的時候，才會收集應用層的渲染數據。以 TranslateTransform 為例，在更改 TranslateTransform 的 X 或 Y 屬性的值的時候，如果沒有給此 TranslateTransform 對象建立直接渲染關係，也就是 Freezable 的 AddSingletonContext 方法沒有被傳入渲染的直接元素聯繫的時候，對屬性值的更改只是和更改 CLR 自動屬性一樣，不會有任何的通知和變更。也就是說在 TranslateTransform 對象想要影響到最終界面渲染，需要被動在渲染收集時，才會更新數據

class Freezable
{
        private void AddSingletonContext(DependencyObject context, DependencyProperty property)
        {
            // 忽略建立聯繫代碼，這裡面比較繞。核心邏輯就是取出 context 裡面的 SingletonHandler 委托
            // 以上的 context 是 RenderData 類型。此 SingletonHandler 委托將會在繼承 Freezable 的類型的依賴屬性變更的時候，支持被調用
            // 對於建立直接聯繫的對象，如存放在 UIElement 上的 TranslateTransform 屬性，此時的 SingletonHandler 對象就是由 UIElement 發起的訂閱
        }
}

如在 WPF 更改 DrawingVisual 的 RenderOpen 用到的對象的內容將持續影響渲染效果 博客所聊到的實現方式，通過在 DrawingVisual 裡面設置一個 TranslateTransform 對象，再將 DrawingVisual 放入到 UIElement 裡面。如此行為將讓 TranslateTransform 無法和 UIElement 建立直接的聯繫。以上進入 AddSingletonContext 函數將傳入的是屬於 DrawingVisual 的 RenderData 對象，這就意味著當 TranslateTransform 的屬性變更時，僅僅只能通知到 DrawingVisual 對象，而不能通知到更上層的 UIElement 對象

這完全取決於此應用代碼的實現，為了讓大家不需要在兩篇博客之間來回跳，以下給出用到 WPF 更改 DrawingVisual 的 RenderOpen 用到的對象的內容將持續影響渲染效果 博客的核心代碼

以下是一個繼承 UIElement 的 Foo 類

    class Foo : UIElement
    {
        public Foo()
        {
            var drawingVisual = new DrawingVisual();
            var translateTransform = new TranslateTransform();
            using (var drawingContext = drawingVisual.RenderOpen())
            {
                var rectangleGeometry = new RectangleGeometry(new Rect(0, 0, 10, 10));

                drawingContext.PushTransform(translateTransform);

                drawingContext.DrawGeometry(Brushes.Red, null, rectangleGeometry);

                drawingContext.Pop();
            }

            Visual = drawingVisual;

            SetTranslateTransform(translateTransform);
        }

        private async void SetTranslateTransform(TranslateTransform translateTransform)
        {
            while (true)
            {
                translateTransform.X++;

                if (translateTransform.X > 700)
                {
                    translateTransform.X = 0;
                }

                await Task.Delay(TimeSpan.FromMilliseconds(10));
            }
        }

        protected override Visual GetVisualChild(int index) => Visual;
        protected override int VisualChildrenCount => 1;

        private Visual Visual { get; }
    }

以下是使用此 Foo 的 xaml 代碼

    <Grid>
        <local:Foo x:Name="Foo"></local:Foo>
    </Grid>

以上就是本文所有用到的測試輔助的代碼

為了更好瞭解 WPF 框架的底層行為，以上代碼被我放入到我私有的 WPF 倉庫中，作為 WPF 倉庫裡面的 demo 的代碼。可以從 github 獲取本文以上測試代碼，獲取代碼之後，請將 WPFDemo 作為啟動項目

以上就是本文構建的測試邏輯。下麵將回到主題部分

從 TranslateTransform 屬性影響界面邏輯渲染入手，在變更 TranslateTransform 屬性時，將因為沒有和 Foo 此 UIElement 建立直接的邏輯關係，同時所在的 DrawingVisual 也沒有在 Foo 裡面被調用 AddVisualChild 方法而加入到可視化樹（視覺樹）上，因此 TranslateTransform 屬性的變更無法通知到 WPF 佈局層

更好利用此特性來測試 WPF 框架層的行為。在此先回答一個問題，為什麼不通過靜態代碼閱讀瞭解框架的行為？原因是 WPF 框架太過龐大，我在靜態代碼閱讀過程將受限於記憶而無法從全局把握 WPF 框架邏輯。因此更多的是需要靠測試代碼來瞭解 WPF 框架的邏輯

在 Dispatcher 對象裡面，從 VisualStudio 的調試視窗可以看到有沒有開放的幾個 Reserved 屬性，其中一項就是專門給 MediaContext 所使用。如命名，此 MediaContext 類型就是 WPF 渲染上層的渲染上下文，依靠此渲染上下文可以用來控制 WPF 的多媒體（渲染）層的行為

在 WPF 框架裡面可以隨處見到從 Dispatcher 裡面獲取 MediaContext 對象的代碼

MediaContext mctx = MediaContext.From(dispatcher);

從眾多的（不包括動畫）觸發渲染進入之後，都會彙總到 MediaContext 的 PostRender 方法。此方法是給 Dispatcher 傳遞一個渲染消息，也就是優先順序為 Render 的 RenderMessage 任務。以下是有刪減的 PostRender 方法代碼

        internal void PostRender()
        {
        	// 如果當前沒有在進入渲染狀態，那麼開始觸發渲染消息
            if (!_isRendering)
            {
                if (_currentRenderOp != null)
                {
                    // 如果已有渲染消息在消息隊列里，那麼更改優先順序確保是 Render 優先順序。此渲染消息將會很快被調度
                    // If we already have a render operation in the queue, we should
                    // change its priority to render priority so it happens sooner.
                    _currentRenderOp.Priority = DispatcherPriority.Render;
                }
                else
                {
                    // 如果還沒有渲染消息，那麼給 Dispatcher 傳入優先順序為 Render 的渲染消息
                    // If we don't have a render operation in the queue, add one at
                    // render priority.
                    _currentRenderOp = Dispatcher.BeginInvoke(DispatcherPriority.Render, _renderMessage, null);
                }
            }
        }

以上代碼的 _renderMessage 就是具體的執行渲染消息，定義如下

        internal MediaContext(Dispatcher dispatcher)
        {
             _renderMessage = new DispatcherOperationCallback(RenderMessageHandler);
        }

private DispatcherOperationCallback _renderMessage;

歪樓一下，在 WPF 裡面，通用的調度使用的委托都是 DispatcherOperationCallback 類型，使用此類型是為了性能考慮。在 Dispatcher 的 WrappedInvoke 方法裡面，將會通過 as 判斷當前傳入的 Delegate 委托類型。使用框架內置的 Action 和 DispatcherOperationCallback 等類型，可以使用明確類型的委托調用，而不需要使用 DynamicInvoke 調用委托來提升性能。詳細請看 github 上大佬的更改 內容

通過以上代碼可以瞭解到渲染消息的在於 MediaContext 的 RenderMessageHandler 方法裡面。此方法將會被 Dispatcher 使用 Render 優先順序進行調用，也會被各個模塊觸發渲染時加入 Dispatcher 隊列

            private object RenderMessageHandler(
              object resizedCompositionTarget /* can be null if we are not resizing*/
            )
            {
                 // 忽略調試用的邏輯 
                 RenderMessageHandlerCore(resizedCompositionTarget);
            }

接著在 RenderMessageHandlerCore 裡面將會層層調用，調用到 Render 方法。此方法實現以下功能

• 渲染每個註冊的 ICompositionTarget 以完成批處理。 渲染都是一批批處理的
• 更新收集的渲染數據
• 將收集到的數據提交給下層渲染

核心的步驟就是在 更新收集的渲染數據 這一步。這裡也就能解答 WPF 的渲染收集是如何觸發的

在 更新收集的渲染數據 裡面的實現代碼如下

        private void RaiseResourcesUpdated()
        {
            if (_resourcesUpdatedHandlers != null)
            {
                DUCE.ChannelSet channelSet = GetChannels();
                _resourcesUpdatedHandlers(channelSet.Channel, false /* do not skip the "on channel" check */);
                _resourcesUpdatedHandlers = null;
            }
        }

這裡的 _resourcesUpdatedHandlers 是委托，在各個資源，如 TranslateTransform 都會註冊到 MediaContext 里，也就是在這一層可以讓資源可以收到渲染更新的消息

如在 TranslateTransform 的基類 Animatable 裡面，就在 RegisterForAsyncUpdateResource 方法註冊，代碼如下

        internal void RegisterForAsyncUpdateResource()
        {
            MediaContext mediaContext = MediaContext.From(Dispatcher);

            if (!resource.GetHandle(mediaContext.Channel).IsNull)
            {
                mediaContext.ResourcesUpdated += new MediaContext.ResourcesUpdatedHandler(UpdateResource);
            }
        }

如上文，在 WPF 框架裡面，可以非常方便從 Dispatcher 拿到 MediaContext 對象，從而也很方便加上 ResourcesUpdated 委托

在此 ResourcesUpdated 事件觸發的時候，就需要各個資源向 DUCE.Channel 寫入資源的數據，讓下層渲染使用。如 TranslateTransform 的實現代碼

        internal override void UpdateResource(DUCE.Channel channel, bool skipOnChannelCheck)
        {
            if (skipOnChannelCheck || _duceResource.IsOnChannel(channel))
            {
                base.UpdateResource(channel, skipOnChannelCheck);
                DUCE.MILCMD_TRANSLATETRANSFORM data;
                unsafe
                {
                    data.Type = MILCMD.MilCmdTranslateTransform;
                    data.Handle = _duceResource.GetHandle(channel);
                    data.X = X;
                    data.Y = Y;

                    channel.SendCommand(
                        (byte*)&data,
                        sizeof(DUCE.MILCMD_TRANSLATETRANSFORM));
                }
            }
        }

回到本文開始的問題，在 WPF 調用 DrawingContext 的關閉時，此時不會立刻執行界面渲染邏輯。此時離實際的界面渲染還很遠，需要先通知到 MediaContext 將渲染消息加入到 Dispatcher 隊列。等待 Dispatcher 的調度，接著進入 MediaContext 的層層 Render 方法，再由 Render 方法觸發資源收集更新的事件，依靠監聽事件讓各個資源向 Channel 寫入資源的當前狀態信息。最後告訴下層渲染，批量收集渲染數據完成，可以開始執行下層渲染邏輯

更多渲染相關博客請看 渲染相關

博客園博客只做備份，博客發佈就不再更新，如果想看最新博客，請到 https://blog.lindexi.com/