libfbx-api.sgml

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

<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[]>

<book id="libfbxAPI" revision="$Id: libfbx-api.sgml,v 1.25 2001/03/03 00:02:14 lethal Exp $">
  <bookinfo>
    <title>libfbx API</title>

    <authorgroup>
      <author>
        <firstname>Paul</firstname>
        <surname>Mundt</surname>
        <affiliation>
	  <jobtitle>Head Developer</jobtitle>
	  <orgname>U4X Labs</orgname>
	  <address>
	    <email>[e-mail]</email>
	  </address>
	</affiliation>
      </author>
      <author>
        <firstname>Dean</firstname>
	<surname>Scott</surname>
	<affiliation>
	  <jobtitle>Packager</jobtitle>
	  <orgname>U4X Labs</orgname>
	  <address>
	    <email>[e-mail]</email>
	  </address>
	</affiliation>
      </author>
    </authorgroup>

    <copyright>
      <year>2000</year>
      <year>2001</year>
      <holder>U4X Labs</holder>
    </copyright>

    <legalnotice>
      <para>This documentation is released under the terms of the U4X Public
      License; either version 1.1 of this license, or (at your option) any
      subsequent version.  You should have recieved a copy of the U4X Public
      License with libfbx; if not, the current version can be found at
      <ulink url="http://www.u4x.org/upl.txt">http://www.u4x.org/upl.txt</ulink>.
      </para>
      
      <para>libfbx is provided by U4X Labs and contributors ``as is'' and is
      distributed WITHOUT ANY WARRANTY.  See the U4X Public License for more
      details.</para>
    </legalnotice>
  </bookinfo>

  <toc></toc>

  <title>Core Functions</title>
  <chapter id="primary-functions">
    <title>Primary Functions</title>
    <sect1>
      <refentry>
        <refmeta>
	  <refentrytitle>
	    <phrase id="API-fb-init">
	      fb_init
	    </phrase>
	  </refentrytitle>
	</refmeta>
        
	<refnamediv>
	  <refname>fb_init</refname>
	  <refpurpose>
	    Initializes the framebuffer device.
	  </refpurpose>
	</refnamediv>

	<refsynopsisdiv>
	  <title>Synopsis</title>
	  <funcsynopsis>
	    <funcdef>int <function>fb_init</function></funcdef>
	    <paramdef></paramdef>
	  </funcsynopsis>
	</refsynopsisdiv>

	<refsect1>
	  <title>Arguments</title>
	  <variablelist>
	    <varlistentry>
	      <listitem>
	        <para>
		  None
		</para>
              </listitem>
	    </varlistentry>
	  </variablelist>
	</refsect1>

	<refsect1>
	  <title>Returns</title>
	  <variablelist>
	    <varlistentry>
	      <listitem>
	        <para>
		  0 on success, -1 on failure.
		</para>
              </listitem>
	    </varlistentry>
	  </variablelist>
	</refsect1>

	<refsect1>
	  <title>Description</title>
	  <para>
	    This function locates and initializes the framebuffer device. The
	    resultant initialized display must be accessed via fb_screen.
	  </para>
	</refsect1>
      </refentry>

      <refentry>
        <refmeta>
	  <refentrytitle>
	    <phrase id="API-fb-cleanup">
	      fb_cleanup
	    </phrase>
	  </refentrytitle>
	</refmeta>

	<refnamediv>
	  <refname>fb_cleanup</refname>
	  <refpurpose>
	    Deinitializes the framebuffer device.
	  </refpurpose>
	</refnamediv>

        <refsynopsisdiv>
	  <title>Synopsis</title>
	  <funcsynopsis>
	    <funcdef>void <function>fb_cleanup</function></funcdef>
	    <paramdef></paramdef>
	  </funcsynopsis>
	</refsynopsisdiv>

	<refsect1>
	  <title>Arguments</title>
	  <variablelist>
	    <varlistentry>
	      <listitem>
	        <para>
		  None
		</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 deinitializes the framebuffer device by unmapping
	    memory and closing the file descriptor.
	  </para>
	</refsect1>
      </refentry>

      <refentry>
        <refmeta>
	  <refentrytitle>
	    <phrase id="API-fb-finddev">
	      fb_finddev
	    </phrase>
	  </refentrytitle>
	</refmeta>

	<refnamediv>
	  <refname>fb_finddev</refname>
	  <refpurpose>
	    Locates the framebuffer device.
	  </refpurpose>
	</refnamediv>

        <refsynopsisdiv>
	  <title>Synopsis</title>
	  <funcsynopsis>
	    <funcdef>char *<function>fb_finddev</function></funcdef>
	    <paramdef></paramdef>
	  </funcsynopsis>
	</refsynopsisdiv>

	<refsect1>
	  <title>Arguments</title>
	  <variablelist>
	    <varlistentry>
	      <listitem>
	        <para>
		  None
		</para>
	      </listitem>
	    </varlistentry>
	  </variablelist>
	</refsect1>

	<refsect1>
	  <title>Returns</title>
	  <variablelist>
	    <varlistentry>
	      <listitem>
	        <para>
		  Full path to framebuffer device.
		</para>
              </listitem>
	    </varlistentry>
	  </variablelist>
	</refsect1>

	<refsect1>
	  <title>Description</title>
	  <para>
	    This function looks for the existence of the framebuffer device
	    in the FRAMEBUFFER environment variable, and the relative path
	    in /dev. If no device is located, NULL is returned.
	  </para>
	</refsect1>
      </refentry>

      <refentry>
        <refmeta>
	  <refentrytitle>
	    <phrase id="API-fb-setdev">
	      fb_setdev
	    </phrase>
	  </refentrytitle>
	</refmeta>

	<refnamediv>
	  <refname>fb_setdev</refname>
	  <refpurpose>
	    Specifies the framebuffer device to use.
	  </refpurpose>
	</refnamediv>

        <refsynopsisdiv>
	  <title>Synopsis</title>
	  <funcsynopsis>
	    <funcdef>int <function>fb_setdev</function></funcdef>
	    <paramdef>char *<parameter>setdev</parameter></paramdef>
	  </funcsynopsis>
	</refsynopsisdiv>

	<refsect1>
	  <title>Arguments</title>
	  <variablelist>
	    <varlistentry>
	      <term>
	        <parameter>setdev</parameter>
              </term>
	      <listitem>
	        <para>
	          Full path to device to use in place of default.	  
		</para>
	      </listitem>
	    </varlistentry>
	  </variablelist>
	</refsect1>

	<refsect1>
	  <title>Returns</title>
	  <variablelist>
	    <varlistentry>
	      <listitem>
	        <para>
		  0 on success, -1 on failure
		</para>
              </listitem>
	    </varlistentry>
	  </variablelist>
	</refsect1>

	<refsect1>
	  <title>Description</title>
	  <para>
	    This function sets the framebuffer device to use in place of the
	    default. Note: this does not mean multihead support, it simply
	    allows you to use an alternate device (eg, /dev/fb1).
	  </para>
	</refsect1>
      </refentry>

      <refentry>
        <refmeta>
	  <refentrytitle>
	    <phrase id="API-fb-handle-signals">
	      fb_handle_signals
	    </phrase>
	  </refentrytitle>
	</refmeta>

	<refnamediv>
	  <refname>fb_handle_signals</refname>
	  <refpurpose>
	    Intercepts signals.
	  </refpurpose>
	</refnamediv>

        <refsynopsisdiv>
	  <title>Synopsis</title>
	  <funcsynopsis>
	    <funcdef>void <function>fb_handle_signals</function></funcdef>
	    <paramdef></paramdef>
	  </funcsynopsis>
	</refsynopsisdiv>

	<refsect1>
	  <title>Arguments</title>
	  <variablelist>
	    <varlistentry>
	      <listitem>
	        <para>
		  None
		</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 intercepts any signals we recieve, (SIGINT and
	    SIGSEGV by default). This allows us to restore the framebuffer
	    device when one of these signals is sent to our program,
	    otherwise the device remains in use.
	  </para>
	</refsect1>
      </refentry>

      <refentry>
        <refmeta>
	  <refentrytitle>
	    <phrase id="API-fb-fill-rect">
	      fb_fill_rect
	    </phrase>
	  </refentrytitle>
	</refmeta>

	<refnamediv>
	  <refname>fb_fill_rect</refname>
	  <refpurpose>
	    Fills a rectangle.
	  </refpurpose>
	</refnamediv>

        <refsynopsisdiv>
	  <title>Synopsis</title>
	  <funcsynopsis>
	    <funcdef>void <function>fb_cleanup</function></funcdef>
	    <paramdef>int <parameter>x</parameter></paramdef>
	    <paramdef>int <parameter>y</parameter></paramdef>
	    <paramdef>int <parameter>w</parameter></paramdef>
	    <paramdef>int <parameter>h</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 coordinate
		</para>
              </listitem>
	    </varlistentry>
	    <varlistentry>
	      <term>
	        <parameter>y</parameter>
	      </term>
	      <listitem>
	        <para>
		  y coordinate
		</para>
              </listitem>
	    </varlistentry>
	    <varlistentry>
	      <term>
	        <parameter>w</parameter>
              </term>
	      <listitem>
	        <para>
		  width of rectangle
		</para>
              </listitem>
	    </varlistentry>
	    <varlistentry>
	      <term>
	        <parameter>h</parameter>
	      </term>
	      <listitem>
	        <para>
		  height of rectangle
		</para>
	      </listitem>
	    </varlistentry>
	    <varlistentry>
	      <term>
	        <parameter>r</parameter>
	      </term>
	      <listitem>
	        <para>
		  red value
		</para>
	      </listitem>
	    </varlistentry>
	    <varlistentry>
	      <term>
	        <parameter>g</parameter>
	      </term>
	      <listitem>
	        <para>
		  green value
		</para>
	      </listitem>
	    </varlistentry>
	    <varlistentry>
	      <term>
	        <parameter>b</parameter>
	      </term>
	      <listitem>
	        <para>
		  blue value
		</para>
	      </listitem>
	    </varlistentry>
	    <varlistentry>
	      <term>
	        <parameter>surface</parameter>
              </term>
	      <listitem>
	        <para>
		  surface to draw 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 fills a rectangle of specified size at specified
	    coordinates on specified surface with specified rgb values.
	  </para>
	</refsect1>
      </refentry>