Difference between revisions of "love.graphics.setScissor"

m (Newin template)
(Added example.)
Line 5: Line 5:
  
 
The dimensions of the scissor is unaffected by graphical transformations (translate, scale, ...).
 
The dimensions of the scissor is unaffected by graphical transformations (translate, scale, ...).
 +
 
== Function ==
 
== Function ==
 
Limits the drawing area to a specified rectangle.  
 
Limits the drawing area to a specified rectangle.  
Line 12: Line 13:
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
{{param|number|x|x coordinate of upper left corner.}}
+
{{param|number|x|The x-coordinate of the upper left corner of the clipping rectangle.}}
{{param|number|y|y coordinate of upper left corner.}}
+
{{param|number|y|The y-coordinate of the upper left corner of the clipping rectangle.}}
{{param|number|width|width of clipping rectangle.}}
+
{{param|number|width|The width of the clipping rectangle.}}
{{param|number|height|height of clipping rectangle.}}
+
{{param|number|height|The height of the clipping rectangle.}}
 
=== Returns ===
 
=== Returns ===
 
Nothing.
 
Nothing.
 +
 
== Function ==
 
== Function ==
 
Disables scissor.
 
Disables scissor.
Line 28: Line 30:
 
=== 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.intersectScissor]]
 +
 +
== Other Languages ==
 +
{{i18n|love.graphics.setScissor}}
 +
 
[[Category:Functions]]
 
[[Category:Functions]]
 
{{#set:Description=Sets or disables scissor.}}
 
{{#set:Description=Sets or disables scissor.}}
 
{{#set:Sub-Category=State}}
 
{{#set:Sub-Category=State}}
== Other Languages ==
 
{{i18n|love.graphics.setScissor}}
 

Revision as of 00:48, 1 September 2022

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 is unaffected by graphical transformations (translate, scale, ...).

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