prg_color_to_string()
Abstract
Determines a string representation corresponding to a color object.
Syntax
prg_color_to_string (color, name_buffer, buffer_size)
| Argument | Type | Description |
|---|---|---|
color |
PrgT_Color |
Color object to be converted to a string. |
name_buffer |
char * |
Area to hold color name string. |
buffer_size |
size_t |
Size of name_buffer. (Maximum string length is buffer_size – 1) |
Return Type
PrgT_Compcode
PrgC_Compcode_Failure if a string cannot be generated; PrgC_Compcode_Success otherwise.
Header
prg_color.h
Details
This function returns a color name that corresponds to color. The name will be in one of the following string formats:
- Color name (for example, “medium blue”)
- “#
rrggbb” (24-bit color scheme, whererr,gg, andbbare hexadecimal numbers 00–FF)