libfbx-api.sgml

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

                <para>
                  Green value of pixel
                </para>
              </listitem>
	    </varlistentry>
	    <varlistentry>
              <term>
                <parameter>b</parameter>
              </term>
              <listitem>
                <para>
                  Blue value of pixel
                </para>
              </listitem>
	    </varlistentry>
	    <varlistentry>
              <term>
                <parameter>surface</parameter>
              </term>
              <listitem>
                <para>
                  Pointer to surface to put pixel on.
                </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 pixel to the surface at x, y position with rgb value.
          </para>
        </refsect1>
      </refentry>
      <refentry>
        <refmeta>
          <refentrytitle>
            <phrase id="API-fb-getpixel">
              fb_getpixel
            </phrase>
          </refentrytitle>
        </refmeta>

        <refnamediv>
          <refname>fb_getpixel</refname>
          <refpurpose>
            Gets a pixel.
          </refpurpose>
        </refnamediv>

        <refsynopsisdiv>
          <title>Synopsis</title>
          <funcsynopsis>
            <funcdef>void <function>fb_getpixel</function></funcdef>
            <paramdef>int <parameter>x</parameter></paramdef>
            <paramdef>int <parameter>y</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>x</parameter>
              </term>
              <listitem>
                <para>
                  x positioner
                </para>
              </listitem>
	    </varlistentry>
	    <varlistentry>
              <term>
                <parameter>y</parameter>
              </term>
              <listitem>
                <para>
                  y positioner
                </para>
              </listitem>
 	    </varlistentry>
	    <varlistentry>
              <term>
                <parameter>r</parameter>
              </term>
              <listitem>
                <para>
                  Red value of pixel
                </para>
              </listitem>
 	    </varlistentry>
	    <varlistentry>
              <term>
                <parameter>g</parameter>
              </term>
              <listitem>
                <para>
                  Green value of pixel
                </para>
              </listitem>
 	    </varlistentry>
	    <varlistentry>
              <term>
                <parameter>b</parameter>
              </term>
              <listitem>
                <para>
                  Blue value of pixel
                </para>
              </listitem>
 	    </varlistentry>
	    <varlistentry>
              <term>
                <parameter>surface</parameter>
              </term>
              <listitem>
                <para>
                  Pointer to surface to put pixel on.
                </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 gets a pixel on surface at specified x, y position
          </para>
        </refsect1>
      </refentry>
    </sect1>
  </chapter>
  <chapter id="color-functions">
    <title>Color Functions</title>
    <sect1>
      <refentry>
        <refmeta>
          <refentrytitle>
            <phrase id="API-fb-make-color-8">
              fb_make_color_8
            </phrase>
          </refentrytitle>
        </refmeta>

        <refnamediv>
          <refname>fb_make_color_8</refname>
          <refpurpose>
            Makes an 8bit color.
          </refpurpose>
        </refnamediv>

        <refsynopsisdiv>
          <title>Synopsis</title>
          <funcsynopsis>
            <funcdef>inline unsigned int <function>fb_make_color_8</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>
                  8-bit RGB color
                </para>
              </listitem>
            </varlistentry>
          </variablelist>
        </refsect1>
        <refsect1>
          <title>Description</title>
          <para>
            This function makes a color out of the specified RGB values for the specified bit depth (8) and returns it.
          </para>
        </refsect1>
      </refentry>
      <refentry>
        <refmeta>
          <refentrytitle>
            <phrase id="API-fb-make-color-15">
              fb_make_color_15
            </phrase>
          </refentrytitle>
        </refmeta>

        <refnamediv>
          <refname>fb_make_color_15</refname>
          <refpurpose>
            Makes a 15bit color.
          </refpurpose>
        </refnamediv>

        <refsynopsisdiv>
          <title>Synopsis</title>
          <funcsynopsis>
            <funcdef>inline unsigned int <function>fb_make_color_15</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>
                  15-bit RGB color
                </para>
              </listitem>
            </varlistentry>
          </variablelist>
        </refsect1>
        <refsect1>
          <title>Description</title>
          <para>
            This function makes a color out of the specified RGB values for the specified bit depth (15) and returns it.
          </para>
        </refsect1>
      </refentry>
      <refentry>
        <refmeta>
          <refentrytitle>
            <phrase id="API-fb-make-color-16">
              fb_make_color_16
            </phrase>
          </refentrytitle>
        </refmeta>

        <refnamediv>
          <refname>fb_make_color_16</refname>
          <refpurpose>
            Makes a 16bit color.
          </refpurpose>
        </refnamediv>

        <refsynopsisdiv>
          <title>Synopsis</title>
          <funcsynopsis>
            <funcdef>inline unsigned int <function>fb_make_color_16</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>
                  16-bit RGB color
                </para>
              </listitem>
            </varlistentry>
          </variablelist>
        </refsect1>
        <refsect1>
          <title>Description</title>
          <para>
            This function makes a color out of the specified RGB values for the specified bit depth (16) and returns it.
          </para>
        </refsect1>
      </refentry>
      <refentry>
        <refmeta>
          <refentrytitle>
            <phrase id="API-fb-make-color-24">
              fb_make_color_24
            </phrase>
          </refentrytitle>
        </refmeta>

        <refnamediv>
          <refname>fb_make_color_24</refname>
          <refpurpose>
            Makes a 24bit color.
          </refpurpose>
        </refnamediv>

        <refsynopsisdiv>
          <title>Synopsis</title>
          <funcsynopsis>
            <funcdef>inline unsigned int <function>fb_make_color_24</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>
                  24-bit RGB color
                </para>
              </listitem>
            </varlistentry>
          </variablelist>
        </refsect1>
        <refsect1>
          <title>Description</title>
          <para>
            This function makes a color out of the specified RGB values for the specified bit depth (24) and returns it.
          </para>
        </refsect1>
      </refentry>
      <refentry>
        <refmeta>
          <refentrytitle>
            <phrase id="API-fb-make-color-unknown">
              fb_make_color_unknown
            </phrase>
          </refentrytitle>
        </refmeta>

        <refnamediv>
          <refname>fb_make_color_unknown</refname>
          <refpurpose>
            Makes an unknown bit color.
          </refpurpose>
        </refnamediv>

        <refsynopsisdiv>
          <title>Synopsis</title>