|
|
| Line 1: |
Line 1: |
| − | <!-- ================= INSTRUCTIONS - DELETE ME ================= -->
| + | (under construction) |
| − | {{BlueBox}}Welcome filter authors! To help you document your filter in this Wiki, here is a template to get you started.
| + | |
| − | <br><br>
| + | |
| − | '''Instructions:'''
| + | |
| − | | + | |
| − | # Right-Click the '''Edit''' tab at the top of this page and open in a new browser tab. Keep the instructions open in ''this'' tab for reference.
| + | |
| − | # In the new tab, you will see a page full of Wiki code (the source code for this very page); copy everything below "'''END INSTRUCTIONS'''" to the clipboard.
| + | |
| − | # In the new tab, edit the page URL:
| + | |
| − | #* Replace '''?title=ExampleFilter''' with '''/YourFilterName'''
| + | |
| − | #* Your filter name ''should'' be one word - no spaces - but this is not mandatory.
| + | |
| − | #* First letter ''must'' be UPPERCASE due to Wikicode requirements.
| + | |
| − | #* Don't forget to remove the "'''?'''" and replace it with "'''/'''"
| + | |
| − | # Hit Enter. If the title is already in use, you will be taken to that page.
| + | |
| − | #* If the page already exists, hit your browser's Back button.
| + | |
| − | #* Try a different title: Rename your filter, or add a suffix like "/CoolFilter (updated)"
| + | |
| − | # If your title ''is'' unique, you will be greeted with the "There is currently no text in this page" banner. Click on the "edit this page" link.
| + | |
| − | # Paste the source code you copied in Step 2.
| + | |
| − | # Areas that need your attention are marked with HTML comments <nowiki><</nowiki><nowiki>!--</nowiki> like this <nowiki>--</nowiki><nowiki>></nowiki>. Fill in as much information as you can. Leave the rest.
| + | |
| − | # Click the Show Preview button to see how your page will look.
| + | |
| − | # Click the Save page button to create the new page.
| + | |
| − | # If you did something wrong, Click the Edit tab and fix it.
| + | |
| − | <br>
| + | |
| − | Please don't worry about formatting or incomplete information; just do the best you can. <br />
| + | |
| − | A more experienced user will come along and clean up the page for you, and add a link to your page @[[External filters]] '''(don't do this yourself)'''.
| + | |
| − | <br><br>
| + | |
| − | '''NOTE: Willful vandalism will result in the termination of your account.'''
| + | |
| − | {{End_BlueBox}}
| + | |
| − | | + | |
| − | | + | |
| − | | + | |
| − | <!-- ================= END INSTRUCTIONS ================= -->
| + | |
| − | | + | |
| − | {{FilterCat4|External_filters|Plugins|<!-- category -->TODO|<!-- category -->TODO}}
| + | |
| − | | + | |
| − | {{Filter3
| + | |
| − | |<!-- author -->My Name
| + | |
| − | |<!-- version -->1.0.0.0.0
| + | |
| − | |<!-- download URL -->[http://google.com ExampleFilter.com]
| + | |
| − | |<!-- category -->External filters
| + | |
| − | |<!-- license -->[http://www.gnu.org/licenses/gpl-2.0.txt GPLv2]
| + | |
| − | |<!-- discussion URL -->[http://doom9.org Announcing ExampleFilter]}}
| + | |
| − | <br>
| + | |
| − | == Description ==
| + | |
| − | <!-- a one-sentence description -->
| + | |
| − | ExampleFilter is an example filter. This page serves as boilerplate text for new filter pages.
| + | |
| − | <br>
| + | |
| − | <br>
| + | |
| − | == Requirements ==
| + | |
| − | * <!-- Avisynth version -->AviSynth 2.5.8 or [http://sourceforge.net/projects/avisynth2/files/AviSynth_Alpha_Releases/ 2.6.0 Alpha 5 or greater]
| + | |
| − | * <!-- source video: interlaced? progressive? -->
| + | |
| − | * <!-- color formats -->Supported color formats: [[RGB24]], [[RGB32]], [[YUY2]], [[YV12]], <span style="color:red">*</span>[[YV16]], <span style="color:red">*</span>[[YV24]], <span style="color:red">*</span>[[YV411]], <span style="color:red">*</span>[[Y8]]
| + | |
| − | : <span style="color:red">*</span> Not available in AviSynth 2.5.8.
| + | |
| − | * <!-- CPU/GPU -->[[MMX]] or [[SSE2]] capable CPU
| + | |
| − | * <!-- binaries -->
| + | |
| − | * <!-- dependent plugins -->
| + | |
| − | <br>
| + | |
| − | | + | |
| − | == [[Script variables|Syntax and Parameters]] ==
| + | |
| − | :{{Template:FuncDef|<!-- function name -->ExampleFilter (''clip'', ''<!-- par 1 type -->bool'' "<!-- par 1 name -->blah", ''<!-- par 2 type -->'' "<!-- par 2 name -->", ''<!-- par 3 type -->'' "<!-- par 3 name -->", ''<!-- par 4 type -->'' "<!-- par 4 name -->", ''<!-- par 5 type -->'' "<!-- par 5 name -->", ''<!-- par 6 type -->'' "<!-- par 6 name -->", ''<!-- par 7 type -->'' "<!-- par 7 name -->", ''<!-- par 8 type -->'' "<!-- par 8 name -->", ''<!-- par 9 type -->'' "<!-- par 9 name -->")}}
| + | |
| − | <br>
| + | |
| − | ::{{Par2| |clip| }}
| + | |
| − | :::Input clip.
| + | |
| − | <br>
| + | |
| − | ::{{Par2|<!-- par 1 type -->bool|<!-- par 1 name -->blah|<!-- par 1 default value -->false}}
| + | |
| − | :::<!-- par 1 description -->Example description for parameter ''blah''.
| + | |
| − | <br>
| + | |
| − | ::{{Par2|<!-- par 2 type -->|<!-- par 2 name -->|<!-- par 2 default value -->}}
| + | |
| − | :::<!-- par 2 description -->
| + | |
| − | <br>
| + | |
| − | ::{{Par2|<!-- par 3 type -->|<!-- par 3 name -->|<!-- par 3 default value -->}}
| + | |
| − | :::<!-- par 3 description -->
| + | |
| − | <br>
| + | |
| − | ::{{Par2|<!-- par 4 type -->|<!-- par 4 name -->|<!-- par 4 default value -->}}
| + | |
| − | :::<!-- par 4 description -->
| + | |
| − | <br>
| + | |
| − | ::{{Par2|<!-- par 5 type -->|<!-- par 5 name -->|<!-- par 5 default value -->}}
| + | |
| − | :::<!-- par 5 description -->
| + | |
| − | <br>
| + | |
| − | ::{{Par2|<!-- par 6 type -->|<!-- par 6 name -->|<!-- par 6 default value -->}}
| + | |
| − | :::<!-- par 6 description -->
| + | |
| − | <br>
| + | |
| − | ::{{Par2|<!-- par 7 type -->|<!-- par 7 name -->|<!-- par 7 default value -->}}
| + | |
| − | :::<!-- par 7 description -->
| + | |
| − | <br>
| + | |
| − | ::{{Par2|<!-- par 8 type -->|<!-- par 8 name -->|<!-- par 8 default value -->}}
| + | |
| − | :::<!-- par 8 description -->
| + | |
| − | <br>
| + | |
| − | ::{{Par2|<!-- par 9 type -->|<!-- par 9 name -->|<!-- par 9 default value -->}}
| + | |
| − | :::<!-- par 9 description -->
| + | |
| − | <br>
| + | |
| − | | + | |
| − | == Examples ==
| + | |
| − | <!-- example code block: 1st char in each line = space -->
| + | |
| − | ## This is some example code.
| + | |
| − | Avisource("example.avi")
| + | |
| − | ExampleFilter(blah=true)
| + | |
| − | <!-- new code block: no leading space -->
| + | |
| − | | + | |
| − | ## This is another example.
| + | |
| − | Avisource("example.avi")
| + | |
| − | ExampleFilter(blah=false)
| + | |
| − | <br>
| + | |
| − | <br>
| + | |
| − | -----------------------------------------------
| + | |
| − | '''Back to [[External_filters|External Filters]] ←'''
| + | |
