OpenShot Library | libopenshot
0.2.5
|
This class adjusts the blur of an image, and can be animated with openshot::Keyframe curves over time. More...
#include <Blur.h>
Public Member Functions | |
Blur () | |
Blank constructor, useful when using Json to load the effect properties. More... | |
Blur (Keyframe new_horizontal_radius, Keyframe new_vertical_radius, Keyframe new_sigma, Keyframe new_iterations) | |
std::shared_ptr< Frame > | GetFrame (std::shared_ptr< Frame > frame, int64_t frame_number) |
This method is required for all derived classes of EffectBase, and returns a modified openshot::Frame object. More... | |
std::string | Json () const override |
Get and Set JSON methods. More... | |
Json::Value | JsonValue () const override |
Generate Json::Value for this object. More... | |
std::string | PropertiesJSON (int64_t requested_frame) const override |
void | SetJson (const std::string value) |
Load JSON string into this object. More... | |
void | SetJsonValue (const Json::Value root) |
Load Json::Value into this object. More... | |
![]() | |
int | constrain (int color_value) |
Constrain a color value from 0 to 255. More... | |
void | DisplayInfo () |
Display effect information in the standard output stream (stdout) More... | |
void | InitEffectInfo () |
Json::Value | JsonInfo () const |
Generate JSON object of meta data / info. More... | |
int | Order () const |
Get the order that this effect should be executed. More... | |
void | Order (int new_order) |
Set the order that this effect should be executed. More... | |
virtual | ~EffectBase ()=default |
![]() | |
ClipBase () | |
Constructor for the base clip. More... | |
void | Id (std::string value) |
Set basic properties. More... | |
bool | operator< (ClipBase &a) |
bool | operator<= (ClipBase &a) |
bool | operator> (ClipBase &a) |
bool | operator>= (ClipBase &a) |
virtual | ~ClipBase ()=default |
Public Attributes | |
Keyframe | horizontal_radius |
Horizontal blur radius keyframe. The size of the horizontal blur operation in pixels. More... | |
Keyframe | iterations |
Iterations keyframe. The # of blur iterations per pixel. 3 iterations = Gaussian. More... | |
Keyframe | sigma |
Sigma keyframe. The amount of spread in the blur operation. Should be larger than radius. More... | |
Keyframe | vertical_radius |
Vertical blur radius keyframe. The size of the vertical blur operation in pixels. More... | |
![]() | |
EffectInfoStruct | info |
Information about the current effect. More... | |
Additional Inherited Members | |
![]() | |
Json::Value | add_property_choice_json (std::string name, int value, int selected_value) const |
Generate JSON choice for a property (dropdown properties) More... | |
Json::Value | add_property_json (std::string name, float value, std::string type, std::string memo, const Keyframe *keyframe, float min_value, float max_value, bool readonly, int64_t requested_frame) const |
Generate JSON for a property. More... | |
![]() | |
float | end |
The position in seconds to end playing (used to trim the ending of a clip) More... | |
std::string | id |
ID Property for all derived Clip and Effect classes. More... | |
int | layer |
The layer this clip is on. Lower clips are covered up by higher clips. More... | |
float | position |
The position on the timeline where this clip should start playing. More... | |
std::string | previous_properties |
This string contains the previous JSON properties. More... | |
float | start |
The position in seconds to start playing (used to trim the beginning of a clip) More... | |
This class adjusts the blur of an image, and can be animated with openshot::Keyframe curves over time.
Adjusting the blur of an image over time can create many different powerful effects. To achieve a box blur effect, use identical horizontal and vertical blur values. To achieve a Gaussian blur, use 3 iterations, a sigma of 3.0, and a radius between 3 and X (depending on how much blur you want).
Blur::Blur | ( | ) |
Blur::Blur | ( | Keyframe | new_horizontal_radius, |
Keyframe | new_vertical_radius, | ||
Keyframe | new_sigma, | ||
Keyframe | new_iterations | ||
) |
Default constructor, which takes 1 curve. The curve adjusts the blur radius of a frame's image.
new_horizontal_radius | The curve to adjust the horizontal blur radius (between 0 and 100, rounded to int) |
new_vertical_radius | The curve to adjust the vertical blur radius (between 0 and 100, rounded to int) |
new_sigma | The curve to adjust the sigma amount (the size of the blur brush (between 0 and 100), float values accepted) |
new_iterations | The curve to adjust the # of iterations (between 1 and 100) |
|
virtual |
This method is required for all derived classes of EffectBase, and returns a modified openshot::Frame object.
The frame object is passed into this method, and a frame_number is passed in which tells the effect which settings to use from its keyframes (starting at 1).
frame | The frame object that needs the effect applied to it |
frame_number | The frame number (starting at 1) of the effect on the timeline. |
Implements openshot::EffectBase.
|
overridevirtual |
|
overridevirtual |
Generate Json::Value for this object.
Implements openshot::EffectBase.
Definition at line 179 of file Blur.cpp.
Referenced by Json().
|
overridevirtual |
Get all properties for a specific frame (perfect for a UI to display the current state of all properties at any time)
Implements openshot::ClipBase.
|
virtual |
Load JSON string into this object.
Implements openshot::EffectBase.
|
virtual |
Load Json::Value into this object.
Implements openshot::EffectBase.
Definition at line 211 of file Blur.cpp.
Referenced by SetJson().
Keyframe openshot::Blur::horizontal_radius |
Horizontal blur radius keyframe. The size of the horizontal blur operation in pixels.
Definition at line 75 of file Blur.h.
Referenced by GetFrame(), JsonValue(), PropertiesJSON(), and SetJsonValue().
Keyframe openshot::Blur::iterations |
Iterations keyframe. The # of blur iterations per pixel. 3 iterations = Gaussian.
Definition at line 78 of file Blur.h.
Referenced by GetFrame(), JsonValue(), PropertiesJSON(), and SetJsonValue().
Keyframe openshot::Blur::sigma |
Sigma keyframe. The amount of spread in the blur operation. Should be larger than radius.
Definition at line 77 of file Blur.h.
Referenced by GetFrame(), JsonValue(), PropertiesJSON(), and SetJsonValue().
Keyframe openshot::Blur::vertical_radius |
Vertical blur radius keyframe. The size of the vertical blur operation in pixels.
Definition at line 76 of file Blur.h.
Referenced by GetFrame(), JsonValue(), PropertiesJSON(), and SetJsonValue().