Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

update docs

  • Loading branch information...
commit dc411b8b128916521a32c65476a73e479d4a746f 1 parent c07abaa
@filonenko-mikhail authored
View
22 doc/clx-truetype.html
@@ -291,6 +291,12 @@ <h2 class="chapter">3 Dictionary</h2>
<li><code>antialias</code> &mdash; initarg: <code>clx-truetype::antialias<!-- /@w --></code>; reader: <code>clx-truetype:font-antialias<!-- /@w --></code>; writer: <code>(setf&nbsp;clx-truetype:font-antialias)<!-- /@w --></code>
<p>Antialias text string.
+<li><code>string-bboxes</code> &mdash; reader: <code>clx-truetype::font-string-bboxes<!-- /@w --></code>; writer: <code>(setf&nbsp;clx-truetype::font-string-bboxes)<!-- /@w --></code>
+
+ <p>Cache for bboxes
+<li><code>string-line-bboxes</code> &mdash; reader: <code>clx-truetype::font-string-line-bboxes<!-- /@w --></code>; writer: <code>(setf&nbsp;clx-truetype::font-string-line-bboxes)<!-- /@w --></code>
+
+ <p>Cache for bboxes
</ul>
<p>Class for representing font information.
@@ -355,42 +361,42 @@ <h2 class="chapter">3 Dictionary</h2>
<p><a name="index-text_002dbounding_002dbox-30"></a><a name="Function-text_002dbounding_002dbox"></a>
<div class="defun">
-&mdash; Function: <b>text-bounding-box</b><var> drawable font string<a name="index-text_002dbounding_002dbox-31"></a></var><br>
+&mdash; Function: <b>text-bounding-box</b><var> drawable font string &amp;key start end<a name="index-text_002dbounding_002dbox-31"></a></var><br>
<blockquote><p>Returns text bounding box. <var>drawable</var> must be window, pixmap or screen. Text bounding box is only for contours. Bounding box for space (#x20) is zero.
</p></blockquote></div>
<p><a name="index-text_002dwidth-32"></a><a name="Function-text_002dwidth"></a>
<div class="defun">
-&mdash; Function: <b>text-width</b><var> drawable font string<a name="index-text_002dwidth-33"></a></var><br>
+&mdash; Function: <b>text-width</b><var> drawable font string &amp;key start end<a name="index-text_002dwidth-33"></a></var><br>
<blockquote><p>Returns width of text bounding box. <var>drawable</var> must be window, pixmap or screen.
</p></blockquote></div>
<p><a name="index-text_002dheight-34"></a><a name="Function-text_002dheight"></a>
<div class="defun">
-&mdash; Function: <b>text-height</b><var> drawable font string<a name="index-text_002dheight-35"></a></var><br>
+&mdash; Function: <b>text-height</b><var> drawable font string &amp;key start end<a name="index-text_002dheight-35"></a></var><br>
<blockquote><p>Returns height of text bounding box. <var>drawable</var> must be window, pixmap or screen.
</p></blockquote></div>
<p><a name="index-text_002dline_002dbounding_002dbox-36"></a><a name="Function-text_002dline_002dbounding_002dbox"></a>
<div class="defun">
-&mdash; Function: <b>text-line-bounding-box</b><var> drawable font string<a name="index-text_002dline_002dbounding_002dbox-37"></a></var><br>
+&mdash; Function: <b>text-line-bounding-box</b><var> drawable font string &amp;key start end<a name="index-text_002dline_002dbounding_002dbox-37"></a></var><br>
<blockquote><p>Returns text line bounding box. <var>drawable</var> must be window, pixmap or screen. Text line bounding box is bigger than text bounding box. It's height is ascent <code>+</code> descent, width is sum of advance widths minus sum of kernings.
</p></blockquote></div>
<p><a name="index-text_002dline_002dwidth-38"></a><a name="Function-text_002dline_002dwidth"></a>
<div class="defun">
-&mdash; Function: <b>text-line-width</b><var> drawable font string<a name="index-text_002dline_002dwidth-39"></a></var><br>
+&mdash; Function: <b>text-line-width</b><var> drawable font string &amp;key start end<a name="index-text_002dline_002dwidth-39"></a></var><br>
<blockquote><p>Returns width of text line bounding box. <var>drawable</var> must be window, pixmap or screen. It is sum of advance widths minus sum of kernings.
</p></blockquote></div>
<p><a name="index-text_002dline_002dheight-40"></a><a name="Function-text_002dline_002dheight"></a>
<div class="defun">
-&mdash; Function: <b>text-line-height</b><var> drawable font string<a name="index-text_002dline_002dheight-41"></a></var><br>
+&mdash; Function: <b>text-line-height</b><var> drawable font string &amp;key start end<a name="index-text_002dline_002dheight-41"></a></var><br>
<blockquote><p>Returns height of text line bounding box. <var>drawable</var> must be window, pixmap or screen.
</p></blockquote></div>
@@ -425,7 +431,7 @@ <h2 class="chapter">3 Dictionary</h2>
<p><a name="index-draw_002dtext-50"></a><a name="Function-draw_002dtext"></a>
<div class="defun">
-&mdash; Function: <b>draw-text</b><var> drawable gcontext font string x y &amp;key start end<a name="index-draw_002dtext-51"></a></var><br>
+&mdash; Function: <b>draw-text</b><var> drawable gcontext font string x y &amp;key start end draw-background-p<a name="index-draw_002dtext-51"></a></var><br>
<blockquote><p>Draws text string using <var>font</var> on <var>drawable</var> with graphic context <var>gcontext</var>. <var>x</var>, <var>y</var> are the left point of base line. <var>start</var> and <var>end</var> are used for substring rendering.
If <var>gcontext</var> has background color, text bounding box will be filled with it. Text line bounding box is bigger than text bounding box. <var>drawable</var> must be window or pixmap.
</p></blockquote></div>
@@ -433,7 +439,7 @@ <h2 class="chapter">3 Dictionary</h2>
<p><a name="index-draw_002dtext_002dline-52"></a><a name="Function-draw_002dtext_002dline"></a>
<div class="defun">
-&mdash; Function: <b>draw-text-line</b><var> drawable gcontext font string x y &amp;key start end<a name="index-draw_002dtext_002dline-53"></a></var><br>
+&mdash; Function: <b>draw-text-line</b><var> drawable gcontext font string x y &amp;key start end draw-background-p<a name="index-draw_002dtext_002dline-53"></a></var><br>
<blockquote><p>Draws text string using <var>font</var> on <var>drawable</var> with graphic context <var>gcontext</var>. <var>x</var>, <var>y</var> are the left point of base line. <var>start</var> and <var>end</var> are used for substring rendering.
If <var>gcontext</var> has background color, text line bounding box will be filled with it. Text line bounding box is bigger than text bounding box. <var>drawable</var> must be window or pixmap.
</p></blockquote></div>
View
BIN  doc/clx-truetype.pdf
Binary file not shown
View
6 doc/include/class-xft-font.texinfo
@@ -35,6 +35,12 @@ Use font values for background and foreground colors.
@item @code{antialias} --- initarg: @code{@w{clx-truetype::antialias}}; reader: @code{@w{clx-truetype:font-antialias}}; writer: @code{@w{(setf clx-truetype:font-antialias)}}
Antialias text string.
+@item @code{string-bboxes} --- reader: @code{@w{clx-truetype::font-string-bboxes}}; writer: @code{@w{(setf clx-truetype::font-string-bboxes)}}
+
+Cache for bboxes
+@item @code{string-line-bboxes} --- reader: @code{@w{clx-truetype::font-string-line-bboxes}}; writer: @code{@w{(setf clx-truetype::font-string-line-bboxes)}}
+
+Cache for bboxes
@end itemize
Class for representing font information.
View
2  doc/include/fun-xft-draw-text-line.texinfo
@@ -1,6 +1,6 @@
@findex draw-text-line
@anchor{Function draw-text-line}
-@deffn {Function} {draw-text-line} drawable gcontext font string x y @&key start end
+@deffn {Function} {draw-text-line} drawable gcontext font string x y @&key start end draw-background-p
Draws text string using @var{font} on @var{drawable} with graphic context @var{gcontext}. @var{x}, @var{y} are the left point of base line. @var{start} and @var{end} are used for substring rendering.
If @var{gcontext} has background color, text line bounding box will be filled with it. Text line bounding box is bigger than text bounding box. @var{drawable} must be window or pixmap.
@end deffn
View
2  doc/include/fun-xft-draw-text.texinfo
@@ -1,6 +1,6 @@
@findex draw-text
@anchor{Function draw-text}
-@deffn {Function} {draw-text} drawable gcontext font string x y @&key start end
+@deffn {Function} {draw-text} drawable gcontext font string x y @&key start end draw-background-p
Draws text string using @var{font} on @var{drawable} with graphic context @var{gcontext}. @var{x}, @var{y} are the left point of base line. @var{start} and @var{end} are used for substring rendering.
If @var{gcontext} has background color, text bounding box will be filled with it. Text line bounding box is bigger than text bounding box. @var{drawable} must be window or pixmap.
@end deffn
View
2  doc/include/fun-xft-text-bounding-box.texinfo
@@ -1,5 +1,5 @@
@findex text-bounding-box
@anchor{Function text-bounding-box}
-@deffn {Function} {text-bounding-box} drawable font string
+@deffn {Function} {text-bounding-box} drawable font string @&key start end
Returns text bounding box. @var{drawable} must be window, pixmap or screen. Text bounding box is only for contours. Bounding box for space (#x20) is zero.
@end deffn
View
2  doc/include/fun-xft-text-height.texinfo
@@ -1,5 +1,5 @@
@findex text-height
@anchor{Function text-height}
-@deffn {Function} {text-height} drawable font string
+@deffn {Function} {text-height} drawable font string @&key start end
Returns height of text bounding box. @var{drawable} must be window, pixmap or screen.
@end deffn
View
2  doc/include/fun-xft-text-line-bounding-box.texinfo
@@ -1,5 +1,5 @@
@findex text-line-bounding-box
@anchor{Function text-line-bounding-box}
-@deffn {Function} {text-line-bounding-box} drawable font string
+@deffn {Function} {text-line-bounding-box} drawable font string @&key start end
Returns text line bounding box. @var{drawable} must be window, pixmap or screen. Text line bounding box is bigger than text bounding box. It's height is ascent @code{+} descent, width is sum of advance widths minus sum of kernings.
@end deffn
View
2  doc/include/fun-xft-text-line-height.texinfo
@@ -1,5 +1,5 @@
@findex text-line-height
@anchor{Function text-line-height}
-@deffn {Function} {text-line-height} drawable font string
+@deffn {Function} {text-line-height} drawable font string @&key start end
Returns height of text line bounding box. @var{drawable} must be window, pixmap or screen.
@end deffn
View
2  doc/include/fun-xft-text-line-width.texinfo
@@ -1,5 +1,5 @@
@findex text-line-width
@anchor{Function text-line-width}
-@deffn {Function} {text-line-width} drawable font string
+@deffn {Function} {text-line-width} drawable font string @&key start end
Returns width of text line bounding box. @var{drawable} must be window, pixmap or screen. It is sum of advance widths minus sum of kernings.
@end deffn
View
2  doc/include/fun-xft-text-width.texinfo
@@ -1,5 +1,5 @@
@findex text-width
@anchor{Function text-width}
-@deffn {Function} {text-width} drawable font string
+@deffn {Function} {text-width} drawable font string @&key start end
Returns width of text bounding box. @var{drawable} must be window, pixmap or screen.
@end deffn
Please sign in to comment.
Something went wrong with that request. Please try again.