Difference between revisions of "PixelEffect:send"

(Created page with "{{newin|0.8.0|080|type=function}} Sends one or more values to a pixel effect using the specified name. This function allows certain aspects of a pixel effect to be controlle...")
 
m
Line 21: Line 21:
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
{{param|string|name|Name of the numbers to send to the pixel effect.}}
+
{{param|string|name|Name of the vector to send to the pixel effect.}}
 
{{param|number|...|Numbers to send to the pixel effect as a vector. Up to four can be sent. Values can also be packed into a table.}}
 
{{param|number|...|Numbers to send to the pixel effect as a vector. Up to four can be sent. Values can also be packed into a table.}}
 
=== Returns ===
 
=== Returns ===
Line 33: Line 33:
 
=== Arguments ===
 
=== Arguments ===
 
{{param|string|name|Name of the matrix to send to the pixel effect.}}
 
{{param|string|name|Name of the matrix to send to the pixel effect.}}
{{param|table|matrix|2x2, 3x3, or 4x4 matrix to send to the pixel effect. Using table form: <nowiki>{{a,b,c,d}, {e,f,g,h}, ... }</nowiki>}}
+
{{param|table|matrix|2x2, 3x3, or 4x4 matrix to send to the pixel effect. Using table form: <code><nowiki>{{a,b,c,d}, {e,f,g,h}, ... }</nowiki></code>}}
 
=== Returns ===
 
=== Returns ===
 
Nothing.
 
Nothing.
Line 62: Line 62:
 
* [[parent::PixelEffect]]
 
* [[parent::PixelEffect]]
 
[[Category:Functions]]
 
[[Category:Functions]]
{{#set:Description=Sends one or more values to a pixel effect.}}
+
{{#set:Description=Sends one or more values to the pixel effect.}}
 
== Other Languages ==
 
== Other Languages ==
 
{{i18n|PixelEffect:send}}
 
{{i18n|PixelEffect:send}}

Revision as of 08:26, 16 August 2011

Available since LÖVE 0.8.0
This function is not supported in earlier versions.

Sends one or more values to a pixel effect using the specified name.

This function allows certain aspects of a pixel effect to be controlled by Lua code.

Function

Synopsis

PixelEffect:send( name, number )

Arguments

string name
Name of the number to send to the pixel effect.
number number
Number to send to the pixel effect.

Returns

Nothing.

Function

Synopsis

PixelEffect:send( name, ... )

Arguments

string name
Name of the vector to send to the pixel effect.
number ...
Numbers to send to the pixel effect as a vector. Up to four can be sent. Values can also be packed into a table.

Returns

Nothing.

Function

Synopsis

PixelEffect:send( name, matrix )

Arguments

string name
Name of the matrix to send to the pixel effect.
table matrix
2x2, 3x3, or 4x4 matrix to send to the pixel effect. Using table form: {{a,b,c,d}, {e,f,g,h}, ... }

Returns

Nothing.

Function

Synopsis

PixelEffect:send( name, image )

Arguments

string name
Name of the Image to send to the pixel effect.
Image image
Image to send to the pixel effect for use as extra data.

Returns

Nothing.

Function

Synopsis

PixelEffect:send( name, canvas )

Arguments

string name
Name of the Canvas to send to the pixel effect.
Canvas canvas
Canvas to send to the pixel effect for use as extra data.

Returns

Nothing.

See Also

Other Languages