libfbx-api.sgml

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

            <funcdef>void <function>fb_set_viewport</function></funcdef>
            <paramdef>float <parameter>angle</parameter></paramdef>
            <paramdef>int <parameter>width</parameter></paramdef>
            <paramdef>int <parameter>height</parameter></paramdef>
          </funcsynopsis>
        </refsynopsisdiv>
        <refsect1>
	  <title>Arguments</title>
	  <variablelist>
	    <varlistentry>
	      <term>
	        <parameter>angle</parameter>
	      </term>
	      <listitem>
	        <para>Viewing angle of the 3D camera in degrees.</para>
	      </listitem>
	    </varlistentry>
	    <varlistentry>
	      <term>
	        <parameter>width</parameter>
	      </term>
	      <listitem>
	        <para>
		   width of viewport to create
	        </para>
	      </listitem>
	    </varlistentry>
	    <varlistentry>
	      <term>
	        <parameter>height</parameter>
	      </term>
	      <listitem>
	        <para>
	  	  height of viewport to create
                </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 sets the viewing angle used for projections done by the 3D projection routines.
	  </para>
	</refsect1>
       </refentry>

      <refentry>
        <refmeta>
          <refentrytitle>
            <phrase id="API-fb-putpixel-3d">
		fb_putpixel_3d
            </phrase>
          </refentrytitle>
        </refmeta>

        <refnamediv>
          <refname>fb_putpixel_3d</refname>
          <refpurpose>
	    Plots a pixel in 3D space.
          </refpurpose>
        </refnamediv>

        <refsynopsisdiv>
          <title>Synopsis</title>
          <funcsynopsis>
            <funcdef>void <function>fb_putpixel_3d</function></funcdef>
            <paramdef>float <parameter>x</parameter></paramdef>
            <paramdef>float <parameter>y</parameter></paramdef>
            <paramdef>float <parameter>z</parameter></paramdef>
            <paramdef>int <parameter>r</parameter></paramdef>
            <paramdef>int <parameter>g</parameter></paramdef>
            <paramdef>int <parameter>b</parameter></paramdef>
            <paramdef>fbsurface *<parameter>surface</parameter></paramdef>
         </funcsynopsis>
        </refsynopsisdiv>

        <refsect1>
          <title>Arguments</title>
          <variablelist>
            <varlistentry>
	      <term>
		<parameter>x</parameter>
	      </term>
              <listitem>
                <para>
		  X position of pixel.
                </para>
              </listitem>
	    </varlistentry>
	    <varlistentry>
	      <term>
		<parameter>y</parameter>
	      </term>
              <listitem>
                <para>
		  Y position of pixel.
                </para>
              </listitem>
	    </varlistentry>
	    <varlistentry>
	      <term>
		<parameter>z</parameter>
	      </term>
              <listitem>
                <para>
		  Z position of pixel.
                </para>
              </listitem>
	    </varlistentry>
	    <varlistentry>
	      <term>
		<parameter>r</parameter>
	      </term>
              <listitem>
                <para>
		  Red color value of pixel.
                </para>
              </listitem>
	    </varlistentry>
	    <varlistentry>
	      <term>
		<parameter>g</parameter>
	      </term>
              <listitem>
                <para>
		  Green color value of pixel.
                </para>
              </listitem>
	    </varlistentry>
	    <varlistentry>
	      <term>
		<parameter>b</parameter>
	      </term>
              <listitem>
                <para>
		  Blue color value of pixel.
                </para>
              </listitem>
	    </varlistentry>
	    <varlistentry>
	      <term>
		<parameter>surface</parameter>
	      </term>
              <listitem>
                <para>
		  Surface to put pixel onto.
                </para>
              </listitem>
            </varlistentry>
          </variablelist>
        </refsect1>

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

        <refsect1>
          <title>Description</title>
          <para>
	    Plots a pixel in 3d space with rgb values on surface.
          </para>
        </refsect1>
      </refentry>
    </sect1>
  </chapter>
  <chapter id="blit-functions">
    <title>Blit Functions</title>
    <sect1>
      <refentry>
        <refmeta>
          <refentrytitle>
            <phrase id="API-fb-draw-image">
              fb_draw_image
            </phrase>
          </refentrytitle>
        </refmeta>

        <refnamediv>
          <refname>fb_draw_image</refname>
          <refpurpose>
            Draws a surface to another surface.
          </refpurpose>
        </refnamediv>

        <refsynopsisdiv>
          <title>Synopsis</title>
          <funcsynopsis>
            <funcdef>void <function>fb_draw_image</function></funcdef>
            <paramdef>fb_surface *<parameter>src</parameter></paramdef>
            <paramdef>fb_surface *<parameter>dest</parameter></paramdef>
            <paramdef>int <parameter>x</parameter></paramdef>
            <paramdef>int <parameter>y</parameter></paramdef>
          </funcsynopsis>
        </refsynopsisdiv>
        <refsect1>
          <title>Arguments</title>
          <variablelist>
            <varlistentry>
              <term>
                <parameter>src</parameter>
              </term>
              <listitem>
                <para>
                  Surface to draw from.
                </para>
              </listitem>
	    </varlistentry>
	    <varlistentry>
              <term>
                <parameter>dest</parameter>
              </term>
              <listitem>
                <para>
                  Surface to draw to.
                </para>
              </listitem>
	    </varlistentry>
	    <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>
          </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 surface to another surface.
          </para>
        </refsect1>
      </refentry>
      <refentry>
        <refmeta>
          <refentrytitle>
            <phrase id="API-fb-put-linux-logo">
              fb_put_linux_logo
            </phrase>
          </refentrytitle>
        </refmeta>

        <refnamediv>
          <refname>fb_put_linux_logo</refname>
          <refpurpose>
            Displays an image on destination surface.
          </refpurpose>
        </refnamediv>

        <refsynopsisdiv>
          <title>Synopsis</title>
          <funcsynopsis>
            <funcdef>void <function>fb_put_linux_logo</function></funcdef>
            <paramdef>int <parameter>xpos</parameter></paramdef>
            <paramdef>int <parameter>ypos</parameter></paramdef>
            <paramdef>int <parameter>width</parameter></paramdef>
            <paramdef>int <parameter>height</parameter></paramdef>
            <paramdef>unsigned char <parameter>data</parameter>[]</paramdef>
            <paramdef>unsigned char <parameter>red_map</parameter>[]</paramdef>
            <paramdef>unsigned char <parameter>green_map</parameter>[]</paramdef>
            <paramdef>unsigned char <parameter>blue_map</parameter>[]</paramdef>
            <paramdef>fb_surface *<parameter>destination</parameter></paramdef>
          </funcsynopsis>
        </refsynopsisdiv>
        <refsect1>
          <title>Arguments</title>
          <variablelist>
            <varlistentry>
              <term>
                <parameter>xpos</parameter>
              </term>
              <listitem>
                <para>
                  x positioner
                </para>
              </listitem>
	    </varlistentry>
	    <varlistentry>
              <term>
                <parameter>ypos</parameter>
              </term>
              <listitem>
                <para>
                  y positioner
                </para>
              </listitem>
	    </varlistentry>
	    <varlistentry>
              <term>
                <parameter>width</parameter>
              </term>
              <listitem>
                <para>
                  Width of image
                </para>
              </listitem>
	    </varlistentry>
	    <varlistentry>
              <term>
                <parameter>height</parameter>
              </term>
              <listitem>
                <para>
                  Height of image
                </para>
              </listitem>
	    </varlistentry>
	    <varlistentry>
              <term>
                <parameter>data</parameter>
              </term>
              <listitem>
                <para>
                  Image data
                </para>
              </listitem>
	    </varlistentry>
	    <varlistentry>
              <term>
                <parameter>red_map</parameter>
              </term>
              <listitem>
                <para>
                  Red colormap values
                </para>
              </listitem>
	    </varlistentry>
	    <varlistentry>
              <term>
                <parameter>green_map</parameter>
              </term>
              <listitem>
                <para>
                  Green colormap values
                </para>
              </listitem>
	    </varlistentry>
	    <varlistentry>
              <term>
                <parameter>blue_map</parameter>
              </term>
              <listitem>
                <para>
                  Blue colormap values
                </para>
              </listitem>
	    </varlistentry>
	    <varlistentry>
              <term>
                <parameter>destination</parameter>
              </term>
              <listitem>
                <para>
                  Destination surface of image
                </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 displays an image to destination surface at specified x, y position.
          </para>
        </refsect1>
      </refentry>
    </sect1>
  </chapter>
  <chapter id="pixel-functions">
    <title>Pixel Functions</title>
    <sect1>
      <refentry>
        <refmeta>
          <refentrytitle>
            <phrase id="API-fb-putpixel">
              fb_putpixel
            </phrase>
          </refentrytitle>
        </refmeta>

        <refnamediv>
          <refname>fb_putpixel</refname>
          <refpurpose>
            Draws a pixel.
          </refpurpose>
        </refnamediv>

        <refsynopsisdiv>
          <title>Synopsis</title>
          <funcsynopsis>
            <funcdef>void <function>fb_putpixel</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>