Update developer docs for mkhighlight changes

Specifically for passing -1 as a colour number, and for proper handling
of dark backgrounds.
This commit is contained in:
Ben Harris
2022-12-15 13:53:29 +00:00
parent 8acb84ea7f
commit f1756279d2

View File

@ -4948,7 +4948,7 @@ sections. Fifteen, Sixteen and Twiddle are good examples of this.
Puzzles using this graphical style are running a risk if they just Puzzles using this graphical style are running a risk if they just
use whatever background colour is supplied to them by the front end, use whatever background colour is supplied to them by the front end,
because that background colour might be too light to see any because that background colour might be too light or dark to see any
highlights on at all. (In particular, it's not unheard of for the highlights on at all. (In particular, it's not unheard of for the
front end to specify a default background colour of white.) front end to specify a default background colour of white.)
@ -4972,6 +4972,10 @@ Thus, \cw{ret[background*3]} to \cw{ret[background*3+2]} will be set
to RGB values defining a sensible background colour, and similary to RGB values defining a sensible background colour, and similary
\c{highlight} and \c{lowlight} will be set to sensible colours. \c{highlight} and \c{lowlight} will be set to sensible colours.
Either \c{highlight} or \c{lowlight} may be passed in as \cw{-1} to
indicate that the back-end does not require a highlight or lowlight
colour, respectively.
\S{utils-game-mkhighlight-specific} \cw{game_mkhighlight_specific()} \S{utils-game-mkhighlight-specific} \cw{game_mkhighlight_specific()}
\c void game_mkhighlight_specific(frontend *fe, float *ret, \c void game_mkhighlight_specific(frontend *fe, float *ret,