manual/advanced_topics/viewports/colour-vp-syntax.tex

   1 \subsubsection{Viewport Declaration Syntax}
   2
   3 \config{\%V(x,y,[width],[height],[font]) \%Vf([fgcolour]) \%Vb([bgcolour])}%
   4
   5     \begin{itemize}
   6       \item `fgcolour' and `bgcolour' are 6-digit RGB888 colours, e.g. FF00FF.
   7       \item `font' is a number: 0 is the built-in system font, 1 is the
   8       current menu font, and 2-9 are additional are skin loaded fonts (see
   9       \reference{ref:multifont}).
  10       \item Only the coordinates \emph{have} to be specified. Leaving the other
  11       definitions blank will set them to their default values.
  12     \end{itemize}
  13
  14 \note{The correct number of commas with hyphens in
  15       blank fields are still needed in any case.}
  16
  17 \begin{example}
  18     %V(12,20,-,-,1) %Vf(000000) %Vb(FFFFFF)
  19     %sThis viewport is displayed permanently. It starts 12px from the left and
  20     %s20px from the top of the screen, and fills the rest of the screen from
  21     %sthat point. The lines will scroll if this text does not fit in the viewport.
  22     %sThe user font is used, and the foreground and background are set to black
  23     %sand white respectively.
  24 \end{example}
  25 \begin{rbtabular}{.75\textwidth}{XX}{\textbf{Viewport definition} & \textbf{Default value}}{}{}
  26   width/height & remaining part of screen \\
  27   font & user defined \\
  28   foreground/background colours & defined by theme \\
  29 \end{rbtabular}
  30