ExampleFilter

From Avisynth wiki
(Difference between revisions)
Jump to: navigation, search
m (delete a redundant word)
m (added category)
 
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
[[Category:AviSynth_Development]]
 
<!-- ================= INSTRUCTIONS - DELETE ME ================= -->
 
<!-- ================= INSTRUCTIONS - DELETE ME ================= -->
 
{{BlueBox}}Welcome filter authors! To help you document your filter in this Wiki, here is a template to get you started.
 
{{BlueBox}}Welcome filter authors! To help you document your filter in this Wiki, here is a template to get you started.
Line 7: Line 8:
 
# 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, 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:  
 
# In the new tab, edit the page URL:  
−
#* Replace '''?title=ExampleFilter''' with '''/YourFilterName'''
+
#* Replace '''?title=ExampleFilter&action=edit''' 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.
 
#* First letter ''must'' be UPPERCASE due to Wikicode requirements.
 
#* First letter ''must'' be UPPERCASE due to Wikicode requirements.
Line 34: Line 35:
  
 
{{Filter3
 
{{Filter3
−
|<!-- author -->My Name
+
|1=<!-- author -->My Name
−
|<!-- version -->1.0.0.0.0
+
|2=<!-- version -->1.0.0.0.0
−
|<!-- download URL -->[http://google.com ExampleFilter.com]
+
|3=<!-- category -->External filters
−
|<!-- category -->External filters
+
|4=<!-- download URL -->[http://google.com ExampleFilter.com]
−
|<!-- license -->[http://www.gnu.org/licenses/gpl-2.0.txt GPLv2]
+
|5=<!-- license -->[http://www.gnu.org/licenses/gpl-2.0.txt GPLv2]
−
|<!-- discussion URL -->[http://doom9.org Announcing ExampleFilter]}}
+
|6=<!-- discussion URL -->[http://doom9.org Announcing ExampleFilter]
 +
}}
 +
<!--
 +
==================================
 +
URL notes: in Wikicode, a URL has:
 +
* a left square bracket,
 +
* the URL itself,
 +
* a space,
 +
* the link text (required, or the link looks like this: "[1]"
 +
* and a right square bracket.
 +
Example:
 +
[http://avisynth.nl/ Avisynth Wiki]
 +
==================================
 +
-->
 
<br>
 
<br>
 
== Description ==
 
== Description ==
Line 47: Line 61:
 
<br>
 
<br>
 
== Requirements ==
 
== Requirements ==
−
* <!-- Avisynth version -->AviSynth 2.5.8 or [http://sourceforge.net/projects/avisynth2/files/AviSynth_Alpha_Releases/ 2.6.0 Alpha 5 or greater]
+
* <!-- AviSynth version -->AviSynth 2.5.8 or [http://sourceforge.net/projects/avisynth2/ 2.6.0] or greater
 
* <!-- source video: interlaced? progressive? -->  
 
* <!-- 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]]
 
* <!-- 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]]
Line 57: Line 71:
  
 
== [[Script variables|Syntax and Parameters]] ==
 
== [[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 -->")}}
+
:{{Template:FuncDef|ExampleFilter (clip C, type1 ''name1'', type2 ''name2'', type3 ''name3'', type4 ''name4'', type5 ''name5'', type6 ''name6'', type7 ''name7'', type8 ''name8'', type9 ''name9'')}}
−
<br>
+
::{{Par2| |C| }}
−
::{{Par2| |clip| }}
+
 
:::Input clip.       
 
:::Input clip.       
 +
::{{Par2|name1|type1|defaultvalue1}}
 +
:::description1
 +
::{{Par2|name2|type2|defaultvalue2}}
 +
:::description2
 +
::{{Par2|name3|type3|defaultvalue3}}
 +
:::description3
 +
::{{Par2|name4|type4|defaultvalue4}}
 +
:::description4
 +
::{{Par2|name5|type5|defaultvalue5}}
 +
:::description5
 +
::{{Par2|name6|type6|defaultvalue6}}
 +
:::description6
 +
::{{Par2|name7|type7|defaultvalue7}}
 +
:::description7
 +
::{{Par2|name8|type8|defaultvalue8}}
 +
:::description8
 +
::{{Par2|name9|type9|defaultvalue9}}
 +
:::description9
 
<br>
 
<br>
−
::{{Par2|<!-- par 1 type -->bool|<!-- par 1 name -->blah|<!-- par 1 default value -->false}}
+
 
−
:::<!-- par 1 description -->Example description for parameter ''blah''.
+
<!-- free form descriptive text here -->
−
<br>
+
This is some sample text.
−
::{{Par2|<!-- par 2 type -->|<!-- par 2 name -->|<!-- par 2 default value -->}}
+
Note that on Wikicode, line breaks are removed.
−
:::<!-- par 2 description -->
+
 
−
<br>
+
...You need to leave a blank line to get a new paragraph.
−
::{{Par2|<!-- par 3 type -->|<!-- par 3 name -->|<!-- par 3 default value -->}}
+
 
−
:::<!-- par 3 description -->
+
 
−
<br>
+
Here's a paragraph with a blank line above it
−
::{{Par2|<!-- par 4 type -->|<!-- par 4 name -->|<!-- par 4 default value -->}}
+
----
−
:::<!-- par 4 description -->
+
* Four dashes make a horizontal rule.
−
<br>
+
* bullet lists only need a leading '*'
−
::{{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 ==
 
== Examples ==
 
<!-- example code block: 1st char in each line = space -->
 
<!-- example code block: 1st char in each line = space -->
 
  ## This is some example code.
 
  ## This is some example code.
−
  Avisource("example.avi")
+
  [[AviSource]]("example.avi")
 
  ExampleFilter(blah=true)
 
  ExampleFilter(blah=true)
 
<!-- new code block: no leading space -->
 
<!-- new code block: no leading space -->
  
 
  ## This is another example.
 
  ## This is another example.
−
  Avisource("example.avi")
+
  [[AviSource]]("example.avi")
 
  ExampleFilter(blah=false)
 
  ExampleFilter(blah=false)
 
<br>
 
<br>

Latest revision as of 07:15, 11 November 2015

Welcome filter authors! To help you document your filter in this Wiki, here is a template to get you started.

Instructions:
  1. 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.
  2. 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.
  3. In the new tab, edit the page URL:
    • Replace ?title=ExampleFilter&action=edit 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 "/"
  4. 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)"
  5. 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.
  6. Paste the source code you copied in Step 2.
  7. Areas that need your attention are marked with HTML comments <!-- like this -->. Fill in as much information as you can. Leave the rest.
  8. Click the Show Preview button to see how your page will look.
  9. Click the Save page button to create the new page.
  10. 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 External filters
Category ExampleFilter.com
License GPLv2
Discussion Announcing ExampleFilter


Contents

[edit] Description

ExampleFilter is an example filter. This page serves as boilerplate text for new filter pages.

[edit] Requirements

* Not available in AviSynth 2.5.8.


[edit] Syntax and Parameters

ExampleFilter (clip C, type1 name1, type2 name2, type3 name3, type4 name4, type5 name5, type6 name6, type7 name7, type8 name8, type9 name9)
C   =
Input clip.
type1  name1 = defaultvalue1
description1
type2  name2 = defaultvalue2
description2
type3  name3 = defaultvalue3
description3
type4  name4 = defaultvalue4
description4
type5  name5 = defaultvalue5
description5
type6  name6 = defaultvalue6
description6
type7  name7 = defaultvalue7
description7
type8  name8 = defaultvalue8
description8
type9  name9 = defaultvalue9
description9


This is some sample text. Note that on Wikicode, line breaks are removed.

...You need to leave a blank line to get a new paragraph.


Here's a paragraph with a blank line above it

  • Four dashes make a horizontal rule.
  • bullet lists only need a leading '*'


[edit] 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 ←

Retrieved from "http://avisynth.nl/index.php?title=ExampleFilter&oldid=7092"
Personal tools