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 #include "gx_system.h"
29 
30 /**************************************************************************/
31 /*                                                                        */
32 /*  FUNCTION                                               RELEASE        */
33 /*                                                                        */
34 /*    _gx_canvas_pixelmap_get                             PORTABLE C      */
35 /*                                                           6.1          */
36 /*  AUTHOR                                                                */
37 /*                                                                        */
38 /*    Kenneth Maxwell, Microsoft Corporation                              */
39 /*                                                                        */
40 /*  DESCRIPTION                                                           */
41 /*                                                                        */
42 /*    This function creates a GX_PIXELMAP structure pointing to the       */
43 /*    canvas data.                                                        */
44 /*                                                                        */
45 /*  INPUT                                                                 */
46 /*                                                                        */
47 /*    pixelmap                              Pointer to destination for    */
48 /*                                            the retrieved pixlemap      */
49 /*                                                                        */
50 /*  OUTPUT                                                                */
51 /*                                                                        */
52 /*    status                                Completion status             */
53 /*                                                                        */
54 /*  CALLS                                                                 */
55 /*                                                                        */
56 /*    None                                                                */
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 /**************************************************************************/
_gx_canvas_pixelmap_get(GX_PIXELMAP * pixelmap)71 UINT  _gx_canvas_pixelmap_get(GX_PIXELMAP *pixelmap)
72 {
73 GX_DRAW_CONTEXT *context;
74 GX_DISPLAY      *display;
75 GX_CANVAS       *canvas;
76 
77     /* pick up the current drawing context */
78     context = _gx_system_current_draw_context;
79     if (context == GX_NULL)
80     {
81         return GX_INVALID_CONTEXT;
82     }
83 
84     /* pick up curren canvas. */
85     canvas = context -> gx_draw_context_canvas;
86     if (canvas == GX_NULL)
87     {
88         return GX_INVALID_CANVAS;
89     }
90 
91     /* pick up current display driver */
92     display = context -> gx_draw_context_display;
93     if (display == GX_NULL)
94     {
95         return GX_INVALID_DISPLAY;
96     }
97 
98     memset(pixelmap, 0, sizeof(GX_PIXELMAP));
99 
100     pixelmap -> gx_pixelmap_width = canvas -> gx_canvas_x_resolution;
101     pixelmap -> gx_pixelmap_height = canvas -> gx_canvas_y_resolution;
102     pixelmap -> gx_pixelmap_format = (GX_UBYTE)display -> gx_display_color_format;
103     pixelmap -> gx_pixelmap_data = (GX_UBYTE *)canvas -> gx_canvas_memory;
104     pixelmap -> gx_pixelmap_data_size = canvas -> gx_canvas_memory_size;
105     pixelmap -> gx_pixelmap_version_major = 1;
106     pixelmap -> gx_pixelmap_version_minor = 0;
107 
108     /* Return successful completion.  */
109     return(GX_SUCCESS);
110 }
111 
112