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_hardware_layer_bind                     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 hardware layer bind   */
49 /*    call.                                                               */
50 /*                                                                        */
51 /*  INPUT                                                                 */
52 /*                                                                        */
53 /*    canvas                                Canvas control block          */
54 /*    layer                                 hardware layer                */
55 /*                                                                        */
56 /*  OUTPUT                                                                */
57 /*                                                                        */
58 /*    status                                Completion status             */
59 /*                                                                        */
60 /*  CALLS                                                                 */
61 /*                                                                        */
62 /*    _gx_canvas_hardware_layer_bind        Actual canvas bind 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_hardware_layer_bind(GX_CANVAS * canvas,INT layer)77 UINT  _gxe_canvas_hardware_layer_bind(GX_CANVAS *canvas, INT layer)
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     if (canvas -> gx_canvas_display == GX_NULL)
96     {
97         return (GX_INVALID_DISPLAY);
98     }
99     if (canvas -> gx_canvas_display -> gx_display_layer_services == GX_NULL)
100     {
101         return (GX_NOT_SUPPORTED);
102     }
103 
104     /* Call the actual canvas alpha set function.  */
105     status = _gx_canvas_hardware_layer_bind(canvas, layer);
106 
107     /* Return completion status.  */
108     return status;
109 }
110 
111