fdo-mirrors/cairo
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/cairo/cairo.git synced 2026-01-04 16:50:19 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Documentation updates

Browse source
This commit is contained in:
Adrian Johnson 2023-01-28 14:41:24 +10:30
parent ffabca7924
commit f3d04cfa44
2 changed files with 31 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
doc/public/cairo-sections.txt
View file

@ -515,6 +515,14 @@ cairo_font_options_set_hint_metrics
cairo_font_options_get_hint_metrics
cairo_font_options_get_variations
cairo_font_options_set_variations
cairo_color_mode_t
cairo_font_options_set_color_mode
cairo_font_options_get_color_mode
CAIRO_COLOR_PALETTE_DEFAULT
cairo_font_options_set_color_palette
cairo_font_options_get_color_palette
cairo_font_options_set_custom_palette_color
cairo_font_options_get_custom_palette_color
</SECTION>
<SECTION>

34
src/cairo-font-options.c
View file

@ -700,6 +700,14 @@ cairo_font_options_get_color_mode (const cairo_font_options_t *options)
return options->color_mode;
}
/**
* CAIRO_COLOR_PALETTE_DEFAULT:
*
* The default color palette index.
*
* Since: 1.18
**/
/**
* cairo_font_options_set_color_palette:
* @options: a #cairo_font_options_t
@ -709,11 +717,11 @@ cairo_font_options_get_color_mode (const cairo_font_options_t *options)
* object. OpenType color fonts with a CPAL table may contain multiple
* palettes. The default color palette index is %CAIRO_COLOR_PALETTE_DEFAULT.
*
* #cairo_font_options_t can also contain a custom palette, which will
* be used if @palette_index is %CAIRO_COLOR_PALETTE_CUSTOM.
*
* If @palette_index is invalid, the default palette is used.
*
* Individual colors within the palette may be overriden with
* cairo_font_options_set_custom_palette_color().
*
* Since: 1.18
**/
void
@ -730,7 +738,7 @@ cairo_font_options_set_color_palette (cairo_font_options_t *options,
* cairo_font_options_get_color_palette:
* @options: a #cairo_font_options_t
*
* Gets the OpenType color font palette for the font options object.
* Gets the current OpenType color font palette for the font options object.
*
* Return value: the palette index
*
@ -754,11 +762,14 @@ cairo_font_options_get_color_palette (const cairo_font_options_t *options)
* @blue: blue component of color
* @alpha: alpha component of color
*
* Sets a custom palette color for the font options object.
* Sets a custom palette color for the font options object. This
* overrides the palette color at the specified color index. This override is
* independent of the selected palette index and will remain in place
* even if cairo_font_options_set_color_palette() is called to change
* the palette index.
*
* The custom colors will be used in preference to the selected
* color palette from the font (see cairo_font_options_set_color_palette()).
* It is possible to override only selected colors from the font palette.
* It is only possible to override color indexes already in the font
* palette.
*
* Since: 1.18
*/
@ -803,10 +814,11 @@ cairo_font_options_set_custom_palette_color (cairo_font_options_t *options,
* @blue: return location for blue component of color
* @alpha: return location for alpha component of color
*
* Gets a custom palette color for the font options object.
* Gets the custom palette color for the color index for the font options object.
*
* Returns: `CAIRO_STATUS_SUCCESS` if a custom palette color is returned,
* `CAIRO_STATUS_INVALID_INDEX` otherwise.
* Returns: `CAIRO_STATUS_SUCCESS` if a custom palette color is
* returned, `CAIRO_STATUS_INVALID_INDEX` if no custom color exists
* for the color index.
*
* Since: 1.18
*/