BatsAndPray/lib/center

center

Center is a simple library that dynamically aligns content to the center of game window.

Setup

local center = require "center"

center:setupScreen(600, 400)

function love.draw()
  center:start()
  
  -- draw here
  
  center:finish()
end

function love.resize(width, height)
  center:resize(width, height)
end

API

setupScreen

center:setupScreen(width, height)

Initializes Center

apply

center:apply()

Applies changes.

This function is responsible for the whole alignment process, so any function (except for setupScreen and resize) will not make sense without apply() after it.

setMaxWidth

center:setMaxWidth(width)

Width of the content won't be greater than specified value (default value is 0, that means that there is no boundaries).

setMaxHeight

center:setMaxHeight(height)

Works the same as the previous one.

setMaxRelativeWidth

center:setMaxRelativeWidth(width)

The relative width of the content (actual width / available width) won't be greater than specified value (default value is 0, that means that there is no relative boundaries).

setMaxRelativeHeight

center:setMaxRelativeHeight(height)

Works the same as the previous one.

setBorders

center:setBorders(t, r, b, l)

Specify the available area for the content. Each argument represents how far the content should be placed from each side from top to left clockwise. The content is aligned to the center of this area.

For better understanding, illustrations will be added soon

start, finish

function love.draw()
  center:start()
  
  -- draw here
  
  center:finish()
end

This pair of functions is supposed to be called once inside love.draw(). Any rendering after center.finish() affect the default canvas, so you can draw UI or anything else.

toGame

center:toGame(x, y)

Return position of a point in aligned coordinate system insead of default one.