love.graphics

The primary responsibility for the love.graphics module is the drawing of lines, shapes, text, Images and other Drawable objects onto the screen. Its secondary responsibilities include loading external files (including Images and Fonts) into memory, creating specialized objects (such as ParticleSystems or Canvases) and managing screen geometry.

LÖVE's coordinate system is rooted in the upper-left corner of the screen, which is at location (0, 0). The x axis is horizontal: larger values are further to the right. The y axis is vertical: larger values are further towards the bottom.

The LÖVE coordinate system

In many cases, you draw images or shapes in terms of their upper-left corner (See the picture above).

Many of the functions are used to manipulate the graphics coordinate system, which is essentially the the way coordinates are mapped to the display. You can change the position, scale, and even rotation in this way.


Types

Canvas Off-screen render target.
Drawable Superclass for all things that can be drawn on screen.
Font Defines the shape of characters than can be drawn onto the screen.
Framebuffer Off-screen render target.
Image Drawable image type.
ParticleSystem Used to create cool effects, like fire.
PixelEffect Pixel shader effect.
Quad A quadrilateral with texture coordinate information.
SpriteBatch Store geometry in a buffer, and draw it in one call.

Functions

love.graphics.arc Draws an arc.
love.graphics.checkMode Checks if a display mode is supported.
love.graphics.circle Draws a circle.
love.graphics.clear Clears the screen to background color.
love.graphics.draw Draws objects on screen.
love.graphics.drawq Draw a Quad with the specified Image on screen.
love.graphics.getBackgroundColor Gets the current background color.
love.graphics.getBlendMode Gets the blending mode.
love.graphics.getCanvas Returns the current target Canvas.
love.graphics.getCaption Gets the window caption.
love.graphics.getColor Gets the current color.
love.graphics.getColorMode Gets the color mode (which controls how images are affected by the current color).
love.graphics.getDefaultImageFilter Returns the default scaling filters.
love.graphics.getFont Gets the current Font object.
love.graphics.getHeight Gets the height of the window.
love.graphics.getLineStipple Gets the current line stipple.
love.graphics.getLineStyle Gets the line style.
love.graphics.getLineWidth Gets the current line width.
love.graphics.getMaxPointSize Gets the max supported point size.
love.graphics.getMode Returns the current display mode.
love.graphics.getModes Gets a list of supported fullscreen modes.
love.graphics.getPixelEffect Returns the current PixelEffect.
love.graphics.getPointSize Gets the point size.
love.graphics.getPointStyle Gets the current point style.
love.graphics.getScissor Gets the current scissor box.
love.graphics.getWidth Gets the width of the window.
love.graphics.hasFocus Checks if the game window has keyboard focus.
love.graphics.isCreated Checks if the display has been set.
love.graphics.isSupported Checks for the support of graphics related functions.
love.graphics.line Draws lines between points.
love.graphics.newCanvas Creates a new Canvas.
love.graphics.newFont Creates a new Font.
love.graphics.newFramebuffer Creates a new Framebuffer.
love.graphics.newImage Creates a new Image from a file path.
love.graphics.newImageFont Creates a new font by loading a specifically formatted image.
love.graphics.newParticleSystem Creates a new ParticleSystem.
love.graphics.newPixelEffect Creates a new PixelEffect.
love.graphics.newQuad Creates a new Quad.
love.graphics.newScreenshot Creates a screenshot and returns the image data.
love.graphics.newSpriteBatch Creates a new SpriteBatch object.
love.graphics.newStencil Creates a new stencil.
love.graphics.point Draws a point.
love.graphics.polygon Draw a polygon.
love.graphics.pop Pops the current coordinate transformation from the transformation stack.
love.graphics.present Displays the results of drawing operations on the screen.
love.graphics.print Draws text on screen. If no Font is set, one will be created and set (once) if needed.
love.graphics.printf Draws formatted text, with word wrap and alignment.
love.graphics.push Copies and pushes the current coordinate transformation to the transformation stack.
love.graphics.quad Draws a quadrilateral shape.
love.graphics.rectangle Draws a rectangle.
love.graphics.reset Resets the current graphics settings.
love.graphics.rotate Rotates the coordinate system in two dimensions.
love.graphics.scale Scales the coordinate system in two dimensions.
love.graphics.setBackgroundColor Sets the background color.
love.graphics.setBlendMode Sets the blending mode.
love.graphics.setCanvas Captures drawing operations to a Canvas
love.graphics.setCaption Sets the window caption.
love.graphics.setColor Sets the color used for drawing.
love.graphics.setColorMode Sets the color mode (which controls how images are affected by the current color).
love.graphics.setDefaultImageFilter Sets the default scaling filters.
love.graphics.setFont Set an already-loaded Font as the current font.
love.graphics.setIcon Set window icon.
love.graphics.setInvertedStencil Defines an inverted stencil.
love.graphics.setLine Sets the line width and style.
love.graphics.setLineStipple Sets the line stipple pattern.
love.graphics.setLineStyle Sets the line style.
love.graphics.setLineWidth Sets the line width.
love.graphics.setMode Changes the display mode.
love.graphics.setNewFont Creates and sets a new font.
love.graphics.setPixelEffect Routes drawing operations through a pixel shader.
love.graphics.setPoint Sets the point size and style.
love.graphics.setPointSize Sets the point size.
love.graphics.setPointStyle Sets the point style.
love.graphics.setRenderTarget Captures drawing operations to a Framebuffer
love.graphics.setScissor Sets or disables scissor.
love.graphics.setStencil Defines or releases a stencil.
love.graphics.shear Shears the coordinate system.
love.graphics.toggleFullscreen Toggles fullscreen.
love.graphics.translate Translates the coordinate system in two dimensions.
love.graphics.triangle Draws a triangle.

Enums

AlignMode Text alignment.
BlendMode Different ways you do alpha blending.
ColorMode Controls how drawn images are affected by current color.
DrawMode Controls whether shapes are drawn as an outline, or filled.
FilterMode How the image is filtered when scaling.
GraphicsFeature Graphics features that can be checked for with love.graphics.isSupported.
LineStyle The styles in which lines are drawn.
PointStyle How points should be drawn.
WrapMode How the image wraps inside a large Quad.

See Also

Other Languages

Personal tools