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/

標籤：WPF

上一篇：EntityFramwork decimal保存到資料庫精度只有小數點后兩位

下一篇：WinUI3 FFmpeg.autogen決議視頻幀，使用win2d顯示內容.