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

#include <Saturation.h>

Inheritance diagram for openshot::Saturation:

Public Member Functions
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...

string	Json ()
	Get and Set JSON methods. More...

Json::Value	JsonValue ()
	Generate Json::JsonValue for this object. More...

string	PropertiesJSON (int64_t requested_frame)

	Saturation ()
	Blank constructor, useful when using Json to load the effect properties. More...

	Saturation (Keyframe new_saturation)

void	SetJson (string value)
	Load JSON string into this object. More...

void	SetJsonValue (Json::Value root)
	Load Json::JsonValue 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...

void	InitEffectInfo ()

Json::Value	JsonInfo ()
	Generate JSON object of meta data / info. More...

int	Order ()
	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...

Public Member Functions inherited from openshot::ClipBase
	ClipBase ()
	Constructor for the base clip. More...

float	Duration ()
	Get the length of this clip (in seconds) More...

float	End ()
	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...

string	Id ()
	Get basic properties. More...

void	Id (string value)
	Set basic properties. More...

int	Layer ()
	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 ()
	Get position on timeline (in seconds) More...

void	Position (float value)
	Set the Id of this clip object More...

void	SetMaxSize (int width, int height)
	Set Max Image Size (used for performance optimization) More...

float	Start ()
	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...

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 (string name, int value, int selected_value)
	Generate JSON choice for a property (dropdown properties) More...

Json::Value	add_property_json (string name, float value, string type, string memo, Keyframe *keyframe, float min_value, float max_value, bool readonly, int64_t requested_frame)
	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...

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

int	max_height
	The maximium image height needed by this clip (used for optimizations) More...

int	max_width
	The maximum image width needed by this clip (used for optimizations) More...

float	position
	The position on the timeline where this clip should start playing. More...

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 59 of file Saturation.h.

Constructor & Destructor Documentation

Saturation::Saturation ( )

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

Definition at line 33 of file Saturation.cpp.

Saturation::Saturation ( Keyframe new_saturation )

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

Parameters

new_saturation The 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 39 of file Saturation.cpp.

Member Function Documentation

std::shared_ptr< Frame > Saturation::GetFrame	(	std::shared_ptr< Frame >	frame,
		int64_t	frame_number
	)

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 it's keyframes (starting at 1).