OpenShot Library | libopenshot
0.4.0
|
Go to the documentation of this file.
13 #ifndef OPENSHOT_MASK_EFFECT_H
14 #define OPENSHOT_MASK_EFFECT_H
16 #include "../EffectBase.h"
19 #include "../KeyFrame.h"
40 std::shared_ptr<QImage> original_mask;
44 void init_effect_details();
69 std::shared_ptr<openshot::Frame>
GetFrame(int64_t frame_number)
override {
return GetFrame(std::make_shared<openshot::Frame>(), frame_number); }
80 std::shared_ptr<openshot::Frame>
GetFrame(std::shared_ptr<openshot::Frame> frame, int64_t frame_number)
override;
83 std::string
Json()
const override;
84 void SetJson(
const std::string value)
override;
90 std::string
PropertiesJSON(int64_t requested_frame)
const override;
void Reader(ReaderBase *new_reader)
Set a new reader to be used by the mask effect (grayscale image)
Json::Value JsonValue() const override
Generate Json::Value for this object.
This abstract class is the base class, used by all effects in libopenshot.
This class uses the image libraries to apply alpha (or transparency) masks to any frame....
This namespace is the default namespace for all code in the openshot library.
std::shared_ptr< openshot::Frame > GetFrame(int64_t frame_number) override
This method is required for all derived classes of ClipBase, and returns a new openshot::Frame object...
Keyframe contrast
Contrast keyframe to control the hardness of the wipe effect / mask.
Mask()
Blank constructor, useful when using Json to load the effect properties.
std::string PropertiesJSON(int64_t requested_frame) const override
A Keyframe is a collection of Point instances, which is used to vary a number or property over time.
bool replace_image
Replace the frame image with a grayscale image representing the mask. Great for debugging a mask.
std::string Json() const override
Generate JSON string of this object.
This abstract class is the base class, used by all readers in libopenshot.
ReaderBase * Reader()
Get the reader object of the mask grayscale image.
void SetJson(const std::string value) override
Load JSON string into this object.
Keyframe brightness
Brightness keyframe to control the wipe / mask effect. A constant value here will prevent animation.
void SetJsonValue(const Json::Value root) override
Load Json::Value into this object.