Difference between revisions of "love.graphics.setLineStipple"
m (1 revision: Importing from potato (again).) |
|||
| Line 1: | Line 1: | ||
| − | |||
Sets the line stipple pattern. | Sets the line stipple pattern. | ||
== Function == | == Function == | ||
| Line 11: | Line 10: | ||
=== Returns === | === Returns === | ||
Nothing. | Nothing. | ||
| + | == Additional Information == | ||
| + | To make stippled (dotted or dashed) lines, you use the command '''love.graphics.setLineStipple(pattern, repeat)''' to define and enable the stipple pattern. | ||
| + | |||
| + | Example: | ||
| + | <source lang="lua"> | ||
| + | love.graphics.setLineStipple(0x3F07, 1); | ||
| + | </source> | ||
| + | |||
| + | The pattern argument is a 16-bit series of 0s and 1s, and it's repeated as necessary to stipple a given line. A 1 indicates that drawing occurs, and 0 that it does not, on a pixel-by-pixel basis, beginning with the low-order bits of the pattern. The pattern can be stretched out by using factor, which multiplies each subseries of consecutive 1s and 0s. Thus, if three consecutive 1s appear in the pattern, they're stretched to six if factor is 2. factor is clamped to lie between 1 and 255. | ||
| + | |||
| + | With the preceding example and the pattern 0x3F07 (which translates to 0011111100000111 in binary), a line would be drawn with 3 pixels on, then 5 off, 6 on, and 2 off. (If this seems backward, remember that the low-order bits are used first.) If factor had been 2, the pattern would have been elongated: 6 pixels on, 10 off, 12 on, and 4 off. | ||
| + | |||
| + | Note that stippling can be used in combination with wide lines to produce wide stippled lines. | ||
| + | |||
| + | This additional information is adapted from The Red Book: Chapter 2 - | ||
| + | http://fly.cc.fer.hr/~unreal/theredbook/chapter02.html | ||
== See Also == | == See Also == | ||
* [[parent::love.graphics]] | * [[parent::love.graphics]] | ||
[[Category:Functions]] | [[Category:Functions]] | ||
{{#set:Description=Sets the line stipple pattern.}} | {{#set:Description=Sets the line stipple pattern.}} | ||
Revision as of 05:36, 19 August 2010
Sets the line stipple pattern.
Function
Synopsis
love.graphics.setLineStipple( pattern, repeat )
Arguments
Returns
Nothing.
Additional Information
To make stippled (dotted or dashed) lines, you use the command love.graphics.setLineStipple(pattern, repeat) to define and enable the stipple pattern.
Example:
love.graphics.setLineStipple(0x3F07, 1);
The pattern argument is a 16-bit series of 0s and 1s, and it's repeated as necessary to stipple a given line. A 1 indicates that drawing occurs, and 0 that it does not, on a pixel-by-pixel basis, beginning with the low-order bits of the pattern. The pattern can be stretched out by using factor, which multiplies each subseries of consecutive 1s and 0s. Thus, if three consecutive 1s appear in the pattern, they're stretched to six if factor is 2. factor is clamped to lie between 1 and 255.
With the preceding example and the pattern 0x3F07 (which translates to 0011111100000111 in binary), a line would be drawn with 3 pixels on, then 5 off, 6 on, and 2 off. (If this seems backward, remember that the low-order bits are used first.) If factor had been 2, the pattern would have been elongated: 6 pixels on, 10 off, 12 on, and 4 off.
Note that stippling can be used in combination with wide lines to produce wide stippled lines.
This additional information is adapted from The Red Book: Chapter 2 - http://fly.cc.fer.hr/~unreal/theredbook/chapter02.html
