OS_GetFavoriteColor


C Specification

#include <nitro/os.h>

static inline GXRgb OS_GetFavoriteColor(int index);

Description

Gets the "favorite color" color value which corresponds to the number of the favoriteColor member of the OSOwnerInfo structure

Arguments

index Specifies which "favorite color" color-value number to get. This index is masked with 16 colors (4 bits), which is the total number of favorite colors.

Return Values

The color value of type GXRgb that corresponds to the specified number.

See also:

OSOwnerInfo, OS_FAVORITE_COLOR_*, OS_GetFavoriteColorTable

Revision History

10/08/2004 Initial version