summaryrefslogtreecommitdiff
path: root/libavutil/frame.h
diff options
context:
space:
mode:
authorLuca Barbato <lu_zero@gentoo.org>2014-01-16 01:04:35 +0100
committerLuca Barbato <lu_zero@gentoo.org>2014-01-17 10:00:18 +0100
commitff23c4e4935e96e62d8ff2212a1955a43add88e1 (patch)
treea77096e8c9648ba0d9b47255257d136b9334cb69 /libavutil/frame.h
parent87acd33c092ab9e7d73686627e9105d99c1e4928 (diff)
doxy: Add AVFrame to the structured modules
Diffstat (limited to 'libavutil/frame.h')
-rw-r--r--libavutil/frame.h19
1 files changed, 19 insertions, 0 deletions
diff --git a/libavutil/frame.h b/libavutil/frame.h
index 07d87e33d5..e3a6b0ff27 100644
--- a/libavutil/frame.h
+++ b/libavutil/frame.h
@@ -17,6 +17,12 @@
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
+/**
+ * @file
+ * @ingroup lavu_frame
+ * reference-counted frame API
+ */
+
#ifndef AVUTIL_FRAME_H
#define AVUTIL_FRAME_H
@@ -29,6 +35,15 @@
#include "samplefmt.h"
#include "version.h"
+
+/**
+ * @defgroup lavu_frame AVFrame
+ * @ingroup lavu_data
+ *
+ * @{
+ * AVFrame is an abstraction for reference-counted raw multimedia data.
+ */
+
enum AVFrameSideDataType {
/**
* The data is the AVPanScan struct defined in libavcodec.
@@ -515,4 +530,8 @@ AVFrameSideData *av_frame_new_side_data(AVFrame *frame,
AVFrameSideData *av_frame_get_side_data(const AVFrame *frame,
enum AVFrameSideDataType type);
+/**
+ * @}
+ */
+
#endif /* AVUTIL_FRAME_H */