1 /**************************************************************************/
2 /* */
3 /* Copyright (c) Microsoft Corporation. All rights reserved. */
4 /* */
5 /* This software is licensed under the Microsoft Software License */
6 /* Terms for Microsoft Azure RTOS. Full text of the license can be */
7 /* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */
8 /* and in the root directory of this software. */
9 /* */
10 /**************************************************************************/
11
12
13 /**************************************************************************/
14 /**************************************************************************/
15 /** */
16 /** GUIX Component */
17 /** */
18 /** Canvas Management (Canvas) */
19 /** */
20 /**************************************************************************/
21
22 #define GX_SOURCE_CODE
23
24
25 /* Include necessary system files. */
26
27 #include "gx_api.h"
28 #include "gx_system.h"
29 #include "gx_utility.h"
30 #include "gx_canvas.h"
31 #include "gx_port.h"
32
33 /* Bring in externs for caller checking code. */
34 GX_CALLER_CHECKING_EXTERNS
35
36
37 /**************************************************************************/
38 /* */
39 /* FUNCTION RELEASE */
40 /* */
41 /* _gxe_canvas_hide PORTABLE C */
42 /* 6.1 */
43 /* AUTHOR */
44 /* */
45 /* Kenneth Maxwell, Microsoft Corporation */
46 /* */
47 /* DESCRIPTION */
48 /* */
49 /* This function checks for errors in the canvas hide function */
50 /* call. */
51 /* */
52 /* INPUT */
53 /* */
54 /* canvas Canvas control block */
55 /* */
56 /* OUTPUT */
57 /* */
58 /* status Completion status */
59 /* */
60 /* CALLS */
61 /* */
62 /* _gx_canvas_alpha_set Actual canvas alpha set call */
63 /* */
64 /* CALLED BY */
65 /* */
66 /* Application Code */
67 /* */
68 /* RELEASE HISTORY */
69 /* */
70 /* DATE NAME DESCRIPTION */
71 /* */
72 /* 05-19-2020 Kenneth Maxwell Initial Version 6.0 */
73 /* 09-30-2020 Kenneth Maxwell Modified comment(s), */
74 /* resulting in version 6.1 */
75 /* */
76 /**************************************************************************/
_gxe_canvas_hide(GX_CANVAS * canvas)77 UINT _gxe_canvas_hide(GX_CANVAS *canvas)
78 {
79 UINT status;
80
81 /* Check for appropriate caller. */
82 GX_INIT_AND_THREADS_CALLER_CHECKING
83
84 /* Check for the invalid input pointers. */
85 if (canvas == GX_NULL)
86 {
87 return(GX_PTR_ERROR);
88 }
89
90 if (canvas -> gx_canvas_id != GX_CANVAS_ID)
91 {
92 return (GX_INVALID_CANVAS);
93 }
94
95 /* Call the actual canvas alpha set function. */
96 status = _gx_canvas_hide(canvas);
97
98 /* Return completion status. */
99 return status;
100 }
101
102
