ExampleFilter
From Avisynth wiki
(Difference between revisions)
Raffriff42 (Talk | contribs) (a template for new filters) |
Raffriff42 (Talk | contribs) m (minor touchup) |
||
| Line 1: | Line 1: | ||
| − | <!-- ================= INSTRUCTIONS - | + | <!-- ================= INSTRUCTIONS - DELETE ME ================= --> |
{{BlueBox}}Welcome filter authors! To help you document your filter in this Wiki, here is a template to help get you started. | {{BlueBox}}Welcome filter authors! To help you document your filter in this Wiki, here is a template to help get you started. | ||
<br><br> | <br><br> | ||
'''Instructions:''' | '''Instructions:''' | ||
| − | # Right-Click the '''Edit''' tab at the top of this page and open in a new browser tab. | + | # 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''' | #* Replace '''?title=ExampleFilter''' with '''/YourFilterName''' | ||
#* Your filter name ''should'' be one word - no spaces - but this is not mandatory. | #* Your filter name ''should'' be one word - no spaces - but this is not mandatory. | ||
| Line 12: | Line 12: | ||
#* Don't forget to remove the "'''?'''" and replace it with "'''/'''" | #* 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. | # 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)" | #* 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. | # 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. | # 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. | ||
| Line 29: | Line 29: | ||
| − | <!-- ================= | + | <!-- ================= END INSTRUCTIONS ================= --> |
{{FilterCat4|External_filters|Plugins|<!-- category -->TODO|<!-- category -->TODO}} | {{FilterCat4|External_filters|Plugins|<!-- category -->TODO|<!-- category -->TODO}} | ||
Revision as of 15:11, 5 November 2014
Welcome filter authors! To help you document your filter in this Wiki, here is a template to help get you started.
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 <!-- like this -->. 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.
Please don't worry about formatting or incomplete information; just do the best you can.
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).
NOTE: Willful vandalism will result in the termination of your account.
| Abstract | |
|---|---|
| Author | My Name |
| Version | 1.0.0.0.0 |
| Download | ExampleFilter.com |
| Category | External filters |
| License | GPLv2 |
| Discussion | Announcing ExampleFilter |
Contents[hide] |
Description
ExampleFilter is an example filter. This page serves as boilerplate text for new filter pages.
Requirements
- AviSynth 2.5.8 or 2.6.0 Alpha 5 or greater
- Supported color formats: RGB24, RGB32, YUY2, YV12, *YV16, *YV24, *YV411, *Y8
- * Not available in AviSynth 2.5.8.
Syntax and Parameters
- ExampleFilter (clip, bool "blah", ' "", ' "", ' "", ' "", ' "", ' "", ' "", ' "")
- clip =
- Input clip.
- clip =
- blah bool = false
- Example description for parameter blah.
- blah bool = false
- =
- =
- =
- =
- =
- =
- =
- =
- =
- =
- =
- =
- =
- =
- =
- =
Examples
## This is some example code.
Avisource("example.avi")
ExampleFilter(blah=true)
## This is another example.
Avisource("example.avi")
ExampleFilter(blah=false)
Back to External Filters ←
