/usr/share/qt5/doc/qtmultimedia/qcameraimageprocessing.html is in qtmultimedia5-doc-html 5.2.1-0ubuntu5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qcameraimageprocessing.cpp -->
<title>QCameraImageProcessing Class | QtMultimedia 5.2</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<ul>
<li>Qt 5.2</li>
<li><a href="qtmultimedia-index.html">Qt Multimedia</a></li>
<li><a href="qtmultimedia-module.html">C++ Classes</a></li>
<li>QCameraImageProcessing</li>
<li id="buildversion">
Qt 5.2.1 Reference Documentation</li>
</ul>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-types">Public Types</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QCameraImageProcessing Class</h1>
<!-- $$$QCameraImageProcessing-brief -->
<p>The QCameraImageProcessing class provides an interface for image processing related camera settings. <a href="#details">More...</a></p>
<!-- @@@QCameraImageProcessing -->
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> </b><tt><span class="preprocessor">#include <QCameraImageProcessing></span>
</tt></td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> <tt>QT += multimedia</tt></td></tr></table><ul>
<li><a href="qcameraimageprocessing-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2>Public Types</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qcameraimageprocessing.html#WhiteBalanceMode-enum">WhiteBalanceMode</a></b> { WhiteBalanceAuto, WhiteBalanceManual, WhiteBalanceSunlight, WhiteBalanceCloudy, ..., WhiteBalanceVendor }</td></tr>
</table>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qcameraimageprocessing.html#contrast">contrast</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qcameraimageprocessing.html#denoisingLevel">denoisingLevel</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qcameraimageprocessing.html#isAvailable">isAvailable</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qcameraimageprocessing.html#isWhiteBalanceModeSupported">isWhiteBalanceModeSupported</a></b>(WhiteBalanceMode<i> mode</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qcameraimageprocessing.html#manualWhiteBalance">manualWhiteBalance</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qcameraimageprocessing.html#saturation">saturation</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcameraimageprocessing.html#setContrast">setContrast</a></b>(qreal<i> value</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcameraimageprocessing.html#setDenoisingLevel">setDenoisingLevel</a></b>(qreal<i> level</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcameraimageprocessing.html#setManualWhiteBalance">setManualWhiteBalance</a></b>(qreal<i> colorTemperature</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcameraimageprocessing.html#setSaturation">setSaturation</a></b>(qreal<i> value</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcameraimageprocessing.html#setSharpeningLevel">setSharpeningLevel</a></b>(qreal<i> level</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcameraimageprocessing.html#setWhiteBalanceMode">setWhiteBalanceMode</a></b>(WhiteBalanceMode<i> mode</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qcameraimageprocessing.html#sharpeningLevel">sharpeningLevel</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> WhiteBalanceMode </td><td class="memItemRight bottomAlign"><b><a href="qcameraimageprocessing.html#whiteBalanceMode">whiteBalanceMode</a></b>() const</td></tr>
</table>
<a name="details"></a>
<!-- $$$QCameraImageProcessing-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QCameraImageProcessing class provides an interface for image processing related camera settings.</p>
<p>After capturing the data for a camera frame, the camera hardware and software performs various image processing tasks to produce a final image. This includes compensating for ambient light color, reducing noise, as well as making some other adjustments to the image.</p>
<p>You can retrieve this class from an instance of a <a href="qcamera.html">QCamera</a> object.</p>
<p>For example, you can set the white balance (or color temperature) used for processing images:</p>
<pre class="cpp">camera <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="qcamera.html">QCamera</a></span>;
<span class="type">QCameraImageProcessing</span> <span class="operator">*</span>imageProcessing <span class="operator">=</span> camera<span class="operator">-</span><span class="operator">></span>imageProcessing();
<span class="keyword">if</span> (imageProcessing<span class="operator">-</span><span class="operator">></span>isAvailable()) {
imageProcessing<span class="operator">-</span><span class="operator">></span>setWhiteBalanceMode(<span class="type">QCameraImageProcessing</span><span class="operator">::</span>WhiteBalanceFluorescent);
}</pre>
<p>Or adjust the amount of denoising performed:</p>
<pre class="cpp">imageProcessing<span class="operator">-</span><span class="operator">></span>setDenoisingLevel(<span class="operator">-</span><span class="number">0.3</span>); <span class="comment">//reduce the amount of denoising applied</span></pre>
<p>In some cases changing these settings may result in a longer delay before an image is ready.</p>
<p>For more information on image processing of camera frames, see <a href="cameraoverview.html#camera-image-processing">Camera Image Processing</a>.</p>
</div>
<p><b>See also </b><a href="qcameraimageprocessingcontrol.html">QCameraImageProcessingControl</a>.</p>
<!-- @@@QCameraImageProcessing -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$WhiteBalanceMode$$$WhiteBalanceAuto$$$WhiteBalanceManual$$$WhiteBalanceSunlight$$$WhiteBalanceCloudy$$$WhiteBalanceShade$$$WhiteBalanceTungsten$$$WhiteBalanceFluorescent$$$WhiteBalanceFlash$$$WhiteBalanceSunset$$$WhiteBalanceVendor -->
<h3 class="fn"><a name="WhiteBalanceMode-enum"></a>enum QCameraImageProcessing::<span class="name">WhiteBalanceMode</span></h3>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QCameraImageProcessing::WhiteBalanceAuto</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">Auto white balance mode.</td></tr>
<tr><td class="topAlign"><tt>QCameraImageProcessing::WhiteBalanceManual</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">Manual white balance. In this mode the white balance should be set with <a href="qcameraimageprocessing.html#setManualWhiteBalance">setManualWhiteBalance</a>()</td></tr>
<tr><td class="topAlign"><tt>QCameraImageProcessing::WhiteBalanceSunlight</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign">Sunlight white balance mode.</td></tr>
<tr><td class="topAlign"><tt>QCameraImageProcessing::WhiteBalanceCloudy</tt></td><td class="topAlign"><tt>3</tt></td><td class="topAlign">Cloudy white balance mode.</td></tr>
<tr><td class="topAlign"><tt>QCameraImageProcessing::WhiteBalanceShade</tt></td><td class="topAlign"><tt>4</tt></td><td class="topAlign">Shade white balance mode.</td></tr>
<tr><td class="topAlign"><tt>QCameraImageProcessing::WhiteBalanceTungsten</tt></td><td class="topAlign"><tt>5</tt></td><td class="topAlign">Tungsten (incandescent) white balance mode.</td></tr>
<tr><td class="topAlign"><tt>QCameraImageProcessing::WhiteBalanceFluorescent</tt></td><td class="topAlign"><tt>6</tt></td><td class="topAlign">Fluorescent white balance mode.</td></tr>
<tr><td class="topAlign"><tt>QCameraImageProcessing::WhiteBalanceFlash</tt></td><td class="topAlign"><tt>7</tt></td><td class="topAlign">Flash white balance mode.</td></tr>
<tr><td class="topAlign"><tt>QCameraImageProcessing::WhiteBalanceSunset</tt></td><td class="topAlign"><tt>8</tt></td><td class="topAlign">Sunset white balance mode.</td></tr>
<tr><td class="topAlign"><tt>QCameraImageProcessing::WhiteBalanceVendor</tt></td><td class="topAlign"><tt>1000</tt></td><td class="topAlign">Base value for vendor defined white balance modes.</td></tr>
</table>
<!-- @@@WhiteBalanceMode -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$contrast[overload1]$$$contrast -->
<h3 class="fn"><a name="contrast"></a><span class="type">qreal</span> QCameraImageProcessing::<span class="name">contrast</span>() const</h3>
<p>Returns the contrast adjustment setting.</p>
<p><b>See also </b><a href="qcameraimageprocessing.html#setContrast">setContrast</a>().</p>
<!-- @@@contrast -->
<!-- $$$denoisingLevel[overload1]$$$denoisingLevel -->
<h3 class="fn"><a name="denoisingLevel"></a><span class="type">qreal</span> QCameraImageProcessing::<span class="name">denoisingLevel</span>() const</h3>
<p>Returns the denoising adjustment level.</p>
<p><b>See also </b><a href="qcameraimageprocessing.html#setDenoisingLevel">setDenoisingLevel</a>().</p>
<!-- @@@denoisingLevel -->
<!-- $$$isAvailable[overload1]$$$isAvailable -->
<h3 class="fn"><a name="isAvailable"></a><span class="type">bool</span> QCameraImageProcessing::<span class="name">isAvailable</span>() const</h3>
<p>Returns true if image processing related settings are supported by this camera.</p>
<!-- @@@isAvailable -->
<!-- $$$isWhiteBalanceModeSupported[overload1]$$$isWhiteBalanceModeSupportedWhiteBalanceMode -->
<h3 class="fn"><a name="isWhiteBalanceModeSupported"></a><span class="type">bool</span> QCameraImageProcessing::<span class="name">isWhiteBalanceModeSupported</span>(<span class="type"><a href="qcameraimageprocessing.html#WhiteBalanceMode-enum">WhiteBalanceMode</a></span><i> mode</i>) const</h3>
<p>Returns true if the white balance <i>mode</i> is supported.</p>
<!-- @@@isWhiteBalanceModeSupported -->
<!-- $$$manualWhiteBalance[overload1]$$$manualWhiteBalance -->
<h3 class="fn"><a name="manualWhiteBalance"></a><span class="type">qreal</span> QCameraImageProcessing::<span class="name">manualWhiteBalance</span>() const</h3>
<p>Returns the current color temperature if the current white balance mode is <tt>WhiteBalanceManual</tt>. For other modes the return value is undefined.</p>
<p><b>See also </b><a href="qcameraimageprocessing.html#setManualWhiteBalance">setManualWhiteBalance</a>().</p>
<!-- @@@manualWhiteBalance -->
<!-- $$$saturation[overload1]$$$saturation -->
<h3 class="fn"><a name="saturation"></a><span class="type">qreal</span> QCameraImageProcessing::<span class="name">saturation</span>() const</h3>
<p>Returns the saturation adjustment value.</p>
<p><b>See also </b><a href="qcameraimageprocessing.html#setSaturation">setSaturation</a>().</p>
<!-- @@@saturation -->
<!-- $$$setContrast[overload1]$$$setContrastqreal -->
<h3 class="fn"><a name="setContrast"></a><span class="type">void</span> QCameraImageProcessing::<span class="name">setContrast</span>(<span class="type">qreal</span><i> value</i>)</h3>
<p>Set the contrast adjustment to <i>value</i>.</p>
<p>Valid contrast adjustment values range between -1.0 and 1.0, with a default of 0.</p>
<p><b>See also </b><a href="qcameraimageprocessing.html#contrast">contrast</a>().</p>
<!-- @@@setContrast -->
<!-- $$$setDenoisingLevel[overload1]$$$setDenoisingLevelqreal -->
<h3 class="fn"><a name="setDenoisingLevel"></a><span class="type">void</span> QCameraImageProcessing::<span class="name">setDenoisingLevel</span>(<span class="type">qreal</span><i> level</i>)</h3>
<p>Sets the denoising adjustment <i>level</i>.</p>
<p>Valid sharpening values range between -1.0 and 1.0, with a default of 0.</p>
<p>If the parameter value is set to 0, the amount of denoising applied is selected by camera and depends on camera capabilities and settings. Changing value in -1.0..1.0 range adjusts the amount of denoising applied within the supported range.</p>
<p><b>See also </b><a href="qcameraimageprocessing.html#denoisingLevel">denoisingLevel</a>().</p>
<!-- @@@setDenoisingLevel -->
<!-- $$$setManualWhiteBalance[overload1]$$$setManualWhiteBalanceqreal -->
<h3 class="fn"><a name="setManualWhiteBalance"></a><span class="type">void</span> QCameraImageProcessing::<span class="name">setManualWhiteBalance</span>(<span class="type">qreal</span><i> colorTemperature</i>)</h3>
<p>Sets manual white balance to <i>colorTemperature</i>. This is used when <a href="qcameraimageprocessing.html#whiteBalanceMode">whiteBalanceMode</a>() is set to <tt>WhiteBalanceManual</tt>. The units are Kelvin.</p>
<p><b>See also </b><a href="qcameraimageprocessing.html#manualWhiteBalance">manualWhiteBalance</a>().</p>
<!-- @@@setManualWhiteBalance -->
<!-- $$$setSaturation[overload1]$$$setSaturationqreal -->
<h3 class="fn"><a name="setSaturation"></a><span class="type">void</span> QCameraImageProcessing::<span class="name">setSaturation</span>(<span class="type">qreal</span><i> value</i>)</h3>
<p>Sets the saturation adjustment value to <i>value</i>.</p>
<p>Valid saturation values range between -1.0 and 1.0, with a default of 0.</p>
<p><b>See also </b><a href="qcameraimageprocessing.html#saturation">saturation</a>().</p>
<!-- @@@setSaturation -->
<!-- $$$setSharpeningLevel[overload1]$$$setSharpeningLevelqreal -->
<h3 class="fn"><a name="setSharpeningLevel"></a><span class="type">void</span> QCameraImageProcessing::<span class="name">setSharpeningLevel</span>(<span class="type">qreal</span><i> level</i>)</h3>
<p>Sets the sharpening adjustment <i>level</i>.</p>
<p>Valid sharpening values range between -1.0 and 1.0, with a default of 0.</p>
<p><b>See also </b><a href="qcameraimageprocessing.html#sharpeningLevel">sharpeningLevel</a>().</p>
<!-- @@@setSharpeningLevel -->
<!-- $$$setWhiteBalanceMode[overload1]$$$setWhiteBalanceModeWhiteBalanceMode -->
<h3 class="fn"><a name="setWhiteBalanceMode"></a><span class="type">void</span> QCameraImageProcessing::<span class="name">setWhiteBalanceMode</span>(<span class="type"><a href="qcameraimageprocessing.html#WhiteBalanceMode-enum">WhiteBalanceMode</a></span><i> mode</i>)</h3>
<p>Sets the white balance to <i>mode</i>.</p>
<p><b>See also </b><a href="qcameraimageprocessing.html#whiteBalanceMode">whiteBalanceMode</a>().</p>
<!-- @@@setWhiteBalanceMode -->
<!-- $$$sharpeningLevel[overload1]$$$sharpeningLevel -->
<h3 class="fn"><a name="sharpeningLevel"></a><span class="type">qreal</span> QCameraImageProcessing::<span class="name">sharpeningLevel</span>() const</h3>
<p>Returns the sharpening adjustment level.</p>
<p><b>See also </b><a href="qcameraimageprocessing.html#setSharpeningLevel">setSharpeningLevel</a>().</p>
<!-- @@@sharpeningLevel -->
<!-- $$$whiteBalanceMode[overload1]$$$whiteBalanceMode -->
<h3 class="fn"><a name="whiteBalanceMode"></a><span class="type"><a href="qcameraimageprocessing.html#WhiteBalanceMode-enum">WhiteBalanceMode</a></span> QCameraImageProcessing::<span class="name">whiteBalanceMode</span>() const</h3>
<p>Returns the white balance mode being used.</p>
<p><b>See also </b><a href="qcameraimageprocessing.html#setWhiteBalanceMode">setWhiteBalanceMode</a>().</p>
<!-- @@@whiteBalanceMode -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2013 Digia Plc and/or its
subsidiaries. Documentation contributions included herein are the copyrights of
their respective owners.<br> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br> Digia, Qt and their respective logos are trademarks of Digia Plc in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
|