summaryrefslogtreecommitdiffstats
path: root/src/multimediaquick/camerafocus.qdoc
blob: 5fce6b6450caf469e736d2d6d64d7295b41e9412 (plain)
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
/****************************************************************************
**
** Copyright (C) 2021 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the plugins of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

QT_BEGIN_NAMESPACE

/*!
    \qmltype Camera
    \instantiates QCamera
    \inqmlmodule QtMultimedia
    \brief An interface for camera settings related to focus and zoom.
    \ingroup multimedia_qml
    \ingroup camera_qml

    This type allows control over manual and automatic
    focus settings, including information about any parts of the
    camera frame that are selected for auto focusing.

    It should not be constructed separately, instead the
    \c focus property of a \l Camera should be used.

    \qml

    Item {
        width: 640
        height: 360

        CaptureSession {
            camera: Camera {
                id: camera

                focusMode: Camera.FocusModeAutoNear
                customFocusPoint: Qt.point(0.2, 0.2) // Focus relative to top-left corner
            }
            videoOutput: videoOutput
        }

        VideoOutput {
            id: videoOutput
            anchors.fill: parent
        }
    }

    \endqml
*/

/*!
    \qmlproperty enumeration CameraFocus::focusMode

    This property holds the current camera focus mode.

    \note In automatic focusing modes, the \l focusPoint property provides
    information and control over the area of the image that is being focused.

      \value FocusModeAuto Continuous auto focus mode.
      \value FocusModeAutoNear Continuous auto focus, preferring objects near to
      the camera.
      \value FocusModeAutoFar Continuous auto focus, preferring objects far away
      from the camera.
      \value FocusModeHyperfocal Focus to hyperfocal distance, with the maximum
      depth of field achieved. All objects at distances from half of this
      distance out to infinity will be acceptably sharp.
      \value FocusModeInfinity Focus strictly to infinity.
      \value FocusModeManual Manual or fixed focus mode.
*/

/*!
    \qmlproperty list<FocusMode> CameraFocus::supportedFocusMode

    This property holds the supported focus modes of the camera.

    \since 5.11
    \sa focusMode
*/

/*!
  \qmlproperty point QtMultimedia::CameraFocus::customFocusPoint

  This property holds the position of custom focus point, in relative frame
  coordinates. This means that QPointF(0,0) points to the top-left corner
  of the frame, and QPointF(0.5,0.5) points to the center of the frame.

  Custom focus point is used only in \c FocusPointCustom focus mode.
*/

/*!
    \qmlproperty real QtMultimedia::CameraFocus::minimumZoomFactor

    This property holds the minimum zoom factor supported.
*/

/*!
    \qmlproperty real QtMultimedia::CameraFocus::maximumZoomFactor

    This property holds the maximum zoom factor supported, or \c 1.0 if zooming
    is not supported.
*/