Difference between revisions of "(Image):setWrap"
m (better phrasing) |
(update for 0.6.2) |
||
| Line 1: | Line 1: | ||
Sets the wrapping properties of an Image. | Sets the wrapping properties of an Image. | ||
| − | This function sets the way an Image is repeated when it is drawn with a [[Quad| Quad]] that is larger than the image's extent. | + | This function sets the way an Image is repeated when it is drawn with a [[Quad| Quad]] that is larger than the image's extent. An image may be clamped or set to repeat in both horizontal and vertical directions. Clamped images appear only once, but repeated ones repeat as many times as there is room in the Quad. |
| − | N.B. If you use a Quad that is larger than the image extent and do not use | + | N.B. If you use a Quad that is larger than the image extent and do not use repeated tiling, there may be an unwanted visual effect of the image stretching all the way to fill the Quad. If this is the case, setting <tt>Image:getWrap("repeat", "repeat")</tt> for all the images to be repeated, and using Quads of appropriate size will result in the best visual appearance. |
== Function == | == Function == | ||
=== Synopsis === | === Synopsis === | ||
<source lang="lua"> | <source lang="lua"> | ||
| − | Image: | + | Image:setWrap( horiz, vert ) |
</source> | </source> | ||
=== Arguments === | === Arguments === | ||
| − | {{param| | + | {{param|WrapMode|horiz|Horizontal wrapping mode of the image.}} |
| − | {{param| | + | {{param|WrapMode|vert|Vertical wrapping mode of the image.}} |
=== Returns === | === Returns === | ||
Nothing. | Nothing. | ||
== See Also == | == See Also == | ||
* [[parent::Image]] | * [[parent::Image]] | ||
| + | * [[WrapMode]] | ||
[[Category:Functions]] | [[Category:Functions]] | ||
{{#set:Description=Sets the wrapping properties of an Image.}} | {{#set:Description=Sets the wrapping properties of an Image.}} | ||
Revision as of 12:23, 6 March 2010
Sets the wrapping properties of an Image.
This function sets the way an Image is repeated when it is drawn with a Quad that is larger than the image's extent. An image may be clamped or set to repeat in both horizontal and vertical directions. Clamped images appear only once, but repeated ones repeat as many times as there is room in the Quad.
N.B. If you use a Quad that is larger than the image extent and do not use repeated tiling, there may be an unwanted visual effect of the image stretching all the way to fill the Quad. If this is the case, setting Image:getWrap("repeat", "repeat") for all the images to be repeated, and using Quads of appropriate size will result in the best visual appearance.
Function
Synopsis
Image:setWrap( horiz, vert )
Arguments
WrapMode horiz- Horizontal wrapping mode of the image.
WrapMode vert- Vertical wrapping mode of the image.
Returns
Nothing.
