Function Index Class Index

User_Face_Pattern

Functions

HC_EXTERNAL HIC_API void HIC_Free_User_Face_Pattern (HIC_User_Face_Pattern const *upat)
HC_EXTERNAL HIC_API
HIC_User_Face_Pattern const * 
HIC_New_User_Face_Pattern (HIC_Rendition const *nr, int nrows, int ncols, unsigned char npat[], int const nsee)
HC_EXTERNAL HIC_API void HIC_Set_User_Face_Pattern (HIC_Rendition const *nr, HIC_User_Face_Pattern const *upat)

Function Documentation

HC_EXTERNAL HIC_API void HIC_Free_User_Face_Pattern ( HIC_User_Face_Pattern const *  upat)
Parameters:
upatA pointer to a const HIC_User_Face_Pattern.

This function releases the memory allocated for a user pattern.

HC_EXTERNAL HIC_API HIC_User_Face_Pattern const* HIC_New_User_Face_Pattern ( HIC_Rendition const *  nr,
int  nrows,
int  ncols,
unsigned char  npat[],
int const  nsee 
)
Parameters:
nrA pointer to a const HIC_Rendition.
nrowsAn int. If negative, the pattern will be applied with the row order reversed from that of the stored character array.
ncolsAn int.
npatA static unsigned char.
nseeA const int.
Returns:
A pointer to a const HIC_User_Face_Pattern.

This function defines a custom face pattern.

HC_EXTERNAL HIC_API void HIC_Set_User_Face_Pattern ( HIC_Rendition const *  nr,
HIC_User_Face_Pattern const *  upat 
)
Parameters:
nrA pointer to a const HIC_Rendition.
upatA pointer to a const HIC_User_Face_Pattern.

This function sets a user face pattern.