<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
[
  <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
  <!ENTITY % gtkdocentities SYSTEM "xml/gtkdocentities.ent">
  %gtkdocentities;
]>
<book id="index">
  <bookinfo>
    <title>&package_name; Reference Manual</title>
    <releaseinfo>
      <para>
        This document is the API reference for &package_name; &package_version;.
        The latest version can be found online at
        <ulink role="online-location" url="https://gnome.pages.gitlab.gnome.org/retro-gtk/">https://gnome.pages.gitlab.gnome.org/retro-gtk/</ulink>.
      </para>
      <para>
        If you find any issues in this API reference, please report it using
        <ulink type="http" url="&package_bugreport;">the bugtracker</ulink>.
      </para>
    </releaseinfo>

    <copyright>
      <year>2014-2020</year>
      <holder>Adrien Plazas</holder>
    </copyright>
  </bookinfo>

  <chapter id="overview">
    <title>&package_name; Overview</title>

    <para>
      &package_name;, the GTK Libretro frontend framework.
    </para>

    <para>
      <ulink type="http" url="https://www.libretro.com/">Libretro</ulink> is a
      plugin format design to implement video game console emulators, video
      games and similar multimedia software.
      Such plugins are called Libretro cores.
    </para>

    <para>
      &package_name; is a framework easing the use of Libretro cores in
      conjunction with
      <ulink type="http" url="https://www.gtk.org/">GTK</ulink>.
    </para>

    <para>
      It encourages the cores to be installed in a well defined centralized
      place — namely the <filename>libretro</filename> subdirectory of your
      <filename>lib</filename> directory — and it recommends them to come with
      Libretro core descriptors.
    </para>

    <xi:include href="libretro-core-descriptor.xml"/>
    <xi:include href="reference-test-case.xml"/>
  </chapter>

  <chapter id="core-api">
    <title>API Reference</title>
    <xi:include href="xml/retro-gtk-version.xml"/>

    <xi:include href="xml/retro-controller.xml"/>
    <xi:include href="xml/retro-controller-codes.xml"/>
    <xi:include href="xml/retro-controller-iterator.xml"/>
    <xi:include href="xml/retro-controller-type.xml"/>
    <xi:include href="xml/retro-core.xml"/>
    <xi:include href="xml/retro-log.xml"/>
    <xi:include href="xml/retro-core-descriptor.xml"/>
    <xi:include href="xml/retro-core-view.xml"/>
    <xi:include href="xml/retro-input.xml"/>
    <xi:include href="xml/retro-key-joypad-mapping.xml"/>
    <xi:include href="xml/retro-memory-type.xml"/>
    <xi:include href="xml/retro-module-iterator.xml"/>
    <xi:include href="xml/retro-module-query.xml"/>
    <xi:include href="xml/retro-option.xml"/>
    <xi:include href="xml/retro-option-iterator.xml"/>
    <xi:include href="xml/retro-pixdata.xml"/>
    <xi:include href="xml/retro-rumble-effect.xml"/>
    <xi:include href="xml/retro-video-filter.xml"/>
    <xi:include href="xml/retro-pixbuf.xml"/>
  </chapter>

  <chapter id="object-tree">
    <title>Object Hierarchy</title>
    <xi:include href="xml/tree_index.sgml"/>
  </chapter>

  <index id="api-index-full">
    <title>API Index</title>
    <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
  </index>

  <index id="deprecated-api-index" role="deprecated">
    <title>Index of Deprecated API</title>
    <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
  </index>

  <index id="annotations-glossary">
  <title>Annotations glossary</title>
  <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
  </index>

</book>
