ui_sprite.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	uiSprite_t

Macros
#define	UI_MAX_SPRITES   512

Enumerations
enum	uiSpriteStatus_t {   SPRITE_STATUS_NORMAL = 0 , SPRITE_STATUS_HOVER = 1 , SPRITE_STATUS_DISABLED = 2 , SPRITE_STATUS_CLICKED = 3 ,   SPRITE_STATUS_MAX }

Functions
uiSprite_t *	UI_GetSpriteByName (const char *name)
	Return an sprite by is name.
uiSprite_t *	UI_AllocStaticSprite (const char *name) __attribute__((warn_unused_result))
	Allocate an sprite to the UI static memory.
void	UI_DrawSpriteInBox (bool flip, const uiSprite_t *icon, uiSpriteStatus_t status, int posX, int posY, int sizeX, int sizeY)

Variables
const value_t	ui_spriteProperties []

Macro Definition Documentation

UI_MAX_SPRITES

#define UI_MAX_SPRITES   512

Definition at line 27 of file ui_sprite.h.

Referenced by UI_AllocStaticSprite().

Enumeration Type Documentation

uiSpriteStatus_t

enum uiSpriteStatus_t

Todo

use a more generic name and move it to main ui

Enumerator
SPRITE_STATUS_NORMAL	ICON_STATUS_NORMAL
SPRITE_STATUS_HOVER	ICON_STATUS_HOVER
SPRITE_STATUS_DISABLED	ICON_STATUS_DISABLED
SPRITE_STATUS_CLICKED	ICON_STATUS_CLICKED
SPRITE_STATUS_MAX	ICON_STATUS_MAX

Definition at line 32 of file ui_sprite.h.

Function Documentation

UI_AllocStaticSprite()

uiSprite_t * UI_AllocStaticSprite

(

const char *

name

)

Allocate an sprite to the UI static memory.

Note

Its not a dynamic memory allocation. Please only use it at the loading time

Parameters

[in]

name

Name of the sprite

Todo

Assert out when we are not in parsing/loading stage

Definition at line 130 of file ui_sprite.cpp.

References Com_Error(), ERR_FATAL, name, uiSprite_t::name, OBJZERO, Q_strncpyz(), ui_global, UI_MAX_SPRITES, and UI_SpriteExists().

Referenced by UI_AutoGenerateSprite(), and UI_ParseSprite().

UI_DrawSpriteInBox()

void UI_DrawSpriteInBox	(	bool	flip,
		const uiSprite_t *	sprite,
		uiSpriteStatus_t	status,
		int	posX,
		int	posY,
		int	sizeX,
		int	sizeY )

Parameters

[in]	flip	Flip the icon rendering (horizontal)
[in]	sprite	Context sprite
[in]	status	The state of the sprite node
[in]	posX,posY	Absolute X/Y position of the top-left corner
[in]	sizeX,sizeY	Width/height of the bounding box

Todo

Add warning

Todo

merge all this cases

Definition at line 187 of file ui_sprite.cpp.

References uiSprite_t::blend, uiSprite_t::border, uiSprite_t::color, uiSprite_t::image, uiSprite_t::pack64, uiSprite_t::pos, R_Color(), uiSprite_t::single, uiSprite_t::size, SPRITE_STATUS_MAX, SPRITE_STATUS_NORMAL, tile_template_17_1_3, tile_template_25_1_3, tile_template_popup, uiSprite_t::tiled_17_1_3, uiSprite_t::tiled_25_1_3, uiSprite_t::tiled_popup, UI_DrawBorderedPanel(), UI_DrawNormImageByName(), UI_DrawPanel(), and Vector2FromInt.

Referenced by uiButtonNode::draw(), uiCheckBoxNode::draw(), uiOptionListNode::draw(), uiOptionTreeNode::draw(), uiPanelNode::draw(), uiRadioButtonNode::draw(), uiSpinnerNode::draw(), uiTabNode::draw(), uiTextEntryNode::draw(), uiWindowNode::draw(), and UI_MessageDraw().

UI_GetSpriteByName()

uiSprite_t * UI_GetSpriteByName

(

const char *

name

)

Return an sprite by is name.

Parameters

[in]

name

Name of the sprite

Returns

The requested sprite, else nullptr

Note

not very fast; if we use it often we should improve the search

Definition at line 115 of file ui_sprite.cpp.

References i, name, Q_streq, UI_AutoGenerateSprite(), and ui_global.

Referenced by uiOptionTreeNode::draw(), GAME_GetImportData(), UI_AbstractOption_SetBackgroundByName(), UI_Button_SetBackgroundByName(), UI_Button_SetIconByName(), UI_CheckBox_SetBackgroundByName(), UI_CheckBox_SetIconCheckedByName(), UI_CheckBox_SetIconUncheckedByName(), UI_CheckBox_SetIconUnknownByName(), UI_InitRawActionValue(), UI_MessageGetIcon(), UI_NodeSetProperty(), UI_Option_SetIconByName(), UI_Panel_SetBackgroundByName(), UI_ParseProperty(), UI_RadioButton_SetBackgroundByName(), UI_RadioButton_SetIconByName(), UI_Spinner_SetBackgroundByName(), UI_Spinner_SetBottomIconByName(), UI_Spinner_SetTopIconByName(), UI_TextEntry_SetBackgroundByName(), and UI_Window_SetBackgroundByName().

Variable Documentation

ui_spriteProperties

const value_t ui_spriteProperties[]

extern

Definition at line 31 of file ui_sprite.cpp.

Referenced by UI_ParseSprite().