OpenShot Library | libopenshot  0.2.5
Public Member Functions | Public Attributes | List of all members
openshot::Saturation Class Reference

This class adjusts the saturation of color on a frame's image. More...

#include <Saturation.h>

Inheritance diagram for openshot::Saturation:
openshot::EffectBase openshot::ClipBase

Public Member Functions

std::shared_ptr< FrameGetFrame (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
 
 Saturation ()
 Blank constructor, useful when using Json to load the effect properties. More...
 
 Saturation (Keyframe new_saturation)
 
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...
 
- Public Member Functions inherited from openshot::EffectBase
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...
 
virtual std::shared_ptr< openshot::FrameGetFrame (std::shared_ptr< openshot::Frame > frame, int64_t frame_number)=0
 This method is required for all derived classes of EffectBase, and returns a modified openshot::Frame object. 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
 
- Public Member Functions inherited from openshot::ClipBase
 ClipBase ()
 Constructor for the base clip. More...
 
float Duration () const
 Get the length of this clip (in seconds) More...
 
float End () const
 Get end position (in seconds) of clip (trim end of video) More...
 
void End (float value)
 Set end position (in seconds) of clip (trim end of video) More...
 
std::string Id () const
 Get basic properties. More...
 
void Id (std::string value)
 Set basic properties. More...
 
int Layer () const
 Get layer of clip on timeline (lower number is covered by higher numbers) More...
 
void Layer (int value)
 Set layer of clip on timeline (lower number is covered by higher numbers) More...
 
bool operator< (ClipBase &a)
 
bool operator<= (ClipBase &a)
 
bool operator> (ClipBase &a)
 
bool operator>= (ClipBase &a)
 
float Position () const
 Get position on timeline (in seconds) More...
 
void Position (float value)
 

Set the Id of this clip object

More...
 
float Start () const
 Get start position (in seconds) of clip (trim start of video) More...
 
void Start (float value)
 Set start position (in seconds) of clip (trim start of video) More...
 
virtual ~ClipBase ()=default
 

Public Attributes

Keyframe saturation
 The color saturation: 0.0 = black and white, 1.0 = normal, 2.0 = double saturation. More...
 
- Public Attributes inherited from openshot::EffectBase
EffectInfoStruct info
 Information about the current effect. More...
 

Additional Inherited Members

- Protected Member Functions inherited from openshot::ClipBase
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...
 
- Protected Attributes inherited from openshot::ClipBase
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...
 

Detailed Description

This class adjusts the saturation of color on a frame's image.

This can be animated by passing in a Keyframe. Animating the color saturation can create some very cool effects.

Definition at line 60 of file Saturation.h.

Constructor & Destructor Documentation

◆ Saturation() [1/2]

Saturation::Saturation ( )

Blank constructor, useful when using Json to load the effect properties.

Definition at line 36 of file Saturation.cpp.

◆ Saturation() [2/2]

Saturation::Saturation ( Keyframe  new_saturation)

Default constructor, which takes 1 curve, to adjust the color saturation over time.

Parameters
new_saturationThe curve to adjust the saturation of the frame's image (0.0 = black and white, 1.0 = normal, 2.0 = double saturation)

Definition at line 42 of file Saturation.cpp.

Member Function Documentation

◆ GetFrame()

std::shared_ptr< Frame > Saturation::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.

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).

Returns
The modified openshot::Frame object
Parameters
frameThe frame object that needs the effect applied to it
frame_numberThe frame number (starting at 1) of the effect on the timeline.

Definition at line 64 of file Saturation.cpp.

◆ Json()

std::string Saturation::Json ( ) const
overridevirtual

Get and Set JSON methods.

Generate JSON string of this object

Implements openshot::EffectBase.

Definition at line 109 of file Saturation.cpp.

◆ JsonValue()

Json::Value Saturation::JsonValue ( ) const
overridevirtual

Generate Json::Value for this object.

Implements openshot::EffectBase.

Definition at line 116 of file Saturation.cpp.

Referenced by Json().

◆ PropertiesJSON()

std::string Saturation::PropertiesJSON ( int64_t  requested_frame) const
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.

Definition at line 156 of file Saturation.cpp.

◆ SetJson()

void Saturation::SetJson ( const std::string  value)
virtual

Load JSON string into this object.

Implements openshot::EffectBase.

Definition at line 128 of file Saturation.cpp.

◆ SetJsonValue()

void Saturation::SetJsonValue ( const Json::Value  root)
virtual

Load Json::Value into this object.

Implements openshot::EffectBase.

Definition at line 145 of file Saturation.cpp.

Referenced by SetJson().

Member Data Documentation

◆ saturation

Keyframe openshot::Saturation::saturation

The color saturation: 0.0 = black and white, 1.0 = normal, 2.0 = double saturation.

Definition at line 67 of file Saturation.h.

Referenced by GetFrame(), JsonValue(), PropertiesJSON(), and SetJsonValue().


The documentation for this class was generated from the following files: