summaryrefslogtreecommitdiff
path: root/va/va.h
diff options
context:
space:
mode:
authorGwenole Beauchesne <gwenole.beauchesne@intel.com>2011-11-18 12:52:29 +0000
committerXiang, Haihao <haihao.xiang@intel.com>2013-05-28 16:45:46 +0800
commitfff75a9b9ef28e074fa84eeb686bc47bfa509ca6 (patch)
treea04b29a2915ada3092e117ced0c9e1e365649a9a /va/va.h
parente5ddc84640103becad04aa0ab50e103ddf4fa583 (diff)
doc/encode: link modules from the main page.
Diffstat (limited to 'va/va.h')
-rw-r--r--va/va.h17
1 files changed, 17 insertions, 0 deletions
diff --git a/va/va.h b/va/va.h
index 3401878..0d4f7cc 100644
--- a/va/va.h
+++ b/va/va.h
@@ -85,6 +85,23 @@ extern "C" {
#endif
/**
+ * \mainpage Video Acceleration (VA) API
+ *
+ * \section intro Introduction
+ *
+ * The main motivation for VA-API (Video Acceleration API) is to
+ * enable hardware accelerated video decode and encode at various
+ * entry-points (VLD, IDCT, Motion Compensation etc.) for the
+ * prevailing coding standards today (MPEG-2, MPEG-4 ASP/H.263, MPEG-4
+ * AVC/H.264, VC-1/VMW3, and JPEG).
+ *
+ * VA-API is split into several modules:
+ * - \ref api_core
+ * - \ref api_enc_core
+ * - \ref api_enc_h264
+ */
+
+/**
* \defgroup api_core Core API
*
* @{