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_canvas.h"
28
29
30 /* Bring in externs for caller checking code. */
31 GX_CALLER_CHECKING_EXTERNS
32
33
34 /**************************************************************************/
35 /* */
36 /* FUNCTION RELEASE */
37 /* */
38 /* _gxe_canvas_drawing_complete PORTABLE C */
39 /* 6.1 */
40 /* AUTHOR */
41 /* */
42 /* Kenneth Maxwell, Microsoft Corporation */
43 /* */
44 /* DESCRIPTION */
45 /* */
46 /* This function checks for errors in the canvas drawing complete */
47 /* function call. */
48 /* */
49 /* INPUT */
50 /* */
51 /* canvas Canvas control block */
52 /* flush If GX_TRUE, the content of */
53 /* the canvas is flushed to */
54 /* the display */
55 /* */
56 /* OUTPUT */
57 /* */
58 /* status Completion status */
59 /* */
60 /* CALLS */
61 /* */
62 /* _gx_canvas_drawing_complete Actual canvas drawing */
63 /* complete call */
64 /* */
65 /* CALLED BY */
66 /* */
67 /* Application Code */
68 /* */
69 /* RELEASE HISTORY */
70 /* */
71 /* DATE NAME DESCRIPTION */
72 /* */
73 /* 05-19-2020 Kenneth Maxwell Initial Version 6.0 */
74 /* 09-30-2020 Kenneth Maxwell Modified comment(s), */
75 /* resulting in version 6.1 */
76 /* */
77 /**************************************************************************/
_gxe_canvas_drawing_complete(GX_CANVAS * canvas,GX_BOOL flush)78 UINT _gxe_canvas_drawing_complete(GX_CANVAS *canvas, GX_BOOL flush)
79 {
80 UINT status;
81
82 /* Check for appropriate caller. */
83 GX_INIT_AND_THREADS_CALLER_CHECKING
84
85 /* Checks for the invalid input pointers. */
86 if ((canvas == GX_NULL) ||
87 (canvas -> gx_canvas_display == GX_NULL) ||
88 (canvas -> gx_canvas_memory == GX_NULL))
89 {
90 return(GX_PTR_ERROR);
91 }
92
93 /* Call the actual canvas drawing complete function. */
94 status = _gx_canvas_drawing_complete(canvas, flush);
95
96 /* Return completion status. */
97 return status;
98 }
99
100
