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 /* */
31 /* FUNCTION RELEASE */
32 /* */
33 /* _gxe_canvas_offset_set PORTABLE C */
34 /* 6.1 */
35 /* AUTHOR */
36 /* */
37 /* Kenneth Maxwell, Microsoft Corporation */
38 /* */
39 /* DESCRIPTION */
40 /* */
41 /* This function checks for errors in the canvas pixelmap get function */
42 /* call. */
43 /* */
44 /* INPUT */
45 /* */
46 /* pixelmap Pointer to destination for */
47 /* the retrieved pixlemap */
48 /* */
49 /* OUTPUT */
50 /* */
51 /* status Completion status */
52 /* */
53 /* CALLS */
54 /* */
55 /* _gxe_canvas_pixelmap_get Actual canvas pixelmap get */
56 /* call */
57 /* */
58 /* CALLED BY */
59 /* */
60 /* Application Code */
61 /* */
62 /* RELEASE HISTORY */
63 /* */
64 /* DATE NAME DESCRIPTION */
65 /* */
66 /* 05-19-2020 Kenneth Maxwell Initial Version 6.0 */
67 /* 09-30-2020 Kenneth Maxwell Modified comment(s), */
68 /* resulting in version 6.1 */
69 /* */
70 /**************************************************************************/
_gxe_canvas_pixelmap_get(GX_PIXELMAP * pixelmap)71 UINT _gxe_canvas_pixelmap_get(GX_PIXELMAP *pixelmap)
72 {
73 UINT status;
74
75 /* Check for the invalid input pointers. */
76 if (pixelmap == GX_NULL)
77 {
78 return(GX_PTR_ERROR);
79 }
80
81 /* Call the actual canvas pixlemap get function. */
82 status = _gx_canvas_pixelmap_get(pixelmap);
83
84 /* Return completion status. */
85 return status;
86 }
87
88
