5 * Copyright (c) 2018 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
22 #include <dali/public-api/actors/actor.h>
23 #include <dali/public-api/signals/dali-signal.h>
24 #include <dali/public-api/actors/camera-actor.h>
27 #include <dali/public-api/dali-adaptor-common.h>
33 * @addtogroup dali_adaptor_framework
37 namespace Internal DALI_INTERNAL
46 * @brief Capture snapshots the current scene and save as a file.
50 * Applications should follow the example below to create capture :
53 * Capture capture = Capture::New();
56 * If required, you can also connect class member function to a signal :
59 * capture.FinishedSignal().Connect(this, &CaptureSceneExample::OnCaptureFinished);
62 * At the connected class member function, you can know whether capture finish state.
65 * void CaptureSceneExample::OnCaptureFinished( Capture capture, Capture::FinishState state )
67 * if ( state == Capture::FinishState::SUCCEEDED )
78 class DALI_ADAPTOR_API Capture : public BaseHandle
84 * @brief The enumerations used for checking capture success
87 enum class FinishState
89 SUCCEEDED, ///< Succeeded in saving the result after capture
90 FAILED ///< Failed to capture by time out or to save the result
94 * @brief Typedef for finished signals sent by this class.
98 typedef Signal< void ( Capture, Capture::FinishState ) > CaptureFinishedSignalType;
101 * @brief Create an uninitialized Capture; this can be initialized with Actor::New().
105 * Calling member functions with an uninitialized Dali::Object is not allowed.
110 * @brief Create an initialized Capture.
114 * @return A handle to a newly allocated Dali resource.
115 * @note Projection mode of default cameraActor is Dali::Camera::PERSPECTIVE_PROJECTION
117 static Capture New();
120 * @brief Create an initialized Capture.
124 * @param[in] cameraActor An initialized CameraActor.
125 * @return A handle to a newly allocated Dali resource.
127 static Capture New( Dali::CameraActor cameraActor );
130 * @brief Downcast an Object handle to Capture handle.
134 * If handle points to a Capture object the downcast produces valid
135 * handle. If not the returned handle is left uninitialized.
137 * @param[in] handle to An object.
138 * @return handle to a Capture object or an uninitialized handle.
140 static Capture DownCast( BaseHandle handle );
143 * @brief Dali::Actor is intended as a base class.
147 * This is non-virtual since derived Handle types must not contain data or virtual methods.
152 * @brief This copy constructor is required for (smart) pointer semantics.
156 * @param[in] copy A reference to the copied handle.
158 Capture( const Capture& copy );
161 * @brief This assignment operator is required for (smart) pointer semantics.
165 * @param[in] rhs A reference to the copied handle.
166 * @return A reference to this.
168 Capture& operator=( const Capture& rhs );
171 * @brief Start capture and save the image as a file.
175 * @param[in] source source actor to be used for capture.
176 * @param[in] size captured size.
177 * @param[in] path image file path to be saved as a file.
178 * @param[in] clearColor background color of captured scene
180 void Start( Actor source, const Vector2& size, const std::string &path, const Vector4& clearColor );
183 * @brief Start capture and save the image as a file.
187 * @param[in] source source actor to be used for capture.
188 * @param[in] size captured size.
189 * @param[in] path image file path to be saved as a file.
190 * @note Clear color is transparent.
192 void Start( Actor source, const Vector2& size, const std::string &path );
195 * @brief Get finished signal.
199 * @return finished signal instance.
201 CaptureFinishedSignalType& FinishedSignal();
203 public: // Not intended for application developers
206 * @brief This constructor is used by New() methods.
210 * @param[in] internal A pointer to a newly allocated Dali resource.
212 explicit DALI_INTERNAL Capture( Internal::Adaptor::Capture* internal );
222 #endif // DALI_CAPTURE_H