Show_Line_XXX

Detailed Description

group Show_Line_XXX

Function Documentation

char HIC_Show_Line_Pattern(HIC_Rendition const *nr)

This function returns the line pattern as a string.

Parameters:nr – A pointer to a const HIC_Rendition.
Returns:A char.
const char *HIC_Show_Line_Style(HIC_Rendition const *nr)

This function returns the line style name as a string which is either a user-defined line style or line pattern such as “dashdot”.

Parameters:nr – A pointer to a const HIC_Rendition.
Returns:A pointer to a const char.
int HIC_Show_Line_Weight(HIC_Rendition const *nr)

This function returns line weight as an int.

Parameters:nr – A pointer to a const HIC_Rendition.
Returns:An int.
float HIC_Show_Line_Color_Red(HIC_Rendition const *nr)

This function returns the red component of the line color as a float value with a range 0 to 1.

Parameters:nr – A pointer to a const HIC_Rendition.
Returns:A float.
float HIC_Show_Line_Color_Green(HIC_Rendition const *nr)

This function returns the green component of the line color as a float value with a range 0 to 1.

Parameters:nr – A pointer to a const HIC_Rendition.
Returns:A float.
float HIC_Show_Line_Color_Blue(HIC_Rendition const *nr)

This function returns the blue component of the line color as a float value with a range 0 to 1.

Parameters:nr – A pointer to a const HIC_Rendition.
Returns:A float.
float HIC_Show_Line_Color_Alpha(HIC_Rendition const *nr)

This function returns the alpha component of the line color as a float value with a range 0 to 1.

Parameters:nr – A pointer to a const HIC_Rendition.
Returns:A float.
HIC_Integer32 HIC_Show_Internal_Line_Color(HIC_Rendition const *nr)

This function returns the internal representation of the line color.

Parameters:nr – A pointer to a const HIC_Rendition.
Returns:A HIC_Integer32.
float HIC_Show_Line_Contrast_Color_Red(HIC_Rendition const *nr)

This function returns the red component of the line contrast color as a float value with a range 0 to 1.

Parameters:nr – A pointer to a const HIC_Rendition.
Returns:A float.
float HIC_Show_Line_Contrast_Color_Green(HIC_Rendition const *nr)

This function returns the green component of the line contrast color as a float value with a range 0 to 1.

Parameters:nr – A pointer to a const HIC_Rendition.
Returns:A float.
float HIC_Show_Line_Contrast_Color_Blue(HIC_Rendition const *nr)

This function returns the blue component of the line contrast color as a float value with a range 0 to 1.

Parameters:nr – A pointer to a const HIC_Rendition.
Returns:A float.
HIC_Integer32 HIC_Show_Internal_Line_Contrast_Color(HIC_Rendition const *nr)

This function returns the internal represantation of the line contrast color.

Parameters:nr – A pointer to a const HIC_Rendition.
Returns:An HIC_Integer32.