xref: /aosp_15_r20/external/libvpx/usage_cx.dox (revision fb1b10ab9aebc7c7068eedab379b749d7e3900be)
1*fb1b10abSAndroid Build Coastguard Worker/*! \page usage_encode Encoding
2*fb1b10abSAndroid Build Coastguard Worker
3*fb1b10abSAndroid Build Coastguard Worker    The vpx_codec_encode() function is at the core of the encode loop. It
4*fb1b10abSAndroid Build Coastguard Worker    processes raw images passed by the application, producing packets of
5*fb1b10abSAndroid Build Coastguard Worker    compressed data. The <code>deadline</code> parameter controls the amount
6*fb1b10abSAndroid Build Coastguard Worker    of time in microseconds the encoder should spend working on the frame. For
7*fb1b10abSAndroid Build Coastguard Worker    more information on the <code>deadline</code> parameter, see
8*fb1b10abSAndroid Build Coastguard Worker    \ref usage_deadline.
9*fb1b10abSAndroid Build Coastguard Worker
10*fb1b10abSAndroid Build Coastguard Worker
11*fb1b10abSAndroid Build Coastguard Worker    \if samples
12*fb1b10abSAndroid Build Coastguard Worker    \ref samples
13*fb1b10abSAndroid Build Coastguard Worker    \endif
14*fb1b10abSAndroid Build Coastguard Worker
15*fb1b10abSAndroid Build Coastguard Worker*/
16