MessageClip: Difference between revisions
From Avisynth wiki
Jump to navigationJump to search
Raffriff42 (talk | contribs) m added category:Debugging/Diagnostic_filters |
Raffriff42 (talk | contribs) formatting, links, images |
||
| Line 1: | Line 1: | ||
'''MessageClip''' produces a clip containing a text message. The font face is "Arial". The font size is between 24 points and 9 points - chosen to fit, if possible, in the width by height clip. Used internally for error reporting. | |||
== Syntax and Parameters == | |||
{{Template:FuncDef|MessageClip(string ''message'' [, int ''width'', int ''height'', bool ''shrink'', int ''text_color'', int ''halo_color'', int ''bg_color'' ] )}} | |||
:{{Par2|message|string|}} | |||
:: The message to be displayed. Required. | |||
:{{Par2|width|int|0}} | |||
:{{Par2|height|int|0}} | |||
:: Width and height of the resulting clip. By default, the clip grows to the size required to display the message. | |||
:{{Par2|shrink|bool|false}} | |||
::If true, and {{FuncArg|width}} and/or {{FuncArg|Height}} are specified, the clip resolution is reduced to a smaller size, if possible, to fit the text. If false (the default), the text will appear at the top-center of the video frame. | |||
:{{Par2|text_color|int|[[Preset colors|color_white]]}} | |||
:{{Par2|halo_color|int|[[Preset colors|color_black]]}} | |||
:{{Par2|bg_color|int|[[Preset colors|color_black]]}} | |||
::Colors for font fill, outline and background respectively. Default white, black, black. | |||
== Examples == | |||
<div {{BoxWidthIndent|46|0}} > | |||
MessageClip([[Internal_functions#VersionString|VersionString]]) | |||
</div> | |||
:[[File:MessageClip2-black.png]] | |||
<div {{BoxWidthIndent|46|0}} > | |||
MessageClip(VersionString, ''width=240'') | |||
</div> | |||
:[[File:MessageClip4-240px.png]] | |||
<div {{BoxWidthIndent|46|0}} > | |||
MessageClip(VersionString, ''bg_color=$ff0000'') | |||
</div> | |||
:[[File:MessageClip3-red.png]] | |||
<div {{BoxWidthIndent|46|0}} > | |||
MessageClip(VersionString, bg_color=$ff0000, ''height=80'') | |||
</div> | |||
:[[File:MessageClip3-red-hgt80.png]] | |||
<div {{BoxWidthIndent|46|0}} > | |||
MessageClip(VersionString, bg_color=$ff0000, height=80, ''shrink=true'') | |||
</div> | |||
:[[File:MessageClip3-red.png]] | |||
[[Category:Internal filters]] | [[Category:Internal filters]] | ||
[[Category:Debugging/Diagnostic filters]] | [[Category:Debugging/Diagnostic filters]] | ||
Revision as of 06:36, 13 January 2016
MessageClip produces a clip containing a text message. The font face is "Arial". The font size is between 24 points and 9 points - chosen to fit, if possible, in the width by height clip. Used internally for error reporting.
Syntax and Parameters
MessageClip(string message [, int width, int height, bool shrink, int text_color, int halo_color, int bg_color ] )
- string message =
- The message to be displayed. Required.
- int width = 0
- int height = 0
- Width and height of the resulting clip. By default, the clip grows to the size required to display the message.
- bool shrink = false
- If true, and width and/or Height are specified, the clip resolution is reduced to a smaller size, if possible, to fit the text. If false (the default), the text will appear at the top-center of the video frame.
- int text_color = color_white
- int halo_color = color_black
- int bg_color = color_black
- Colors for font fill, outline and background respectively. Default white, black, black.
Examples
MessageClip(VersionString)
MessageClip(VersionString, width=240)
MessageClip(VersionString, bg_color=$ff0000)
MessageClip(VersionString, bg_color=$ff0000, height=80)
MessageClip(VersionString, bg_color=$ff0000, height=80, shrink=true)
