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 /* FUNCTION RELEASE */
34 /* */
35 /* _gxe_sprite_frame_list_set PORTABLE C */
36 /* 6.1 */
37 /* AUTHOR */
38 /* */
39 /* Kenneth Maxwell, Microsoft Corporation */
40 /* */
41 /* DESCRIPTION */
42 /* */
43 /* This service checks error in the sprite frame_list set call. */
44 /* */
45 /* INPUT */
46 /* */
47 /* sprite Pointer to sprite widget */
48 /* control block */
49 /* frame_list The frame list to be assigned */
50 /* frame_count Number of frames in the frame */
51 /* list */
52 /* */
53 /* OUTPUT */
54 /* */
55 /* status Completion status */
56 /* */
57 /* CALLS */
58 /* */
59 /* _gx_sprite_frame_list_set Actual sprite frame list set */
60 /* call */
61 /* */
62 /* CALLED BY */
63 /* */
64 /* Application Code */
65 /* */
66 /* RELEASE HISTORY */
67 /* */
68 /* DATE NAME DESCRIPTION */
69 /* */
70 /* 05-19-2020 Kenneth Maxwell Initial Version 6.0 */
71 /* 09-30-2020 Kenneth Maxwell Modified comment(s), */
72 /* resulting in version 6.1 */
73 /* */
74 /**************************************************************************/
_gxe_sprite_frame_list_set(GX_SPRITE * sprite,GX_SPRITE_FRAME * frame_list,USHORT frame_count)75 UINT _gxe_sprite_frame_list_set(GX_SPRITE *sprite, GX_SPRITE_FRAME *frame_list, USHORT frame_count)
76 {
77 UINT status;
78
79 /* Check for appropriate caller. */
80 GX_INIT_AND_THREADS_CALLER_CHECKING
81
82 /* Check for invalid pointer. */
83 if (sprite == GX_NULL)
84 {
85 return(GX_PTR_ERROR);
86 }
87
88 /* Check for invalid widget. */
89 if (sprite -> gx_widget_type == 0)
90 {
91 return(GX_INVALID_WIDGET);
92 }
93
94 /* Call the actual sprite frame list set function. */
95 status = _gx_sprite_frame_list_set(sprite, frame_list, frame_count);
96
97 /* Return completion status. */
98 return(status);
99 }
100
101
