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