X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=effects%2FREADME;h=7cc34eb76d72f009dc6c06afec232c32b64ee00b;hb=c3302003093710ee247ad84c0fe2ef3c579d417f;hp=fb5dc3e724d3fb72d489e5ebf165482462e442f1;hpb=359d9b708d7c475e70e9bafd1bc0969af31b71c6;p=kdenlive

diff --git a/effects/README b/effects/README
index fb5dc3e7..7cc34eb7 100644
--- a/effects/README
+++ b/effects/README
@@ -49,6 +49,7 @@ The rest:
         - tag "name": visible name of the parameter (depending on the GUI this parameter uses)
         - tag "comment": (optional) description of the parameter (support HTML formatting) (not yet supported by all widgets)
         - attribute "name": MLT filter parameter name
+        - attribute "paramprefix": a string to be prepended to the parameter value before passing it to MLT
         - attribute "default": initial value, format depends on parameter type
         - attribute "type": widget (GUI) to use
             - "fixed":
@@ -57,7 +58,8 @@ The rest:
                 - number
                 - represented by a slider
                 - additional parameter attributes:
-                    - "factor": (optional) values coming from MLT will be multiplied with factor, values from the GUI divided by factor
+                    - "factor": (optional) values coming from MLT will be multiplied with factor
+                    - "offset": (optional) will be added to values coming from MLT after "factor" is applied
                     - "min": smallest value possible (after multiplying with "factor")
                     - "max": largest value possible (after multiplying with "factor")
                     - "suffix": (optional) displayed unit of the values
@@ -70,15 +72,17 @@ The rest:
                 - multiple choice
                 - represented by a drop-down menu
                 - additional parameter attribute:
-                    - "paramlist": list of possible values separated by comma (no whitespaces!)
+                    - "paramlist": list of possible values separated by semicolon (no whitespaces!)
                 - addtional tag:
-                    - "paramlistdisplay": (optional) list of names to use for the values
+                    - "paramlistdisplay": (optional) list of names to use for the values separated by comma
             - "position":
                 - time stored as frame number
                 - represented by a slider
             - "color":
-                - color value, similar to representation HTML ("#rrggbb" or "0xrrggbb")
+                - color value, similar to representation HTML ("#rrggbb"/"#aarrggbb" or "0xrrggbbaa")
                 - represented by a button opening the KDE color dialog + a color picker button
+                - additional attributes:
+                    - "alpha": (default = "0") use to enable alpha support
             - "keyframe":
                 - keyframable number
                 - keyframes are opt-in (only one keyframe by default -> should be prefered over "constant" whenever possible)
@@ -111,6 +115,13 @@ The rest:
                 - cubic Bézier spline editor for the frei0r color curves filter (new version, might be reused for other filters)
             - "roto-spline":
                 - GUI for the rotoscoping filter (spline on the monitor)
+            - "keywords":
+                - Text entry with a selection of possible keywords to be inserted in the text.
+                - additional tags:
+                    - "keywords": list of possible keyword values separated by semicolon
+                    - "keywordsdisplay": list of names to use for the values separated by semicolon
+            - "fontfamily":
+                - Font typeface entry
 ==========
 
 ==========