1
0
mirror of https://github.com/azure-rtos/guix.git synced 2025-02-04 07:13:17 +08:00
guix/common/src/gxe_sprite_current_frame_set.c
Bo Chen (from Dev Box) db360a10fa Update copyright.
2024-01-29 14:12:20 +08:00

100 lines
4.9 KiB
C

/***************************************************************************
* Copyright (c) 2024 Microsoft Corporation
*
* This program and the accompanying materials are made available under the
* terms of the MIT License which is available at
* https://opensource.org/licenses/MIT.
*
* SPDX-License-Identifier: MIT
**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/** */
/** GUIX Component */
/** */
/** Sprite Management (Sprite) */
/** */
/**************************************************************************/
#define GX_SOURCE_CODE
/* Include necessary system files. */
#include "gx_api.h"
#include "gx_sprite.h"
/* Bring in externs for caller checking code. */
GX_CALLER_CHECKING_EXTERNS
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _gxe_sprite_current_frame_set PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Kenneth Maxwell, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This service checks for error in the sprite current frame set call. */
/* */
/* INPUT */
/* */
/* sprite Pointer to sprite widget */
/* control block */
/* frame_index The frame index to display */
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* */
/* CALLS */
/* */
/* _gx_sprite_current_frame_set Actual sprite current frame */
/* set call. */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Kenneth Maxwell Initial Version 6.0 */
/* 09-30-2020 Kenneth Maxwell Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _gxe_sprite_current_frame_set(GX_SPRITE *sprite, USHORT frame_index)
{
UINT status;
/* Check for appropriate caller. */
GX_INIT_AND_THREADS_CALLER_CHECKING
/* Check for invalid pointer. */
if (sprite == GX_NULL)
{
return(GX_PTR_ERROR);
}
/* Check for invalid widget. */
if (sprite -> gx_widget_type == 0)
{
return(GX_INVALID_WIDGET);
}
/* Call the actual sprite frame set function. */
status = _gx_sprite_current_frame_set(sprite, frame_index);
/* Return completion status. */
return(status);
}