libfbx-api.sgml

libfxb是linux下只写操作framebuffer的一个轻量级的库。

          <funcsynopsis>
            <funcdef>inline unsigned int <function>fb_make_color_unknown</function></funcdef>
            <paramdef>int <parameter>r</parameter></paramdef>
            <paramdef>int <parameter>g</parameter></paramdef>
            <paramdef>int <parameter>b</parameter></paramdef>
          </funcsynopsis>
        </refsynopsisdiv>
        <refsect1>
          <title>Arguments</title>
          <variablelist>
            <varlistentry>
              <term>
                <parameter>r</parameter>
              </term>
              <listitem>
                <para>
                  Red value of the color (0-255)
                </para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>
                <parameter>g</parameter>
              </term>
              <listitem>
                <para>
                  Green value of the color (0-255)
                </para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>
                <parameter>b</parameter>
              </term>
              <listitem>
                <para>
                  Blue  value of the color (0-255)
                </para>
              </listitem>
            </varlistentry>
          </variablelist>
        </refsect1>
        <refsect1>
          <title>Returns</title>
          <variablelist>
            <varlistentry>
              <listitem>
                <para>
                  What is hopefullly the color
                </para>
              </listitem>
            </varlistentry>
          </variablelist>
        </refsect1>
        <refsect1>
          <title>Description</title>
          <para>
            This function tries to figure out how to make a color for an unknown bit depth.
          </para>
        </refsect1>
      </refentry>
      <refentry>
        <refmeta>
          <refentrytitle>
            <phrase id="API-fb-make-332-map">
              fb_make_332_map
            </phrase>
          </refentrytitle>
        </refmeta>

        <refnamediv>
          <refname>fb_make_332_map</refname>
          <refpurpose>
            Generates a color map.
          </refpurpose>
        </refnamediv>

        <refsynopsisdiv>
          <title>Synopsis</title>
          <funcsynopsis>
            <funcdef>void <function>fb_make_332_map</function></funcdef>
            <paramdef>struct fb_cmap *<parameter>map</parameter></paramdef>
          </funcsynopsis>
        </refsynopsisdiv>
        <refsect1>
          <title>Arguments</title>
          <variablelist>
            <varlistentry>
              <term>
                <parameter>map</parameter>
              </term>
              <listitem>
                <para>
                  Pointer to the FB colormap struct
                </para>
              </listitem>
            </varlistentry>
          </variablelist>
        </refsect1>
        <refsect1>
          <title>Returns</title>
          <variablelist>
            <varlistentry>
              <listitem>
                <para>
                  None
                </para>
              </listitem>
            </varlistentry>
          </variablelist>
        </refsect1>
        <refsect1>
          <title>Description</title>
          <para>
            This function generates a color map for use in 8-bit color modes. It is a simulated truecolor palette.
          </para>
        </refsect1>
      </refentry>
    </sect1>
  </chapter>
  <chapter id="line-functions">
    <title>Line functions</title>
    <sect1>
      <refentry>
        <refmeta>
          <refentrytitle>
            <phrase id="API-fb-line">
              fb_line
            </phrase>
          </refentrytitle>
        </refmeta>

        <refnamediv>
          <refname>fb_line</refname>
          <refpurpose>
	    Draws a line.
          </refpurpose>
        </refnamediv>

        <refsynopsisdiv>
          <title>Synopsis</title>
          <funcsynopsis>
            <funcdef>void <function>fb_line</function></funcdef>
            <paramdef>int <parameter>x1</parameter></paramdef>
            <paramdef>int <parameter>y1</parameter></paramdef>
            <paramdef>int <parameter>x2</parameter></paramdef>
            <paramdef>int <parameter>y2</parameter></paramdef>
            <paramdef>int <parameter>r</parameter></paramdef>
            <paramdef>int <parameter>g</parameter></paramdef>
            <paramdef>int <parameter>b</parameter></paramdef>
            <paramdef>fb_surface *<parameter>surface</parameter></paramdef>
          </funcsynopsis>
        </refsynopsisdiv>
        <refsect1>
          <title>Arguments</title>
          <variablelist>
            
            <varlistentry>
              <term>
                <parameter>x1</parameter>
              </term>
              <listitem>
                <para>
                  X Coordinate of the first point on the line
                </para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>
                <parameter>y1</parameter>
              </term>
              <listitem>
                <para>
                  Y Coordinate of the first point on the line
                </para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>
                <parameter>x2</parameter>
              </term>
              <listitem>
                <para>
                  X Coordinate of the last point on the line
                </para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>
                <parameter>y2</parameter>
              </term>
              <listitem>
                <para>
                  Y Coordinate of the last point on the line
                </para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>
                <parameter>r</parameter>
              </term>
              <listitem>
                <para>
                  Red color value of line
                </para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>
                <parameter>g</parameter>
              </term>
              <listitem>
                <para>
                  Green color value of line
                </para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>
                <parameter>b</parameter>
              </term>
              <listitem>
                <para>
                  Blue color value of line
                </para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>
                <parameter>surface</parameter>
              </term>
              <listitem>
                <para>
                  Destination drawing surface for line.
                </para>
              </listitem>
            </varlistentry>
          </variablelist>
        </refsect1>
        <refsect1>
          <title>Returns</title>
          <variablelist>
            <varlistentry>
              <listitem>
                <para>
                  None
                </para>
              </listitem>
            </varlistentry>
          </variablelist>
        </refsect1>
        <refsect1>
          <title>Description</title>
          <para>
            This function draws a line of the specified color from the specified start point to the specified end point on the specified end point on the specified drawing surface. fb_line uses Bresenham's run-sliced line drawing algorithm based on the implementation by Michael Abrash, and as such is quite fast.
          </para>
        </refsect1>
      </refentry>
    </sect1>
  </chapter>
  <chapter id="font-functions">
    <title>Font Functions</title>
    <sect1>
      <refentry>
        <refmeta>
          <refentrytitle>
            <phrase id="API-fb-readfont">
              fb_readfont
            </phrase>
          </refentrytitle>
        </refmeta>

        <refnamediv>
          <refname>fb_readfont</refname>
          <refpurpose>
            Locates and loads a font for use.
          </refpurpose>
        </refnamediv>

        <refsynopsisdiv>
          <title>Synopsis</title>
          <funcsynopsis>
            <funcdef>void <function>fb_readfont</function></funcdef>
            <paramdef>char **<parameter>filename</parameter></paramdef>
          </funcsynopsis>
        </refsynopsisdiv>
        <refsect1>
          <title>Arguments</title>
          <variablelist>
            <varlistentry>
              <term>
                <parameter>filename</parameter>
              </term>
              <listitem>
                <para>
                  Filename of font
                </para>
              </listitem>
            </varlistentry>
          </variablelist>
        </refsect1>
        <refsect1>
          <title>Returns</title>
          <variablelist>
            <varlistentry>
              <listitem>
                <para>
                  None
                </para>
              </listitem>
            </varlistentry>
          </variablelist>
        </refsect1>
        <refsect1>
          <title>Description</title>
          <para>
            This function locates and loads a usable font for fb to use. 
          </para>
        </refsect1>
      </refentry>
      <refentry>
        <refmeta>
          <refentrytitle>
            <phrase id="API-fb-setpixels">
              fb_setpixels
            </phrase>
          </refentrytitle>
        </refmeta>

        <refnamediv>
          <refname>fb_setpixels</refname>
          <refpurpose>
	    Draws 8 pixels.
          </refpurpose>
        </refnamediv>

        <refsynopsisdiv>
          <title>Synopsis</title>
          <funcsynopsis>
            <funcdef>void <function>fb_setpixels</function></funcdef>
            <paramdef>int <parameter>pos</parameter></paramdef>
            <paramdef>int <parameter>bits</parameter></paramdef>
          </funcsynopsis>
        </refsynopsisdiv>
        <refsect1>
          <title>Arguments</title>
          <variablelist>
            <varlistentry>
              <term>
                <parameter>pos</parameter>
              </term>
              <listitem>
                <para>
                  Position
                </para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>
                <parameter>bits</parameter>
              </term>
              <listitem>
                <para>
                  Bits
                </para>
              </listitem>
            </varlistentry>
          </variablelist>
        </refsect1>
        <refsect1>
          <title>Returns</title>
          <variablelist>
            <varlistentry>
              <listitem>
                <para>
                  None
                </para>
              </listitem>
            </varlistentry>
          </variablelist>
        </refsect1>
        <refsect1>
          <title>Description</title>
          <para>
            This function draws eight bits of data as eight pixels on the screen, usually for drawing 8-pixel-wide fonts.
          </para>
        </refsect1>
      </refentry>
      <refentry>
        <refmeta>
          <refentrytitle>
            <phrase id="API-fb-setpixels-masked">
              fb_setpixels_masked
            </phrase>
          </refentrytitle>
        </refmeta>

        <refnamediv>
          <refname>fb_setpixels_masked</refname>
          <refpurpose>
	    Draws 8 pixels, skips 0 bits.
          </refpurpose>
        </refnamediv>

        <refsynopsisdiv>
          <title>Synopsis</title>
          <funcsynopsis>
            <funcdef>void <function>fb_setpixels_masked</function></funcdef>
            <paramdef>int <parameter>pos</parameter></paramdef>
            <paramdef>int <parameter>bits</parameter></paramdef>
          </funcsynopsis>
        </refsynopsisdiv>
        <refsect1>
          <title>Arguments</title>
          <variablelist>
            <varlistentry>
              <term>
                <parameter>pos</parameter>
              </term>
              <listitem>
                <para>
                  Position
                </para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>
                <parameter>bits</parameter>
              </term>
              <listitem>
                <para>
                  Bits
                </para>
              </listitem>
            </varlistentry>
          </variablelist>
        </refsect1>
        <refsect1>
          <title>Returns</title>
          <variablelist>
            <varlistentry>
              <listitem>
                <para>
                  None
                </para>
              </listitem>
            </varlistentry>
          </variablelist>
        </refsect1>
        <refsect1>
          <title>Description</title>
          <para>
            This function draws eight bits of data as eight pixels on the screen, similar to fb_setpixels(), but skips zero bits instead of drawing the background color.
          </para>
        </refsect1>
      </refentry>
      <refentry>
        <refmeta>
          <refentrytitle>
            <phrase id="API-fb-putc">
              fb_putc
            </phrase>
          </refentrytitle>
        </refmeta>

        <refnamediv>
          <refname>fb_putc</refname>
          <refpurpose>
            Puts a character.
          </refpurpose>
        </refnamediv>

        <refsynopsisdiv>
          <title>Synopsis</title>
          <funcsynopsis>
            <funcdef>void <function>fb_putc</function></funcdef>
            <paramdef>int <parameter>x</parameter></paramdef>
            <paramdef>int <parameter>y</parameter></paramdef>
            <paramdef>int <parameter>c</parameter></paramdef>
          </funcsynopsis>
        </refsynopsisdiv>
        <refsect1>
          <title>Arguments</title>
          <variablelist>
            
            <varlistentry>
              <term>
                <parameter>x</parameter>
              </term>
              <listitem>
                <para>
                  X position (character cell coordinate)
                </para