Difference between revisions of "love.graphics.setStencilTest"
m (→Drawing two masked triangles with different colors) |
m |
||
(9 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
{{newin|[[0.10.0]]|100|type=function|text=Together with [[love.graphics.stencil]], it has replaced [[love.graphics.setStencil]]}} | {{newin|[[0.10.0]]|100|type=function|text=Together with [[love.graphics.stencil]], it has replaced [[love.graphics.setStencil]]}} | ||
− | + | Configures or disables stencil testing. | |
− | When stencil testing is enabled, the geometry of everything that is drawn will be clipped / stencilled out based on | + | When stencil testing is enabled, the geometry of everything that is drawn afterward will be clipped / stencilled out based on a comparison between the arguments of this function and the stencil value of each pixel that the geometry touches. The stencil values of pixels are affected via [[love.graphics.stencil]]. |
+ | |||
+ | |||
+ | {{notice|1=Starting with version [[11.0]], a stencil buffer must be set or requested in [[love.graphics.setCanvas]] when using stencils with a Canvas. <code>love.graphics.setCanvas{canvas, stencil=true}</code> is an easy way to use an automatically provided temporary stencil buffer in that case.}} | ||
+ | == Function == | ||
+ | === Synopsis === | ||
+ | <source lang="lua"> | ||
+ | love.graphics.setStencilTest( comparemode, comparevalue ) | ||
+ | </source> | ||
+ | === Arguments === | ||
+ | {{param|CompareMode|comparemode|The type of comparison to make for each pixel.}} | ||
+ | {{param|number|comparevalue|The value to use when comparing with the stencil value of each pixel. Must be between 0 and 255.}} | ||
+ | === Returns === | ||
+ | Nothing. | ||
− | |||
== Function == | == Function == | ||
+ | Disables stencil testing. | ||
=== Synopsis === | === Synopsis === | ||
<source lang="lua"> | <source lang="lua"> | ||
− | love.graphics.setStencilTest( | + | love.graphics.setStencilTest( ) |
</source> | </source> | ||
=== Arguments === | === Arguments === | ||
− | + | None. | |
− | |||
=== Returns === | === Returns === | ||
Nothing. | Nothing. | ||
+ | |||
== Examples == | == Examples == | ||
=== Drawing circles masked by a rectangle === | === Drawing circles masked by a rectangle === | ||
Line 23: | Line 36: | ||
function love.draw() | function love.draw() | ||
− | -- draw a rectangle | + | -- draw a rectangle as a stencil. Each pixel touched by the rectangle will have its stencil value set to 1. The rest will be 0. |
− | love.graphics.stencil(myStencilFunction) | + | love.graphics.stencil(myStencilFunction, "replace", 1) |
− | -- | + | -- Only allow rendering on pixels whose stencil value is greater than 0. |
− | love.graphics.setStencilTest( | + | love.graphics.setStencilTest("greater", 0) |
− | love.graphics.setColor( | + | love.graphics.setColor(1, 0, 0, 0.45) |
love.graphics.circle("fill", 300, 300, 150, 50) | love.graphics.circle("fill", 300, 300, 150, 50) | ||
− | love.graphics.setColor(0, 255, 0, | + | love.graphics.setColor(0, 255, 0, 0.45) |
love.graphics.circle("fill", 500, 300, 150, 50) | love.graphics.circle("fill", 500, 300, 150, 50) | ||
− | love.graphics.setColor(0, 0, 255, | + | love.graphics.setColor(0, 0, 255, 0.45) |
love.graphics.circle("fill", 400, 400, 150, 50) | love.graphics.circle("fill", 400, 400, 150, 50) | ||
− | love.graphics.setStencilTest( | + | love.graphics.setStencilTest() |
end | end | ||
</source> | </source> | ||
+ | |||
=== Drawing a circle with a hole === | === Drawing a circle with a hole === | ||
<source lang="lua"> | <source lang="lua"> | ||
local function myStencilFunction() | local function myStencilFunction() | ||
− | -- Draw a small circle | + | -- Draw a small circle as a stencil. This will be the hole. |
love.graphics.circle("fill", 400, 300, 50) | love.graphics.circle("fill", 400, 300, 50) | ||
end | end | ||
function love.draw() | function love.draw() | ||
− | love.graphics.stencil(myStencilFunction) | + | -- Each pixel touched by the circle will have its stencil value set to 1. The rest will be 0. |
+ | love.graphics.stencil(myStencilFunction, "replace", 1) | ||
− | -- | + | -- Configure the stencil test to only allow rendering on pixels whose stencil value is equal to 0. |
− | love.graphics.setStencilTest( | + | -- This will end up being every pixel *except* ones that were touched by the circle drawn as a stencil. |
+ | love.graphics.setStencilTest("equal", 0) | ||
love.graphics.circle("fill", 400, 300, 150) | love.graphics.circle("fill", 400, 300, 150) | ||
− | love.graphics.setStencilTest( | + | love.graphics.setStencilTest() |
end | end | ||
</source> | </source> | ||
+ | |||
=== Drawing two masked triangles with different colors === | === Drawing two masked triangles with different colors === | ||
<source lang="lua"> | <source lang="lua"> | ||
Line 64: | Line 81: | ||
function love.draw() | function love.draw() | ||
− | love.graphics.stencil(myStencilFunction) | + | -- Each pixel touched by the circle will have its stencil value set to 1. The rest will be 0. |
+ | love.graphics.stencil(myStencilFunction, "replace", 1) | ||
− | love.graphics.setStencilTest( | + | -- Only allow rendering on pixels whose stencil value is greater than 0. |
− | love.graphics.setColor( | + | love.graphics.setStencilTest("greater", 0) |
+ | love.graphics.setColor(0.6, 0, 0.5) | ||
love.graphics.polygon("fill", 400, 200, 486, 350, 314, 350) | love.graphics.polygon("fill", 400, 200, 486, 350, 314, 350) | ||
− | love.graphics.setStencilTest( | + | -- Now only allow rendering on pixels whose stencil value is equal to 0. |
− | love.graphics.setColor( | + | love.graphics.setStencilTest("equal", 0) |
+ | love.graphics.setColor(0.55, 0.85, 0.5) | ||
love.graphics.polygon("fill", 400, 200, 486, 350, 314, 350) | love.graphics.polygon("fill", 400, 200, 486, 350, 314, 350) | ||
− | love.graphics.setStencilTest( | + | love.graphics.setStencilTest() |
end | end | ||
</source> | </source> | ||
Line 82: | Line 102: | ||
== See Also == | == See Also == | ||
* [[parent::love.graphics]] | * [[parent::love.graphics]] | ||
+ | * [[love.graphics.getStencilTest]] | ||
* [[love.graphics.stencil]] | * [[love.graphics.stencil]] | ||
[[Category:Functions]] | [[Category:Functions]] | ||
− | {{#set:Description= | + | {{#set:Description=Configures or disables stencil testing.}} |
{{#set:Sub-Category=State}} | {{#set:Sub-Category=State}} | ||
== Other Languages == | == Other Languages == | ||
{{i18n|love.graphics.setStencilTest}} | {{i18n|love.graphics.setStencilTest}} |
Revision as of 00:10, 4 April 2018
Available since LÖVE 0.10.0 |
Together with love.graphics.stencil, it has replaced love.graphics.setStencil. |
Configures or disables stencil testing.
When stencil testing is enabled, the geometry of everything that is drawn afterward will be clipped / stencilled out based on a comparison between the arguments of this function and the stencil value of each pixel that the geometry touches. The stencil values of pixels are affected via love.graphics.stencil.
Starting with version 11.0, a stencil buffer must be set or requested in love.graphics.setCanvas when using stencils with a Canvas. love.graphics.setCanvas{canvas, stencil=true} is an easy way to use an automatically provided temporary stencil buffer in that case.
|
Contents
Function
Synopsis
love.graphics.setStencilTest( comparemode, comparevalue )
Arguments
CompareMode comparemode
- The type of comparison to make for each pixel.
number comparevalue
- The value to use when comparing with the stencil value of each pixel. Must be between 0 and 255.
Returns
Nothing.
Function
Disables stencil testing.
Synopsis
love.graphics.setStencilTest( )
Arguments
None.
Returns
Nothing.
Examples
Drawing circles masked by a rectangle
local function myStencilFunction()
love.graphics.rectangle("fill", 225, 200, 350, 300)
end
function love.draw()
-- draw a rectangle as a stencil. Each pixel touched by the rectangle will have its stencil value set to 1. The rest will be 0.
love.graphics.stencil(myStencilFunction, "replace", 1)
-- Only allow rendering on pixels whose stencil value is greater than 0.
love.graphics.setStencilTest("greater", 0)
love.graphics.setColor(1, 0, 0, 0.45)
love.graphics.circle("fill", 300, 300, 150, 50)
love.graphics.setColor(0, 255, 0, 0.45)
love.graphics.circle("fill", 500, 300, 150, 50)
love.graphics.setColor(0, 0, 255, 0.45)
love.graphics.circle("fill", 400, 400, 150, 50)
love.graphics.setStencilTest()
end
Drawing a circle with a hole
local function myStencilFunction()
-- Draw a small circle as a stencil. This will be the hole.
love.graphics.circle("fill", 400, 300, 50)
end
function love.draw()
-- Each pixel touched by the circle will have its stencil value set to 1. The rest will be 0.
love.graphics.stencil(myStencilFunction, "replace", 1)
-- Configure the stencil test to only allow rendering on pixels whose stencil value is equal to 0.
-- This will end up being every pixel *except* ones that were touched by the circle drawn as a stencil.
love.graphics.setStencilTest("equal", 0)
love.graphics.circle("fill", 400, 300, 150)
love.graphics.setStencilTest()
end
Drawing two masked triangles with different colors
local function myStencilFunction()
love.graphics.circle("fill", 400, 300, 60, 25)
end
function love.draw()
-- Each pixel touched by the circle will have its stencil value set to 1. The rest will be 0.
love.graphics.stencil(myStencilFunction, "replace", 1)
-- Only allow rendering on pixels whose stencil value is greater than 0.
love.graphics.setStencilTest("greater", 0)
love.graphics.setColor(0.6, 0, 0.5)
love.graphics.polygon("fill", 400, 200, 486, 350, 314, 350)
-- Now only allow rendering on pixels whose stencil value is equal to 0.
love.graphics.setStencilTest("equal", 0)
love.graphics.setColor(0.55, 0.85, 0.5)
love.graphics.polygon("fill", 400, 200, 486, 350, 314, 350)
love.graphics.setStencilTest()
end
The love.graphics.stencil wiki page includes more examples.
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