Fix parameter documentation for brightness

The range was listed as 0 – 100, but implemented as -1 – +1. Edited documentation to reflect reality.

Reported by @jeffski like a year and a half ago.
Fixes #71
This commit is contained in:
Frank Dana
2019-07-10 04:48:31 -04:00
committed by GitHub
parent 72b04ce838
commit 86e610bfc8
+2 -2
View File
@@ -75,8 +75,8 @@ namespace openshot
/// Default constructor, which takes 2 curves. The curves adjust the brightness and
// contrast of a frame's image.
///
/// @param new_brightness The curve to adjust the brightness (between 100 and -100)
/// @param new_contrast The curve to adjust the contrast (3 is typical, 20 is a lot, 0 is invalid)
/// @param new_brightness The curve to adjust the brightness (from -1 to +1, 0 is default/"off")
/// @param new_contrast The curve to adjust the contrast (3 is typical, 20 is a lot, 100 is max. 0 is invalid)
Brightness(Keyframe new_brightness, Keyframe new_contrast);
/// @brief This method is required for all derived classes of EffectBase, and returns a