summaryrefslogtreecommitdiffstats
path: root/media/libvpx/libvpx/usage_cx.dox
diff options
context:
space:
mode:
Diffstat (limited to 'media/libvpx/libvpx/usage_cx.dox')
-rw-r--r--media/libvpx/libvpx/usage_cx.dox15
1 files changed, 15 insertions, 0 deletions
diff --git a/media/libvpx/libvpx/usage_cx.dox b/media/libvpx/libvpx/usage_cx.dox
new file mode 100644
index 0000000000..b2220cfdde
--- /dev/null
+++ b/media/libvpx/libvpx/usage_cx.dox
@@ -0,0 +1,15 @@
+/*! \page usage_encode Encoding
+
+ The vpx_codec_encode() function is at the core of the encode loop. It
+ processes raw images passed by the application, producing packets of
+ compressed data. The <code>deadline</code> parameter controls the amount
+ of time in microseconds the encoder should spend working on the frame. For
+ more information on the <code>deadline</code> parameter, see
+ \ref usage_deadline.
+
+
+ \if samples
+ \ref samples
+ \endif
+
+*/