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 /** Utility (Utility) */
18 /** */
19 /**************************************************************************/
20
21 #define GX_SOURCE_CODE
22
23
24 /* Include necessary system files. */
25
26 #include "gx_api.h"
27 #include "gx_utility.h"
28
29 /**************************************************************************/
30 /* */
31 /* FUNCTION RELEASE */
32 /* */
33 /* _gxe_utility_rectangle_shift 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 utility rectangle shift */
42 /* function call. */
43 /* */
44 /* INPUT */
45 /* */
46 /* rectangle Rectangle to shift */
47 /* x_shift Number of pixels to shift */
48 /* on the x-axis */
49 /* y_shift Number of pixels to shift */
50 /* on the y-axis */
51 /* */
52 /* OUTPUT */
53 /* */
54 /* None */
55 /* */
56 /* CALLS */
57 /* */
58 /* _gx_utility_rectangle_shift Actual utility rectangle */
59 /* shift function */
60 /* */
61 /* CALLED BY */
62 /* */
63 /* Application Code */
64 /* */
65 /* RELEASE HISTORY */
66 /* */
67 /* DATE NAME DESCRIPTION */
68 /* */
69 /* 05-19-2020 Kenneth Maxwell Initial Version 6.0 */
70 /* 09-30-2020 Kenneth Maxwell Modified comment(s), */
71 /* resulting in version 6.1 */
72 /* */
73 /**************************************************************************/
_gxe_utility_rectangle_shift(GX_RECTANGLE * rectangle,GX_VALUE x_shift,GX_VALUE y_shift)74 UINT _gxe_utility_rectangle_shift(GX_RECTANGLE *rectangle, GX_VALUE x_shift, GX_VALUE y_shift)
75 {
76 /* Check for invalid input pointers. */
77 if (rectangle == GX_NULL)
78 {
79 return GX_PTR_ERROR;
80 }
81
82 /* Call the actual utility rectangle shift function. */
83 return(_gx_utility_rectangle_shift(rectangle, x_shift, y_shift));
84 }
85
86
