1 /***************************************************************************
2  * Copyright (c) 2024 Microsoft Corporation
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the MIT License which is available at
6  * https://opensource.org/licenses/MIT.
7  *
8  * SPDX-License-Identifier: MIT
9  **************************************************************************/
10 
11 
12 /**************************************************************************/
13 /**************************************************************************/
14 /**                                                                       */
15 /** GUIX Component                                                        */
16 /**                                                                       */
17 /**   Canvas Management (Canvas)                                          */
18 /**                                                                       */
19 /**************************************************************************/
20 
21 #define GX_SOURCE_CODE
22 
23 
24 /* Include necessary system files.  */
25 
26 #include "gx_api.h"
27 #include "gx_system.h"
28 #include "gx_utility.h"
29 #include "gx_canvas.h"
30 
31 
32 /**************************************************************************/
33 /*                                                                        */
34 /*  FUNCTION                                               RELEASE        */
35 /*                                                                        */
36 /*    _gx_canvas_dirty_mark                               PORTABLE C      */
37 /*                                                           6.1          */
38 /*  AUTHOR                                                                */
39 /*                                                                        */
40 /*    Kenneth Maxwell, Microsoft Corporation                              */
41 /*                                                                        */
42 /*  DESCRIPTION                                                           */
43 /*                                                                        */
44 /*    This function marks the canvas dirty.                               */
45 /*                                                                        */
46 /*  INPUT                                                                 */
47 /*                                                                        */
48 /*    canvas                                Canvas control block          */
49 /*    area                                  Area of canvas to mark as     */
50 /*                                            dirty                       */
51 /*                                                                        */
52 /*  OUTPUT                                                                */
53 /*                                                                        */
54 /*    None                                                                */
55 /*                                                                        */
56 /*  CALLS                                                                 */
57 /*                                                                        */
58 /*    None                                                                */
59 /*                                                                        */
60 /*  CALLED BY                                                             */
61 /*                                                                        */
62 /*    GUIX Internal Code                                                  */
63 /*                                                                        */
64 /*  RELEASE HISTORY                                                       */
65 /*                                                                        */
66 /*    DATE              NAME                      DESCRIPTION             */
67 /*                                                                        */
68 /*  05-19-2020     Kenneth Maxwell          Initial Version 6.0           */
69 /*  09-30-2020     Kenneth Maxwell          Modified comment(s),          */
70 /*                                            resulting in version 6.1    */
71 /*                                                                        */
72 /**************************************************************************/
_gx_canvas_dirty_mark(GX_CANVAS * canvas,GX_RECTANGLE * area)73 VOID  _gx_canvas_dirty_mark(GX_CANVAS *canvas, GX_RECTANGLE *area)
74 {
75 
76     canvas -> gx_canvas_draw_count++;
77 
78     /* did the caller pass a specific rectangle? */
79     if (area)
80     {
81         /* yes, used passed in rectangle */
82         canvas -> gx_canvas_dirty_area = *area;
83     }
84     else
85     {
86         /* no, invalidate the entire canvas */
87         canvas -> gx_canvas_dirty_area.gx_rectangle_top = 0;
88         canvas -> gx_canvas_dirty_area.gx_rectangle_bottom =
89         (GX_VALUE)(canvas -> gx_canvas_y_resolution - 1);
90         canvas -> gx_canvas_dirty_area.gx_rectangle_left = 0;
91         canvas -> gx_canvas_dirty_area.gx_rectangle_right =
92         (GX_VALUE)(canvas -> gx_canvas_x_resolution - 1);
93     }
94 }
95 
96