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 /** Sprite Management (Sprite) */
18 /** */
19 /**************************************************************************/
20
21 #define GX_SOURCE_CODE
22
23
24 /* Include necessary system files. */
25
26 #include "gx_api.h"
27 #include "gx_sprite.h"
28
29 /* Bring in externs for caller checking code. */
30 GX_CALLER_CHECKING_EXTERNS
31
32 /**************************************************************************/
33 /* */
34 /* FUNCTION RELEASE */
35 /* */
36 /* _gxe_sprite_current_frame_set PORTABLE C */
37 /* 6.1 */
38 /* AUTHOR */
39 /* */
40 /* Kenneth Maxwell, Microsoft Corporation */
41 /* */
42 /* DESCRIPTION */
43 /* */
44 /* This service checks for error in the sprite current frame set call. */
45 /* */
46 /* INPUT */
47 /* */
48 /* sprite Pointer to sprite widget */
49 /* control block */
50 /* frame_index The frame index to display */
51 /* */
52 /* OUTPUT */
53 /* */
54 /* status Completion status */
55 /* */
56 /* CALLS */
57 /* */
58 /* _gx_sprite_current_frame_set Actual sprite current frame */
59 /* set call. */
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_sprite_current_frame_set(GX_SPRITE * sprite,USHORT frame_index)74 UINT _gxe_sprite_current_frame_set(GX_SPRITE *sprite, USHORT frame_index)
75 {
76 UINT status;
77
78 /* Check for appropriate caller. */
79 GX_INIT_AND_THREADS_CALLER_CHECKING
80
81 /* Check for invalid pointer. */
82 if (sprite == GX_NULL)
83 {
84 return(GX_PTR_ERROR);
85 }
86
87 /* Check for invalid widget. */
88 if (sprite -> gx_widget_type == 0)
89 {
90 return(GX_INVALID_WIDGET);
91 }
92
93 /* Call the actual sprite frame set function. */
94 status = _gx_sprite_current_frame_set(sprite, frame_index);
95
96 /* Return completion status. */
97 return(status);
98 }
99
100
