Adds a Circle effect.
This effect will draw a circle around the texture of the Game Object, effectively masking off any area outside of the circle without the need for an actual mask. You can control the thickness of the circle, the color of the circle and the color of the background, should the texture be transparent. You can also control the feathering applied to the circle, allowing for a harsh or soft edge.
Please note that adding this effect to a Game Object will not change the input area or physics body of the Game Object, should it have one.
| name | type | arguments | Default | description |
|---|---|---|---|---|
| thickness | number | <optional> | 8 |
The width of the circle around the texture, in pixels. |
| color | number | <optional> | 0xfeedb6 |
The color of the circular ring, given as a number value. |
| backgroundColor | number | <optional> | 0xff0000 |
The color of the background, behind the texture, given as a number value. |
| scale | number | <optional> | 1 |
The scale of the circle. The default scale is 1, which is a circle the full size of the underlying texture. |
| feather | number | <optional> | 0.005 |
The amount of feathering to apply to the circle from the ring. |
The Circle FX Controller.