libfbx-api.sgml

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

    </sect1>
  </chapter>
  <chapter id="surface-functions">
    <title>Surface functions</title>
    <sect1>
      <refentry>
        <refmeta>
	  <refentrytitle>
	    <phrase id="API-fb-cls">
	      fb_scls
	    </phrase>
	  </refentrytitle>
	</refmeta>

	<refnamediv>
	  <refname>fb_scls</refname>
	  <refpurpose>
	    Clears surface.
	  </refpurpose>
	</refnamediv>

        <refsynopsisdiv>
	  <title>Synopsis</title>
	  <funcsynopsis>
	    <funcdef>inline void <function>fb_scls</function></funcdef>
	    <paramdef>fb_surface *<parameter>surface</parameter></paramdef>
	  </funcsynopsis>
	</refsynopsisdiv>

	<refsect1>
	  <title>Arguments</title>
	  <variablelist>
	    <varlistentry>
	      <term>
	        <parameter>surface</parameter>
	      </term>
	      <listitem>
	        <para>
		  Surface to clear
		</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 functions clears the specified surface.
	  </para>
	</refsect1>
      </refentry>

      <refentry>
        <refmeta>
	  <refentrytitle>
	    <phrase id="API-fb-create-surface">
	      fb_create_surface
	    </phrase>
	  </refentrytitle>
	</refmeta>

	<refnamediv>
	  <refname>fb_create_surface</refname>
	  <refpurpose>
	    Creates a surface.
	  </refpurpose>
	</refnamediv>

        <refsynopsisdiv>
	  <title>Synopsis</title>
	  <funcsynopsis>
	    <funcdef>fb_surface *<function>fb_create_surface</function></funcdef>
	    <paramdef>int <parameter>width</parameter></paramdef>
	    <paramdef>int <parameter>height</parameter></paramdef>
	  </funcsynopsis>
	</refsynopsisdiv>

	<refsect1>
	  <title>Arguments</title>
	  <variablelist>
	    <varlistentry>
	      <term>
	        <parameter>width</parameter>
	      </term>
	      <listitem>
	        <para>
		  width of surface to create
		</para>
	      </listitem>
	    </varlistentry>
	    <varlistentry>
	      <term>
	        <parameter>height</parameter>
	      </term>
	      <listitem>
	        <para>
		  height of surface to create
		</para>
	      </listitem>
	    </varlistentry>
	  </variablelist>
	</refsect1>

	<refsect1>
	  <title>Returns</title>
	  <variablelist>
	    <varlistentry>
	      <listitem>
	        <para>
		  An fb_surface pointer to the newly created surface.
		</para>
              </listitem>
	    </varlistentry>
	  </variablelist>
	</refsect1>

	<refsect1>
	  <title>Description</title>
	  <para>
	    This function creates a new surface in system memory with the specified width and height.
	  </para>
	</refsect1>
      </refentry>

      <refentry>
        <refmeta>
	  <refentrytitle>
	    <phrase id="API-fb-destroy-surface">
	      fb_destroy_surface
	    </phrase>
	  </refentrytitle>
	</refmeta>

	<refnamediv>
	  <refname>fb_destroy_surface</refname>
	  <refpurpose>
	    Destroys a surface.
	  </refpurpose>
	</refnamediv>

        <refsynopsisdiv>
	  <title>Synopsis</title>
	  <funcsynopsis>
	    <funcdef>void <function>fb_destroy_surface</function></funcdef>
	    <paramdef>fb_surface *<parameter>surface</parameter></paramdef>
	  </funcsynopsis>
	</refsynopsisdiv>

	<refsect1>
	  <title>Arguments</title>
	  <variablelist>
	    <varlistentry>
	      <term>
	        <parameter>surface</parameter>
	      </term>
	      <listitem>
	        <para>
		  surface to destroy
		</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 destroys the specified surface.
	  </para>
	</refsect1>
      </refentry>
    </sect1>
  </chapter>
  <chapter id="2d-functions">
    <title>2D Functions</title>
    <sect1>
      <refentry>
        <refmeta>
          <refentrytitle>
            <phrase id="API-fb-move-object">
              fb_move_object
            </phrase>
          </refentrytitle>
        </refmeta>

        <refnamediv>
          <refname>fb_move_object</refname>
          <refpurpose>
            Moves a vector along a 2D plane.
          </refpurpose>
        </refnamediv>

        <refsynopsisdiv>
          <title>Synopsis</title>
          <funcsynopsis>
            <funcdef>void <function>fb_move_object</function></funcdef>
            <paramdef>float <parameter>speed</parameter></paramdef>
            <paramdef>float <parameter>radian</parameter></paramdef>
            <paramdef>float <parameter>*x</parameter></paramdef>
            <paramdef>float <parameter>*y</parameter></paramdef>
          </funcsynopsis>
        </refsynopsisdiv>
        <refsect1>
          <title>Arguments</title>
          <variablelist>
            <varlistentry>
              <term>
                <parameter>speed</parameter>
              </term>
              <listitem>
                <para>
                  Speed to move at.
                </para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>
                <parameter>radian</parameter>
              </term>
              <listitem>
                <para>
                  Radians
                </para>
              </listitem>
            </varlistentry>
            <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>
          </variablelist>
        </refsect1>
        <refsect1>
          <title>Returns</title>
          <variablelist>
            <varlistentry>
              <listitem>
                <para>
                  None
                </para>
              </listitem>
            </varlistentry>
          </variablelist>
        </refsect1>
        <refsect1>
          <title>Description</title>
          <para>
            This function moves a vector along a 2D plane.
          </para>
        </refsect1>
      </refentry>
      <refentry>
        <refmeta>
          <refentrytitle>
            <phrase id="API-fb-get-angle">
              fb_get_angle
            </phrase>
          </refentrytitle>
        </refmeta>

        <refnamediv>
          <refname>fb_get_angle</refname>
          <refpurpose>
	    Determins an angle.
          </refpurpose>
        </refnamediv>

        <refsynopsisdiv>
          <title>Synopsis</title>
          <funcsynopsis>
            <funcdef>float <function>fb_get_angle</function></funcdef>
            <paramdef>float <parameter>x1</parameter></paramdef>
            <paramdef>float <parameter>y1</parameter></paramdef>
            <paramdef>float <parameter>x2</parameter></paramdef>
            <paramdef>float <parameter>y2</parameter></paramdef>
          </funcsynopsis>
        </refsynopsisdiv>
        <refsect1>
          <title>Arguments</title>
          <variablelist>
            <varlistentry>
              <term>
                <parameter>x1</parameter>
              </term>
              <listitem>
                <para>
                  First X coordinate
                </para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>
                <parameter>y1</parameter>
              </term>
              <listitem>
                <para>
                  First Y coordinate
                </para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>
                <parameter>x2</parameter>
              </term>
              <listitem>
                <para>
                  Second X coordinate
                </para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>
                <parameter>y2</parameter>
              </term>
              <listitem>
                <para>
                  Second Y coordinate
                </para>
              </listitem>
            </varlistentry>
          </variablelist>
        </refsect1>
        <refsect1>
          <title>Returns</title>
          <variablelist>
            <varlistentry>
              <listitem>
                <para>
                  Angle
                </para>
              </listitem>
            </varlistentry>
          </variablelist>
        </refsect1>
        <refsect1>
          <title>Description</title>
          <para>
            This function measures angle between first and second x and y points.
          </para>
        </refsect1>
      </refentry>
      <refentry>
        <refmeta>
          <refentrytitle>
            <phrase id="API-fb-get-rad">
              fb_get_rad
            </phrase>
          </refentrytitle>
        </refmeta>

        <refnamediv>
          <refname>fb_get_rad</refname>
          <refpurpose>
            Determines a radian.
          </refpurpose>
        </refnamediv>

        <refsynopsisdiv>
          <title>Synopsis</title>
          <funcsynopsis>
            <funcdef>float <function>fb_get_rad</function></funcdef>
            <paramdef>float <parameter>x1</parameter></paramdef>
            <paramdef>float <parameter>y1</parameter></paramdef>
            <paramdef>float <parameter>x2</parameter></paramdef>
            <paramdef>float <parameter>y2</parameter></paramdef>
          </funcsynopsis>
        </refsynopsisdiv>
        <refsect1>
          <title>Arguments</title>
          <variablelist>
            <varlistentry>
              <term>
                <parameter>x1</parameter>
              </term>
              <listitem>
                <para>
                  First X coordinate
                </para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>
                <parameter>y1</parameter>
              </term>
              <listitem>
                <para>
                  First Y coordinate
                </para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>
                <parameter>x2</parameter>
              </term>
              <listitem>
                <para>
                  Second X coordinate
                </para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>
                <parameter>y2</parameter>
              </term>
              <listitem>
                <para>
                  Second Y coordinate
                </para>
              </listitem>
            </varlistentry>
          </variablelist>
        </refsect1>
        <refsect1>
          <title>Returns</title>
          <variablelist>
            <varlistentry>
              <listitem>
                <para>
                  Radian from first to second point.
                </para>
              </listitem>
            </varlistentry>
          </variablelist>
        </refsect1>
        <refsect1>
          <title>Description</title>
          <para>
            This function determines a radian from two specific points.
          </para>
        </refsect1>
      </refentry>
    </sect1>
  </chapter>
  <chapter id="3d-functions">
    <title>3D Functions</title>
    <sect1>
      <refentry>
        <refmeta>
          <refentrytitle>
            <phrase id="API-fb-set-viewport">
              fb_set_viewport
            </phrase>
          </refentrytitle>
	</refmeta>
        <refnamediv>
          <refname>
            fb_set_viewport
          </refname>
          <refpurpose>
            Sets viewing angle.
          </refpurpose>
        </refnamediv>
        <refsynopsisdiv>
          <title>Synopsis</title>
          <funcsynopsis>