Difference between revisions of "love.graphics.setScissor"
(added short description of scissors) |
(→See Also) |
||
| (17 intermediate revisions by 11 users not shown) | |||
| Line 1: | Line 1: | ||
| + | {{newin|[[0.4.0]]|040|type=function}} | ||
Sets or disables scissor. | Sets or disables scissor. | ||
| − | The scissor limits the drawing area to a specified rectangle. | + | The scissor limits the drawing area to a specified rectangle. This affects all graphics calls, including [[love.graphics.clear]]. |
| + | |||
| + | The dimensions of the scissor are unaffected by graphical transformations (translate, scale, ...), and it operates on whole pixels rather than having sub-pixel precision. | ||
| + | |||
== Function == | == Function == | ||
| + | Limits the drawing area to a specified rectangle. | ||
=== Synopsis === | === Synopsis === | ||
<source lang="lua"> | <source lang="lua"> | ||
| − | love.graphics.setScissor( ) | + | love.graphics.setScissor( x, y, width, height ) |
</source> | </source> | ||
=== Arguments === | === Arguments === | ||
| − | + | {{param|number|x|The x-coordinate of the upper left corner of the clipping rectangle.}} | |
| + | {{param|number|y|The y-coordinate of the upper left corner of the clipping rectangle.}} | ||
| + | {{param|number|width|The width of the clipping rectangle.}} | ||
| + | {{param|number|height|The height of the clipping rectangle.}} | ||
=== Returns === | === Returns === | ||
Nothing. | Nothing. | ||
| + | |||
== Function == | == Function == | ||
| + | Disables scissor. | ||
=== Synopsis === | === Synopsis === | ||
<source lang="lua"> | <source lang="lua"> | ||
| − | love.graphics.setScissor( | + | love.graphics.setScissor( ) |
</source> | </source> | ||
=== Arguments === | === Arguments === | ||
| − | + | None. | |
| − | |||
| − | |||
| − | |||
=== Returns === | === Returns === | ||
Nothing. | Nothing. | ||
| + | |||
| + | == Examples == | ||
| + | === Only draw on the left side of the screen === | ||
| + | <source lang="lua"> | ||
| + | function love.draw() | ||
| + | local windowWidth, windowHeight = love.graphics.getDimensions() | ||
| + | |||
| + | love.graphics.setScissor(0,0, windowWidth/2,windowHeight) | ||
| + | love.graphics.clear(0, 0, .5) | ||
| + | love.graphics.circle("fill", windowWidth/2,windowHeight/2, 100) | ||
| + | end | ||
| + | </source> | ||
| + | |||
== See Also == | == See Also == | ||
* [[parent::love.graphics]] | * [[parent::love.graphics]] | ||
* [[love.graphics.getScissor]] | * [[love.graphics.getScissor]] | ||
| + | * [[love.graphics.intersectScissor]] | ||
| + | * [[love.graphics.stencil]] | ||
| + | |||
| + | == Other Languages == | ||
| + | {{i18n|love.graphics.setScissor}} | ||
| + | |||
[[Category:Functions]] | [[Category:Functions]] | ||
| − | {{#set:Description= | + | {{#set:Description=Sets or disables scissor.}} |
| + | {{#set:Sub-Category=State}} | ||
Latest revision as of 20:43, 19 May 2023
| Available since LÖVE 0.4.0 |
| This function is not supported in earlier versions. |
Sets or disables scissor.
The scissor limits the drawing area to a specified rectangle. This affects all graphics calls, including love.graphics.clear.
The dimensions of the scissor are unaffected by graphical transformations (translate, scale, ...), and it operates on whole pixels rather than having sub-pixel precision.
Contents
Function
Limits the drawing area to a specified rectangle.
Synopsis
love.graphics.setScissor( x, y, width, height )
Arguments
number x- The x-coordinate of the upper left corner of the clipping rectangle.
number y- The y-coordinate of the upper left corner of the clipping rectangle.
number width- The width of the clipping rectangle.
number height- The height of the clipping rectangle.
Returns
Nothing.
Function
Disables scissor.
Synopsis
love.graphics.setScissor( )
Arguments
None.
Returns
Nothing.
Examples
Only draw on the left side of the screen
function love.draw()
local windowWidth, windowHeight = love.graphics.getDimensions()
love.graphics.setScissor(0,0, windowWidth/2,windowHeight)
love.graphics.clear(0, 0, .5)
love.graphics.circle("fill", windowWidth/2,windowHeight/2, 100)
end
See Also
Other Languages
Dansk –
Deutsch –
English –
Español –
Français –
Indonesia –
Italiano –
Lietuviškai –
Magyar –
Nederlands –
Polski –
Português –
Română –
Slovenský –
Suomi –
Svenska –
Türkçe –
Česky –
Ελληνικά –
Български –
Русский –
Српски –
Українська –
עברית –
ไทย –
日本語 –
正體中文 –
简体中文 –
Tiếng Việt –
한국어
More info
