Difference between revisions of "love.graphics.setBackgroundColor"

(See Also: Reference love.run as that's where the background color is used.)
(Example)
Line 18: Line 18:
 
=== Example ===
 
=== Example ===
 
<source lang="lua">
 
<source lang="lua">
 +
local rb, gb, bb, ab = 132, 193, 238, 255 -- range 0..255
 +
local r, g, b, a = love.math.colorFromBytes( rb, gb, bb, ab ) -- range 0-1
 +
 +
-- set background color to #84C1EE (132, 193, 238):
 +
love.graphics.setBackgroundColor(r, g, b, a)
 +
 +
 
function love.draw()
 
function love.draw()
    -- Set Background Color to #731b87 (115, 27, 135) with an alpha of 50%
+
-- draw any geometry:
    -- Note: Remember that Love uses 0-1 and not 0-255
+
love.graphics.setColor (1,1,1)
    red = 115/255
+
love.graphics.circle ('fill', 400, 300, 250)
    green = 27/255
+
love.graphics.setColor (0,0,0)
    blue = 135/255
+
love.graphics.circle ('line', 400, 300, 250)
    alpha = 50/100
 
    love.graphics.setBackgroundColor( red, green, blue, alpha)
 
 
end
 
end
 
</source>
 
</source>

Revision as of 17:06, 16 February 2024

Sets the background color.

O.png In versions prior to 11.0, color component values were within the range of 0 to 255 instead of 0 to 1.  


Function

Synopsis

love.graphics.setBackgroundColor( red, green, blue, alpha )

Arguments

number red
The red component (0-1).
number green
The green component (0-1).
number blue
The blue component (0-1).
Available since LÖVE 0.8.0
number alpha (1)
The alpha component (0-1).

Returns

Nothing.

Example

local rb, gb, bb, ab = 132, 193, 238, 255 -- range 0..255
local r, g, b, a = love.math.colorFromBytes( rb, gb, bb, ab ) -- range 0-1

-- set background color to #84C1EE (132, 193, 238):
love.graphics.setBackgroundColor(r, g, b, a)


function love.draw()
-- draw any geometry:
	love.graphics.setColor (1,1,1)
	love.graphics.circle ('fill', 400, 300, 250)
	love.graphics.setColor (0,0,0)
	love.graphics.circle ('line', 400, 300, 250)
end

Function

Available since LÖVE 0.7.0
This variant is not supported in earlier versions.

Synopsis

love.graphics.setBackgroundColor( rgb )

Arguments

table rgb
A numerical indexed table with the red, green and blue values as numbers.

Returns

Nothing.

Example

function love.draw()
    -- Set Background Color to #1b8724 (27, 135, 36)
    -- Note: Remember that Love uses 0-1 and not 0-255
    red = 27/255
    green = 135/255
    blue = 36/255
    color = { red, green, blue}
    love.graphics.setBackgroundColor( color)
end

Function

Available since LÖVE 0.8.0
This variant is not supported in earlier versions.

Synopsis

love.graphics.setBackgroundColor( rgba )

Arguments

table rgba
A numerical indexed table with the red, green, blue and alpha values as numbers.

Returns

Nothing.

Example

function love.draw()
    -- Set Background Color to #731b87 (115, 27, 135) with an alpha of 50%
    -- Note: Remember that Love uses 0-1 and not 0-255
    red = 115/255
    green = 27/255
    blue = 135/255
    alpha = 50/100
    color = { red, green, blue, alpha}
    love.graphics.setBackgroundColor( color)
end

See Also



Other Languages