This class adjusts the brightness and contrast of an image, and can be animated with openshot::Keyframe curves over time. More...

#include <Brightness.h>

Inheritance diagram for openshot::Brightness:

Public Member Functions
	Brightness ()
	Blank constructor, useful when using Json to load the effect properties. More...

	Brightness (Keyframe new_brightness, Keyframe new_contrast)
	Default constructor, which takes 2 curves. The curves adjust the brightness and. More...

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)

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	brightness
	Brightness keyframe. A constant value here will prevent animation. More...

Keyframe	contrast
	Contrast keyframe. 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 brightness and contrast of an image, and can be animated with openshot::Keyframe curves over time.

Adjusting the brightness and contrast over time can create many different powerful effects.

Definition at line 59 of file Brightness.h.

Constructor & Destructor Documentation

◆ Brightness() [1/2]

Brightness::Brightness ( )

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

Definition at line 33 of file Brightness.cpp.

◆ Brightness() [2/2]

Brightness::Brightness	(	Keyframe	new_brightness,
		Keyframe	new_contrast
	)

Default constructor, which takes 2 curves. The curves adjust the brightness and.

Parameters

new_brightness	The curve to adjust the brightness (between 100 and -100)
new_contrast	The curve to adjust the contrast (3 is typical, 20 is a lot, 0 is invalid)

Definition at line 39 of file Brightness.cpp.

Member Function Documentation

◆ GetFrame()

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

Returns: The modified openshot::Frame object

Parameters

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.

Definition at line 61 of file Brightness.cpp.

◆ Json()

string Brightness::Json ( )

virtual

Get and Set JSON methods.

Generate JSON string of this object

Implements openshot::EffectBase.

Definition at line 108 of file Brightness.cpp.

◆ JsonValue()

Json::Value Brightness::JsonValue ( )

virtual

Generate Json::JsonValue for this object.

Implements openshot::EffectBase.

Definition at line 115 of file Brightness.cpp.

◆ PropertiesJSON()

string Brightness::PropertiesJSON ( int64_t requested_frame )

virtual

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 164 of file Brightness.cpp.

◆ SetJson()

void Brightness::SetJson ( string value )

virtual

Load JSON string into this object.

Implements openshot::EffectBase.

Definition at line 128 of file Brightness.cpp.

◆ SetJsonValue()

void Brightness::SetJsonValue ( Json::Value root )

virtual

Load Json::JsonValue into this object.

Implements openshot::EffectBase.

Definition at line 151 of file Brightness.cpp.

Member Data Documentation

◆ brightness

Keyframe openshot::Brightness::brightness

Brightness keyframe. A constant value here will prevent animation.

Definition at line 66 of file Brightness.h.

◆ contrast

Keyframe openshot::Brightness::contrast

Contrast keyframe.

Definition at line 67 of file Brightness.h.

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

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Brightness() [1/2]

◆ Brightness() [2/2]

Member Function Documentation

◆ GetFrame()

◆ Json()

◆ JsonValue()

◆ PropertiesJSON()

◆ SetJson()

◆ SetJsonValue()

Member Data Documentation

◆ brightness

◆ contrast