Gets the current running version of LÖVE.
major, minor, revision, codename = love.
| major | number | The major version of LÖVE, i.e. 0 for version 0.9.1. |
| minor | number | The minor version of LÖVE, i.e. 9 for version 0.9.1. |
| revision | number | The revision version of LÖVE, i.e. 1 for version 0.9.1. |
| codename | string | The codename of the current version, i.e. "Baby Inspector" for version 0.9.1. |
If a file called conf.lua is present in your game folder (or .love file), it is run before the LÖVE modules are loaded. You can use this file to overwrite the love.conf function, which is later called by the LÖVE 'boot' script. Using the love.conf function, you can set some configuration options, and change things like the default size of the window, which modules are loaded, and other stuff.
love.
| t | table | The love.conf function takes one argument: a table filled with all the default values which you can overwrite to your liking. If you want to change the default window size, for instance, do: function love.conf(t) t.window.width = 1024 t.window.height = 768 end If you don't need the physics module or joystick module, do the following. function love.conf(t) t.modules.joystick = false t.modules.physics = false end Setting unused modules to false is encouraged when you release your game. It reduces startup time slightly (especially if the joystick module is disabled) and reduces memory usage (slightly). Note that you can't disable love.filesystem; it's mandatory. The same goes for the love module itself. love.graphics needs love.window to be enabled. |
| t.identity (nil) | string | This flag determines the name of the save directory for your game. Note that you can only specify the name, not the location where it will be created: t.identity = "gabe_HL3" -- Correct t.identity = "c:/Users/gabe/HL3" -- Incorrect Alternatively love.filesystem.setIdentity can be used to set the save directory outside of the config file. |
| t.version ("0.10.2") | string | t.version should be a string, representing the version of LÖVE for which your game was made. It should be formatted as "X.Y.Z" where X is the major release number, Y the minor, and Z the patch level. It allows LÖVE to display a warning if it isn't compatible. Its default is the version of LÖVE running. |
| t.console (false) | boolean | Determines whether a console should be opened alongside the game window (Windows only) or not. Note: On OSX you can get console output by running LÖVE through the terminal. |
| t.accelerometerjoystick (true) | boolean | Sets whether the device accelerometer on iOS and Android should be exposed as a 3-axis Joystick. Disabling the accelerometer when it's not used may reduce CPU usage. |
| t.externalstorage (false) | boolean | Sets whether files are saved in external storage (true) or internal storage (false) on Android. |
| t.gammacorrect (false) | boolean | Determines whether gamma-correct rendering is enabled, when the system supports it. |
| t.window | table | It is possible to defer window creation until love.window.setMode is first called in your code. To do so, set t.window = nil in love.conf (or t.screen = nil in older versions.) If this is done, LÖVE may crash if any function from love.graphics is called before the first love.window.setMode in your code. The t.window table was named t.screen in versions prior to 0.9.0. The t.screen table doesn't exist in love.conf in 0.9.0, and the t.window table doesn't exist in love.conf in 0.8.0. This means love.conf will fail to execute (therefore it will fall back to default values) if care is not taken to use the correct table for the LÖVE version being used. |
| t.modules | table | Module options. |
Callback function triggered when a directory is dragged and dropped onto the window.
love.
| path | string | The full platform-dependent path to the directory. It can be used as an argument to love.filesystem.mount, in order to gain read access to the directory with love.filesystem. |
The error handler, used to display error messages.
love.
| msg | string | The error message. |
Callback function triggered when a file is dragged and dropped onto the window.
love.
| file | File | The unopened File object representing the file that was dropped. |
Callback function triggered when window receives or loses focus.
love.
| focus | boolean | True if the window gains focus, false if it loses focus. |
Called when a Joystick's virtual gamepad axis is moved.
love.
| joystick | Joystick | The joystick object. |
| axis | GamepadAxis | The virtual gamepad axis. |
Called when a Joystick's virtual gamepad button is pressed.
love.
| joystick | Joystick | The joystick object. |
| button | GamepadButton | The virtual gamepad button. |
Called when a Joystick's virtual gamepad button is released.
love.
| joystick | Joystick | The joystick object. |
| button | GamepadButton | The virtual gamepad button. |
Called when a Joystick is connected.
This callback is also triggered after love.load for every Joystick which was already connected when the game started up.
love.
| joystick | Joystick | The newly connected Joystick object. |
Called when a joystick axis moves.
love.
| joystick | Joystick | The joystick object. |
| axis | number | The axis number. |
| value | number | The new axis value. |
Called when a joystick hat direction changes.
love.
| joystick | Joystick | The joystick object. |
| hat | number | The hat number. |
| direction | JoystickHat | The new hat direction. |
Called when a joystick button is pressed.
love.
| joystick | number | The joystick number. |
| button | number | The button number. |
Called when a joystick button is released.
love.
| joystick | number | The joystick number. |
| button | number | The button number. |
Called when a Joystick is disconnected.
love.
| joystick | Joystick | The now-disconnected Joystick object. |
Callback function triggered when a key is pressed.
love.
| key | KeyConstant | Character of the pressed key. |
| scancode | Scancode | The scancode representing the pressed key. |
| isrepeat | boolean | Whether this keypress event is a repeat. The delay between key repeats depends on the user's system settings. |
Callback function triggered when a keyboard key is released.
love.
| key | KeyConstant | Character of the released key. |
| scancode | Scancode | The scancode representing the released key. |
This function is called exactly once at the beginning of the game.
love.
| arg | table | Command line arguments given to the game. |
Callback function triggered when the system is running out of memory on mobile devices.
Mobile operating systems may forcefully kill the game if it uses too much memory, so any non-critical resource should be removed if possible (by setting all variables referencing the resources to nil, and calling collectgarbage()), when this event is triggered. Sounds and images in particular tend to use the most memory.
love.
Callback function triggered when window receives or loses mouse focus.
love.
| focus | boolean | Whether the window has mouse focus or not. |
Callback function triggered when the mouse is moved.
love.
| x | number | The mouse position on the x-axis. |
| y | number | The mouse position on the y-axis. |
| dx | number | The amount moved along the x-axis since the last time love.mousemoved was called. |
| dy | number | The amount moved along the y-axis since the last time love.mousemoved was called. |
| istouch | boolean | True if the mouse button press originated from a touchscreen touch-press. |
Callback function triggered when a mouse button is pressed.
love.
| x | number | Mouse x position, in pixels. |
| y | number | Mouse y position, in pixels. |
| button | number | The button index that was pressed. 1 is the primary mouse button, 2 is the secondary mouse button and 3 is the middle button. Further buttons are mouse dependent |
| isTouch | boolean | True if the mouse button press originated from a touchscreen touch-press. |
Callback function triggered when a mouse button is released.
love.
| x | number | Mouse x position, in pixels. |
| y | number | Mouse y position, in pixels. |
| button | number | The button index that was released. 1 is the primary mouse button, 2 is the secondary mouse button and 3 is the middle button. Further buttons are mouse dependent. |
| isTouch | boolean | True if the mouse button press originated from a touchscreen touch-release. |
Callback function triggered when the game is closed.
r = love.
| r | boolean | Abort quitting. If true, do not close the game. |
Called when the window is resized, for example if the user resizes the window, or if love.window.setMode is called with an unsupported width or height in fullscreen and the window chooses the closest appropriate size.
Calls to love.window.setMode will only trigger this event if the width or height of the window after the call doesn't match the requested width and height. This can happen if a fullscreen mode is requested which doesn't match any supported mode, or if the fullscreen type is 'desktop' and the requested width or height don't match the desktop resolution.
love.
| w | number | The new width. |
| h | number | The new height. |
The main function, containing the main loop. A sensible default is used when left out.
love.
Called when the candidate text for an IME (Input Method Editor) has changed.
The candidate text is not the final text that the user will eventually choose. Use love.textinput for that.
love.
| text | string | The UTF-8 encoded unicode candidate text. |
| start | number | The start cursor of the selected candidate text. |
| length | number | The length of the selected candidate text. May be 0. |
Called when text has been entered by the user. For example if shift-2 is pressed on an American keyboard layout, the text "@" will be generated.
love.
| text | string | The UTF-8 encoded unicode text. |
Callback function triggered when a Thread encounters an error.
love.
| thread | Thread | The thread which produced the error. |
| errorstr | string | The error message. |
Callback function triggered when a touch press moves inside the touch screen.
love.
| id | light userdata | The identifier for the touch press. |
| x | number | The x-axis position of the touch inside the window, in pixels. |
| y | number | The y-axis position of the touch inside the window, in pixels. |
| dx | number | The x-axis movement of the touch inside the window, in pixels. |
| dy | number | The y-axis movement of the touch inside the window, in pixels. |
| pressure | number | The amount of pressure being applied. Most touch screens aren't pressure sensitive, in which case the pressure will be 1. |
Callback function triggered when the touch screen is touched.
love.
| id | light userdata | The identifier for the touch press. |
| x | number | The x-axis position of the touch press inside the window, in pixels. |
| y | number | The y-axis position of the touch press inside the window, in pixels. |
| dx | number | The x-axis movement of the touch press inside the window, in pixels. This should always be zero. |
| dy | number | The y-axis movement of the touch press inside the window, in pixels. This should always be zero. |
| pressure | number | The amount of pressure being applied. Most touch screens aren't pressure sensitive, in which case the pressure will be 1. |
Callback function triggered when the touch screen stops being touched.
love.
| id | light userdata | The identifier for the touch press. |
| x | number | The x-axis position of the touch inside the window, in pixels. |
| y | number | The y-axis position of the touch inside the window, in pixels. |
| dx | number | The x-axis movement of the touch inside the window, in pixels. |
| dy | number | The y-axis movement of the touch inside the window, in pixels. |
| pressure | number | The amount of pressure being applied. Most touch screens aren't pressure sensitive, in which case the pressure will be 1. |
Callback function used to update the state of the game every frame.
love.
| dt | number | Time since the last update in seconds. |
Callback function triggered when window is minimized/hidden or unminimized by the user.
love.
| visible | boolean | True if the window is visible, false if it isn't. |
Callback function triggered when the mouse wheel is moved.
love.
| x | number | Amount of horizontal mouse wheel movement. Positive values indicate movement to the right. |
| y | number | Amount of vertical mouse wheel movement. Positive values indicate upward movement. |
The superclass of all data.
Gets a pointer to the Data.
pointer = Data:
| pointer | light userdata | A raw pointer to the Data. |
Superclass for all things that can be drawn on screen. This is an abstract type that can't be created directly.
The superclass of all LÖVE types.
Gets the type of the object as a string.
type = Object:
| type | string | The type as a string. |
Checks whether an object is of a certain type. If the object has the type with the specified name in its hierarchy, this function will return true.
b = Object:
| b | boolean | True if the object is of the specified type, false otherwise. |
| name | string | The name of the type to check for. |
Gets the distance attenuation model.
model = love.audio.
| model | DistanceModel | The current distance model. The default is 'inverseclamped'. |
Gets the current global scale factor for velocity-based doppler effects.
scale = love.audio.
| scale | number | The current doppler scale factor. |
Gets the number of sources which are currently playing or paused.
numSources = love.audio.
| numSources | number | The number of sources which are currently playing or paused. |
Gets the orientation of the listener.
fx, fy, fz, ux, uy, uz = love.audio.
| fx | number | The X component of the forward vector of the listener orientation. |
| fy | number | The Y component of the forward vector of the listener orientation. |
| fz | number | The Z component of the forward vector of the listener orientation. |
| ux | number | The X component of the up vector of the listener orientation. |
| uy | number | The Y component of the up vector of the listener orientation. |
| uz | number | The Z component of the up vector of the listener orientation. |
Gets the position of the listener.
x, y, z = love.audio.
| x | number | The X position of the listener. |
| y | number | The Y position of the listener. |
| z | number | The Z position of the listener. |
Gets the velocity of the listener.
x, y, z = love.audio.
| x | number | The X velocity of the listener. |
| y | number | The Y velocity of the listener. |
| z | number | The Z velocity of the listener. |
Gets the master volume.
volume = love.audio.
| volume | number | The current master volume. |
Creates a new Source from a file or SoundData. Sources created from SoundData are always static.
source = love.audio.
| source | Source | A new Source that can play the specified audio. |
| file | string / File | The path/File to create a Source from. |
| type ("stream") | SourceType | Streaming or static source. |
source = love.audio.
| source | Source | A new Source that can play the specified audio. The SourceType of the returned audio is "static". |
| soundData | SoundData / FileData | The SoundData/FileData to create a Source from. |
Pauses currently played Sources.
love.audio.
This function will pause all currently active Sources.
love.audio.
This function will only pause the specified Source.
| source | Source | The source on which to pause the playback. |
Resumes all audio
love.audio.
love.audio.
| source | Source | The source on which to resume the playback. |
Rewinds all playing audio.
love.audio.
love.audio.
| source | Source | The source to rewind. |
Sets the distance attenuation model.
love.audio.
| model | DistanceModel | The new distance model. |
Sets a global scale factor for velocity-based doppler effects. The default scale value is 1.
love.audio.
| scale | number | The new doppler scale factor. The scale must be greater than 0. |
Sets the orientation of the listener.
love.audio.
| fx | number | The X component of the forward vector of the listener orientation. |
| fy | number | The Y component of the forward vector of the listener orientation. |
| fz | number | The Z component of the forward vector of the listener orientation. |
| ux | number | The X component of the up vector of the listener orientation. |
| uy | number | The Y component of the up vector of the listener orientation. |
| uz | number | The Z component of the up vector of the listener orientation. |
Sets the position of the listener, which determines how sounds play.
love.audio.
| x | number | The X position of the listener. |
| y | number | The Y position of the listener. |
| z | number | The Z position of the listener. |
Sets the velocity of the listener.
love.audio.
| x | number | The X velocity of the listener. |
| y | number | The Y velocity of the listener. |
| z | number | The Z velocity of the listener. |
Sets the master volume.
love.audio.
| volume | number | 1.0f is max and 0.0f is off. |
Stops currently played sources.
love.audio.
This function will stop all currently active sources.
love.audio.
This function will only stop the specified source.
| source | Source | The source on which to stop the playback. |
none
Sources do not get attenuated.
inverse
Inverse distance attenuation.
inverseclamped
Inverse distance attenuation. Gain is clamped. In version 0.9.2 and older this is named inverse clamped.
linear
Linear attenuation.
linearclamped
Linear attenuation. Gain is clamped. In version 0.9.2 and older this is named linear clamped.
exponent
Exponential attenuation.
exponentclamped
Exponential attenuation. Gain is clamped. In version 0.9.2 and older this is named exponent clamped.
A Source represents audio you can play back. You can do interesting things with Sources, like set the volume, pitch, and its position relative to the listener.
Creates an identical copy of the Source in the stopped state.
Static Sources will use significantly less memory and take much less time to be created if Source:clone is used to create them instead of love.audio.newSource, so this method should be preferred when making multiple Sources which play the same sound.
Cloned Sources inherit all the set-able state of the original Source, but they are initialized stopped.
source = Source:
| source | Source | The new identical copy of this Source. |
Source:
Gets the reference and maximum distance of the source.
ref, max = Source:
| ref | number | The reference distance. |
| max | number | The maximum distance. |
Gets the number of channels in the Source. Only 1-channel (mono) Sources can use directional and positional effects.
channels = Source:
| channels | number | 1 for mono, 2 for stereo. |
Gets the Source's directional volume cones. Together with Source:setDirection, the cone angles allow for the Source's volume to vary depending on its direction.
innerAngle, outerAngle, outerVolume = Source:
| innerAngle | number | The inner angle from the Source's direction, in radians. The Source will play at normal volume if the listener is inside the cone defined by this angle. |
| outerAngle | number | The outer angle from the Source's direction, in radians. The Source will play at a volume between the normal and outer volumes, if the listener is in between the cones defined by the inner and outer angles. |
| outerVolume | number | The Source's volume when the listener is outside both the inner and outer cone angles. |
Gets the direction of the Source.
x, y, z = Source:
| x | number | The X part of the direction vector. |
| y | number | The Y part of the direction vector. |
| z | number | The Z part of the direction vector. |
Gets the duration of the Source. For streaming Sources it may not always be sample-accurate, and may return -1 if the duration cannot be determined at all.
duration = Source:
| duration | number | The duration of the Source, or -1 if it cannot be determined. |
| unit ("seconds") | TimeUnit | The time unit for the return value. |
Gets the current pitch of the Source.
pitch = Source:
| pitch | number | The pitch, where 1.0 is normal. |
Gets the position of the Source.
x, y, z = Source:
| x | number | The X position of the Source. |
| y | number | The Y position of the Source. |
| z | number | The Z position of the Source. |
Gets the rolloff factor of the source.
rolloff = Source:
| rolloff | number | The rolloff factor. |
Gets the type (static or stream) of the Source.
sourcetype = Source:
| sourcetype | SourceType | The type of the source. |
Gets the velocity of the Source.
x, y, z = Source:
| x | number | The X part of the velocity vector. |
| y | number | The Y part of the velocity vector. |
| z | number | The Z part of the velocity vector. |
Gets the current volume of the Source.
volume = Source:
| volume | number | The volume of the Source, where 1.0 is normal volume. |
Gets the volume limits of the source.
min, max = Source:
| min | number | The minimum volume. |
| max | number | The maximum volume. |
Gets whether the Source will loop.
loop = Source:
| loop | boolean | True if the Source will loop, false otherwise. |
Gets whether the Source is paused.
paused = Source:
| paused | boolean | True if the Source is paused, false otherwise. |
Gets whether the Source is playing.
playing = Source:
| playing | boolean | True if the Source is playing, false otherwise. |
Gets whether the Source is stopped.
stopped = Source:
| stopped | boolean | True if the Source is stopped, false otherwise. |
Starts playing the Source.
success = Source:
| success | boolean | True if the Source started playing successfully, false otherwise. |
Sets the playing position of the Source.
Source:
| position | number | The position to seek to. |
| unit ("seconds") | TimeUnit | The unit of the position value. |
Sets the direction vector of the Source. A zero vector makes the source non-directional.
Source:
| x | number | The X part of the direction vector. |
| y | number | The Y part of the direction vector. |
| z | number | The Z part of the direction vector. |
Source:
Sets the reference and maximum distance of the source.
Source:
| ref | number | The new reference distance. |
| max | number | The new maximum distance. |
Sets the Source's directional volume cones. Together with Source:setDirection, the cone angles allow for the Source's volume to vary depending on its direction.
Source:
| innerAngle | number | The inner angle from the Source's direction, in radians. The Source will play at normal volume if the listener is inside the cone defined by this angle. |
| outerAngle | number | The outer angle from the Source's direction, in radians. The Source will play at a volume between the normal and outer volumes, if the listener is in between the cones defined by the inner and outer angles. |
| outerVolume (0) | number | The Source's volume when the listener is outside both the inner and outer cone angles. |
Sets whether the Source should loop.
Source:
| loop | boolean | True if the source should loop, false otherwise. |
Sets the pitch of the Source.
Source:
| pitch | number | Calculated with regard to 1 being the base pitch. Each reduction by 50 percent equals a pitch shift of -12 semitones (one octave reduction). Each doubling equals a pitch shift of 12 semitones (one octave increase). Zero is not a legal value. |
Sets the position of the Source.
Source:
| x | number | The X position of the Source. |
| y | number | The Y position of the Source. |
| z | number | The Z position of the Source. |
Sets the rolloff factor which affects the strength of the used distance attenuation.
Extended information and detailed formulas can be found in the chapter "3.4. Attenuation By Distance" of OpenAL 1.1 specification.
Source:
| rolloff | number | The new rolloff factor. |
Sets the velocity of the Source.
This does not change the position of the Source, but is used to calculate the doppler effect.
Source:
| x | number | The X part of the velocity vector. |
| y | number | The Y part of the velocity vector. |
| z | number | The Z part of the velocity vector. |
Sets the volume of the Source.
Source:
| volume | number | The volume of the Source, where 1.0 is normal volume. |
Sets the volume limits of the source. The limits have to be numbers from 0 to 1.
Source:
| min | number | The minimum volume. |
| max | number | The maximum volume. |
Gets the currently playing position of the Source.
position = Source:
| position | number | The currently playing position of the Source. |
| unit ("seconds") | TimeUnit | The type of unit for the return value. |
Gets an iterator for messages in the event queue.
i = love.event.
| i | function | Iterator function usable in a for loop. |
Pump events into the event queue. This is a low-level function, and is usually not called by the user, but by love.run. Note that this does need to be called for any OS to think you're still running, and if you want to handle OS-generated events at all (think callbacks). love.event.pump can only be called from the main thread, but afterwards, the rest of love.event can be used from any other thread.
love.event.
Adds an event to the event queue.
love.event.
| e | Event | The name of the event. |
| a (nil) | Variant | First event argument. |
| b (nil) | Variant | Second event argument. |
| c (nil) | Variant | Third event argument. |
| d (nil) | Variant | Fourth event argument. |
Adds the quit event to the queue.
The quit event is a signal for the event handler to close LÖVE. It's possible to abort the exit process with the love.quit callback.
love.event.
love.event.
| exitstatus (0) | number | The program exit status to use when closing the application. |
love.event.
| "restart" | string | Restarts the game without relaunching the executable. This cleanly shuts down the main Lua state instance and creates a brand new one. |
Like love.event.poll but blocks until there is an event in the queue.
e, a, b, c, d = love.event.
| e | Event | The type of event. |
| a | Variant | First event argument. |
| b | Variant | Second event argument. |
| c | Variant | Third event argument. |
| d | Variant | Fourth event argument. |
focus
Window focus gained or lost
joystickaxis
Joystick axis motion
joystickhat
Joystick hat pressed
joystickpressed
Joystick pressed
joystickreleased
Joystick released
keypressed
Key pressed
keyreleased
Key released
mousefocus
Window mouse focus gained or lost
mousepressed
Mouse pressed
mousereleased
Mouse released
resize
Window size changed by the user
threaderror
A Lua error has occurred in a thread.
quit
Quit
visible
Window is minimized or un-minimized by the user
Append data to an existing file.
success, errormsg = love.filesystem.
| success | boolean | True if the operation was successful, or nil if there was an error. |
| errormsg | string | The error message on failure. |
| name | string | The name (and path) of the file. |
| data | string | The data that should be written to the file |
| size (all) | number | How many bytes to write. |
love.filesystem.
Gets whether love.filesystem follows symbolic links.
enable = love.filesystem.
| enable | boolean | Whether love.filesystem follows symbolic links. |
love.filesystem.
Creates a directory.
success = love.filesystem.
| success | boolean | True if the directory was created, false if not. |
| name | string | The directory to create. |
Check whether a file or directory exists.
exists = love.filesystem.
| exists | boolean | True if there is a file or directory with the specified name. False otherwise. |
| filename | string | The path to a potential file or directory. |
love.filesystem.
Gets the application data directory (could be the same as getUserDirectory)
path = love.filesystem.
| path | string | The path of the application data directory. |
love.filesystem.
Gets a table with the names of files and subdirectories in the specified path. The table is not sorted in any way; the order is undefined.
If the path passed to the function exists in the game and the save directory, it will list the files and directories from both places.
items = love.filesystem.
| items | table | A sequence with the names of all files and subdirectories as strings. |
| dir | string | The directory. |
Gets the write directory name for your game. Note that this only returns the name of the folder to store your files in, not the full location.
love.filesystem.
| name | string | The identity that is used as write directory. |
love.filesystem.
Gets the last modification time of a file.
modtime, errormsg = love.filesystem.
| modtime | number | The last modification time in seconds since the unix epoch or nil on failure. |
| errormsg | string | The error message on failure. |
| filename | string | The path and name to a file. |
love.filesystem.
Gets the platform-specific absolute path of the directory containing a filepath.
This can be used to determine whether a file is inside the save directory or the game's source .love.
realdir = love.filesystem.
| realdir | string | The platform-specific full path of the directory containing the filepath. |
| filepath | string | The filepath to get the directory of. |
love.filesystem.
Gets the filesystem paths that will be searched when require is called.
The paths string returned by this function is a sequence of path templates separated by semicolons. The argument passed to require will be inserted in place of any question mark ("?") character in each template (after the dot characters in the argument passed to require are replaced by directory separators.)
The paths are relative to the game's source and save directories, as well as any paths mounted with love.filesystem.mount.
paths = love.filesystem.
| paths | string | The paths that the require function will check in love's filesystem. |
love.filesystem.
Gets the full path to the designated save directory. This can be useful if you want to use the standard io library (or something else) to read or write in the save directory.
path = love.filesystem.
| path | string | The absolute path to the save directory. |
Gets the size in bytes of a file.
size, errormsg = love.filesystem.
| size | number | The size in bytes of the file, or nil on failure. |
| errormsg | string | The error message on failure. |
| filename | string | The path and name to a file. |
Gets the full path to the the .love file or directory. If the game is fused to the LÖVE executable, then the executable is returned.
path = love.filesystem.
| path | string | The full platform-dependent path of the .love file or directory. |
love.filesystem.
Gets the full path to the directory containing the .love file. If the game is fused to the LÖVE executable, then the directory containing the executable is returned.
If love.filesystem.isFused is true, the path returned by this function can be passed to love.filesystem.mount, which will make the directory containing the main game readable by love.filesystem.
path = love.filesystem.
| path | string | The full platform-dependent path of the directory containing the .love file. |
love.filesystem.
Gets the path of the user's directory.
path = love.filesystem.
| path | string | The path of the user's directory. |
love.filesystem.
Gets the current working directory.
path = love.filesystem.
| path | string | The current working directory. |
Initializes love.filesystem, will be called internally, so should not be used explicitly.
love.filesystem.
| appname | string | The name of the application binary, typically love. |
Check whether something is a directory.
isDir = love.filesystem.
| isDir | boolean | True if there is a directory with the specified name. False otherwise. |
| path | string | The path to a potential directory. |
Check whether something is a file.
isFile = love.filesystem.
| isFile | boolean | True if there is a file with the specified name. False otherwise. |
| path | string | The path to a potential file. |
Gets whether the game is in fused mode or not.
If a game is in fused mode, its save directory will be directly in the Appdata directory instead of Appdata/LOVE/. The game will also be able to load C Lua dynamic libraries which are located in the save directory.
A game is in fused mode if the source .love has been fused to the executable (see Game Distribution), or if "--fused" has been given as a command-line argument when starting the game.
fused = love.filesystem.
| fused | boolean | True if the game is in fused mode, false otherwise. |
Gets whether a filepath is actually a symbolic link.
If symbolic links are not enabled (via love.filesystem.setSymlinksEnabled), this function will always return false.
symlink = love.filesystem.
| symlink | boolean | True if the path is a symbolic link, false otherwise. |
| path | string | The file or directory path to check. |
Iterate over the lines in a file.
iterator = love.filesystem.
| iterator | function | A function that iterates over all the lines in the file. |
| name | string | The name (and path) of the file. |
Loads a Lua file (but does not run it).
chunk = love.filesystem.
| chunk | function | The loaded chunk. |
| name | string | The name (and path) of the file. |
| errormsg (nil) | string | The error message if file could not be opened. |
Mounts a zip file or folder in the game's save directory for reading.
success = love.filesystem.
| success | boolean | True if the archive was successfully mounted, false otherwise. |
| archive | string | The folder or zip file in the game's save directory to mount. |
| mountpoint | string | The new path the archive will be mounted to. |
| appendToPath (false) | string | Whether the archive will be searched when reading a filepath before or after already-mounted archives. This includes the game's source and save directories. |
Creates a new File object. It needs to be opened before it can be accessed.
file, errorstr = love.filesystem.
| file | File | The new File object, or nil if an error occurred. |
| errorstr | string | The error string if an error occurred. |
| filename | string | The filename of the file to read. |
| mode ("c") | FileMode | The mode to open the file in. |
Creates a new FileData object.
data = love.filesystem.
| data | FileData | Your new FileData. |
| contents | string | The contents of the file. |
| name | string | The name of the file. |
| decoder ("file") | FileDecoder | The method to use when decoding the contents. |
data, err = love.filesystem.
Creates a new FileData from a file on the storage device.
| data | FileData | The new FileData, or nil if an error occurred. |
| err | string | The error string, if an error occurred. |
| filepath | string | Path to the file. |
Read the contents of a file.
contents, size = love.filesystem.
| contents | string | The file contents. |
| size | number | How many bytes have been read. |
| name | string | The name (and path) of the file. |
| bytes (all) | number | How many bytes to read. |
Removes a file or directory.
success = love.filesystem.
| success | boolean | True if the file/directory was removed, false otherwise. |
| name | string | The file or directory to remove. |
Sets the write directory for your game. Note that you can only set the name of the folder to store your files in, not the location.
love.filesystem.
| name | string | The new identity that will be used as write directory. |
| appendToPath (false) | boolean | Whether the identity directory will be searched when reading a filepath before or after the game's source directory and any currently mounted archives. |
love.filesystem.
Sets the filesystem paths that will be searched when require is called.
The paths string given to this function is a sequence of path templates separated by semicolons. The argument passed to require will be inserted in place of any question mark ("?") character in each template (after the dot characters in the argument passed to require are replaced by directory separators.)
The paths are relative to the game's source and save directories, as well as any paths mounted with love.filesystem.mount.
love.filesystem.
| paths | string | The paths that the require function will check in love's filesystem. |
Sets the source of the game, where the code is present. This function can only be called once, and is normally automatically done by LÖVE.
love.filesystem.
| path | string | Absolute path to the game's source folder. |
love.filesystem.
Sets whether love.filesystem follows symbolic links. It is enabled by default in version 0.10.0 and newer, and disabled by default in 0.9.2.
love.filesystem.
| enable | boolean | Whether love.filesystem should follow symbolic links. |
Unmounts a zip file or folder previously mounted for reading with love.filesystem.mount.
success = love.filesystem.
| success | boolean | True if the archive was successfully unmounted, false otherwise. |
| archive | string | The folder or zip file in the game's save directory which is currently mounted. |
Write data to a file.
If you are getting the error message "Could not set write directory", try setting the save directory. This is done either with love.filesystem.setIdentity or by setting the identity field in love.conf.
success, message = love.filesystem.
| success | boolean | If the operation was successful. |
| message | string | Error message if operation was unsuccessful. |
| name | string | The name (and path) of the file. |
| data | string | The string data to write to the file. |
| size (all) | number | How many bytes to write. |
success, message = love.filesystem.
| success | boolean | If the operation was successful. |
| message | string | Error message if operation was unsuccessful. |
| name | string | The name (and path) of the file. |
| data | Data | The Data object to write to the file. |
| size (all) | number | How many bytes to write. |
none
No buffering. The result of write and append operations appears immediately.
line
Line buffering. Write and append operations are buffered until a newline is output or the buffer size limit is reached.
full
Full buffering. Write and append operations are always buffered until the buffer size limit is reached.
r
Open a file for read.
w
Open a file for write.
a
Open a file for append.
c
Do not open a file (represents a closed file.)
Represents a file on the filesystem.
Flushes any buffered written data in the file to the disk.
success, err = File:
| success | boolean | Whether the file successfully flushed any buffered data to the disk. |
| err | string | The error string, if an error occurred and the file could not be flushed. |
Gets the buffer mode of a file.
mode, size = File:
| mode | BufferMode | The current buffer mode of the file. |
| size | number | The maximum size in bytes of the file's buffer. |
Gets the filename that the File object was created with. If the file object originated from the love.filedropped callback, the filename will be the full platform-dependent file path.
filename = File:
| filename | string | The filename of the File. |
Gets the FileMode the file has been opened with.
mode = File:
| mode | FileMode | The mode this file has been opened with. |
Gets whether end-of-file has been reached.
eof = File:
| eof | boolean | Whether EOF has been reached. |
Gets whether the file is open.
open = File:
| open | boolean | True if the file is currently open, false otherwise. |
Iterate over all the lines in a file
iterator = File:
| iterator | function | The iterator (can be used in for loops) |
Open the file for write, read or append.
If you are getting the error message "Could not set write directory", try setting the save directory. This is done either with love.filesystem.setIdentity or by setting the identity field in love.conf.
success = File:
| success | boolean | True on success, false otherwise. |
| mode | FileMode | The mode to open the file in. |
Read a number of bytes from a file.
contents, size = File:
| contents | string | The contents of the read bytes. |
| size | number | How many bytes have been read. |
| bytes (all) | number | The number of bytes to read |
Seek to a position in a file.
success = File:
| success | boolean | Whether the operation was successful. |
| position | number | The position to seek to. |
Sets the buffer mode for a file opened for writing or appending. Files with buffering enabled will not write data to the disk until the buffer size limit is reached, depending on the buffer mode.
success, errorstr = File:
| success | boolean | Whether the buffer mode was successfully set. |
| errorstr | string | The error string, if the buffer mode could not be set and an error occurred. |
| mode | BufferMode | The buffer mode to use. |
| size (0) | number | The maximum size in bytes of the file's buffer. |
Write data to a file.
success = File:
| success | boolean | Whether the operation was successful. |
| data | string | The data to write. |
| size (all) | number | How many bytes to write. |
Data representing the contents of a file.
Gets the extension of the FileData.
ext = FileData:
| ext | string | The extension of the file the FileData represents. |
Gets the filename of the FileData.
name = FileData:
| name | string | The name of the file the FileData represents. |
Draws a filled or unfilled arc at position (x, y). The arc is drawn from angle1 to angle2 in radians. The segments parameter determines how many segments are used to draw the arc. The more segments, the smoother the edge.
love.graphics.
| drawmode | DrawMode | How to draw the arc. |
| arctype ("pie") | ArcType | The type of arc to draw. |
| x | number | The position of the center along x-axis. |
| y | number | The position of the center along y-axis. |
| radius | number | Radius of the arc. |
| angle1 | number | The angle at which the arc begins. |
| angle2 | number | The angle at which the arc terminates. |
| segments (10) | number | The number of segments used for drawing the arc. |
Draws a circle.
love.graphics.
| mode | DrawMode | How to draw the circle. |
| x | number | The position of the center along x-axis. |
| y | number | The position of the center along y-axis. |
| radius | number | The radius of the circle. |
love.graphics.
| mode | DrawMode | How to draw the circle. |
| x | number | The position of the center along x-axis. |
| y | number | The position of the center along y-axis. |
| radius | number | The radius of the circle. |
| segments | number | The number of segments used for drawing the circle. Note: The default variable for the segments parameter varies between different versions of LÖVE. |
Clears the screen to the background color in LÖVE 0.9.2 and earlier, or to the specified color in 0.10.0 and newer.
This function is called automatically before love.draw in the default love.run function. See the example in love.run for a typical use of this function.
Note that the scissor area bounds the cleared region.
love.graphics.
Clears the screen to the background color in 0.9.2 and earlier, or to transparent black (0, 0, 0, 0) in LÖVE 0.10.0 and newer.
love.graphics.
Clears the screen or active Canvas to the specified color.
| r | number | The red channel of the color to clear the screen to. |
| g | number | The green channel of the color to clear the screen to. |
| b | number | The blue channel of the color to clear the screen to. |
| a (255) | number | The alpha channel of the color to clear the screen to. |
love.graphics.
Clears multiple active Canvases to different colors, if multiple Canvases are active at once via love.graphics.setCanvas.
| color | table | A table in the form of {r, g, b, a} containing the color to clear the first active Canvas to. |
| ... | table | Additional tables for each active Canvas. |
Discards (trashes) the contents of the screen or active Canvas. This is a performance optimization function with niche use cases.
If the active Canvas has just been changed and the "replace" BlendMode is about to be used to draw something which covers the entire screen, calling love.graphics.discard rather than calling love.graphics.clear or doing nothing may improve performance on mobile devices.
On some desktop systems this function may do nothing.
love.graphics.
| discardcolor (true) | boolean | Whether to discard the texture(s) of the active Canvas(es) (the contents of the screen if no Canvas is active). |
| discardstencil (true) | boolean | Whether to discard the contents of the stencil buffer of the screen / active Canvas. |
love.graphics.
| discardcolors | table | An array containing boolean values indicating whether to discard the texture of each active Canvas, when multiple simultaneous Canvases are active. |
| discardstencil (true) | boolean | Whether to discard the contents of the stencil buffer of the screen / active Canvas. |
Draws a Drawable object (an Image, Canvas, SpriteBatch, ParticleSystem, Mesh, or Video) on the screen with optional rotation, scaling and shearing.
Objects are drawn relative to their local coordinate system. The origin is by default located at the top left corner of Image and Canvas. All scaling, shearing, and rotation arguments transform the object relative to that point. Also, the position of the origin can be specified on the screen coordinate system.
It's possible to rotate an object about its center by offsetting the origin to the center. Angles must be given in radians for rotation. One can also use a negative scaling factor to flip about its centerline.
Note that the offsets are applied before rotation, scaling, or shearing; scaling and shearing are applied before rotation.
The right and bottom edges of the object are shifted at an angle defined by the shearing factors.
love.graphics.
| drawable | Drawable | A drawable object. |
| x (0) | number | The position to draw the object (x-axis). |
| y (0) | number | The position to draw the object (y-axis). |
| r (0) | number | Orientation (radians). |
| sx (1) | number | Scale factor (x-axis). Can be negative. |
| sy (sx) | number | Scale factor (y-axis). Can be negative. |
| ox (0) | number | Origin offset (x-axis). (A value of 20 would effectively move your drawable object 20 pixels to the left.) |
| oy (0) | number | Origin offset (y-axis). (A value of 20 would effectively move your drawable object 20 pixels up.) |
| kx (0) | number | Shearing factor (x-axis). |
| ky (0) | number | Shearing factor (y-axis). |
love.graphics.
| texture | Texture | A Texture (Image or Canvas) to texture the Quad with. |
| quad | Quad | The Quad to draw on screen. |
| x (0) | number | The position to draw the object (x-axis). |
| y (0) | number | The position to draw the object (y-axis). |
| r (0) | number | Orientation (radians). |
| sx (1) | number | Scale factor (x-axis). Can be negative. |
| sy (sx) | number | Scale factor (y-axis). Can be negative. |
| ox (0) | number | Origin offset (x-axis). |
| oy (0) | number | Origin offset (y-axis) |
| kx (0) | number | Shearing factor (x-axis). |
| ky (0) | number | Shearing factor (y-axis). |
Draws an ellipse.
love.graphics.
| mode | DrawMode | How to draw the ellipse. |
| x | number | The position of the center along x-axis. |
| y | number | The position of the center along y-axis. |
| radiusx | number | The radius of the ellipse along the x-axis (half the ellipse's width). |
| radiusy | number | The radius of the ellipse along the y-axis (half the ellipse's height). |
| segments (based on size) | number | The number of segments used for drawing the ellipse. |
love.graphics.
Gets the current background color.
r, g, b, a = love.graphics.
| r | number | The red component (0-255). |
| g | number | The green component (0-255). |
| b | number | The blue component (0-255). |
| a | number | The alpha component (0-255). |
Gets the blending mode.
mode, alphamode = love.graphics.
| mode | BlendMode | The current blend mode. |
| alphamode | BlendAlphaMode | The current blend alpha mode – it determines how the alpha of drawn objects affects blending. |
Gets the current target Canvas.
canvas = love.graphics.
| canvas | Canvas | The Canvas set by setCanvas. Returns nil if drawing to the real screen. |
love.graphics.
Gets the available Canvas formats, and whether each is supported.
formats = love.graphics.
| formats | table | A table containing CanvasFormats as keys, and a boolean indicating whether the format is supported as values. Not all systems support all formats. |
Gets the current color.
r, g, b, a = love.graphics.
| r | number | The red component (0-255). |
| g | number | The red component (0-255). |
| b | number | The blue component (0-255). |
| a | number | The alpha component (0-255). |
Gets the active color components used when drawing. Normally all 4 components are active unless love.graphics.setColorMask has been used.
The color mask determines whether individual components of the colors of drawn objects will affect the color of the screen. They affect love.graphics.clear and Canvas:clear as well.
r, g, b, a = love.graphics.
| r | boolean | Whether the red color component is active when rendering. |
| g | boolean | Whether the green color component is active when rendering. |
| b | boolean | Whether the blue color component is active when rendering. |
| a | boolean | Whether the alpha color component is active when rendering. |
love.graphics.
Gets the available compressed image formats, and whether each is supported.
formats = love.graphics.
| formats | table | A table containing CompressedFormats as keys, and a boolean indicating whether the format is supported as values. Not all systems support all formats. |
love.graphics.
Gets the default scaling filters used with Images, Canvases, and Fonts.
min, mag, anisotropy = love.graphics.
| min | FilterMode | Filter mode used when scaling the image down. |
| mag | FilterMode | Filter mode used when scaling the image up. |
| anisotropy | number | Maximum amount of Anisotropic Filtering used. |
Gets the width and height of the window.
width, height = love.graphics.
| width | number | The width of the window. |
| height | number | The height of the window. |
Gets the current Font object.
font = love.graphics.
| font | Font | The current Font, or nil if none is set. |
Gets the height of the window.
height = love.graphics.
| height | number | The height of the window. |
Gets the current line width.
width = love.graphics.
| width | number | The current line width. |
Gets the current Shader. Returns nil if none is set.
shader = love.graphics.
| shader | Shader | The current Shader. |
Gets performance-related rendering statistics.
stats = love.graphics.
| stats | table | A table with the following fields: |
| stats.drawcalls | number | The number of draw calls made so far during the current frame. |
| stats.canvasswitches | number | The number of times the active Canvas has been switched so far during the current frame. |
| stats.texturememory | number | The estimated total size in bytes of video memory used by all loaded Images, Canvases, and Fonts. |
| stats.images | number | The number of Image objects currently loaded. |
| stats.canvases | number | The number of Canvas objects currently loaded. |
| stats.fonts | number | The number of Font objects currently loaded. |
| stats.shaderswitches | number | The number of times the active Shader has been changed so far during the current frame. |
Gets whether stencil testing is enabled.
When stencil testing is enabled, the geometry of everything that is drawn will be clipped / stencilled out based on whether it intersects with what has been previously drawn to the stencil buffer.
Each Canvas has its own stencil buffer.
enabled, inverted = love.graphics.
| enabled | boolean | Whether stencil testing is enabled. |
| inverted | boolean | Whether the stencil test is inverted or not. |
Gets the optional graphics features and whether they're supported on the system.
Some older or low-end systems don't always support all graphics features.
features = love.graphics.
| features | table | A table containing GraphicsFeature keys, and boolean values indicating whether each feature is supported. |
Gets the system-dependent maximum values for love.graphics features.
limits = love.graphics.
| limits | table | A table containing GraphicsLimit keys, and number values. |
Gets the point size.
size = love.graphics.
| size | number | The current point size. |
Gets information about the system's video card and drivers.
name, version, vendor, device = love.graphics.
| name | string | The name of the renderer, e.g. "OpenGL" or "OpenGL ES". |
| version | string | The version of the renderer with some extra driver-dependent version info, e.g. "2.1 INTEL-8.10.44". |
| vendor | string | The name of the graphics card vendor, e.g. "Intel Inc". |
| device | string | The name of the graphics card, e.g. "Intel HD Graphics 3000 OpenGL Engine". |
Gets the current scissor box.
x, y, width, height = love.graphics.
| x | number | The x component of the top-left point of the box. |
| y | number | The y component of the top-left point of the box. |
| width | number | The width of the box. |
| height | number | The height of the box. |
Gets the width of the window.
width = love.graphics.
| width | number | The width of the window. |
love.graphics.
Sets the scissor to the rectangle created by the intersection of the specified rectangle with the existing scissor. If no scissor is active yet, it behaves like love.graphics.setScissor.
The scissor limits the drawing area to a specified rectangle. This affects all graphics calls, including love.graphics.clear.
The dimensions of the scissor is unaffected by graphical transformations (translate, scale, ...).
love.graphics.
Limits the drawing area to a specified rectangle.
| x | number | The x-coordinate of the upper left corner of the rectangle to intersect with the existing scissor rectangle. |
| y | number | The y-coordinate of the upper left corner of the rectangle to intersect with the existing scissor rectangle. |
| width | number | The width of the rectangle to intersect with the existing scissor rectangle. |
| height | number | The height of the rectangle to intersect with the existing scissor rectangle. |
love.graphics.
Disables scissor.
Gets whether gamma-correct rendering is supported and enabled. It can be enabled by setting t.gammacorrect = true in love.conf.
Not all devices support gamma-correct rendering, in which case it will be automatically disabled and this function will return false. It is supported on desktop systems which have graphics cards that are capable of using OpenGL 3 / DirectX 10, and iOS devices that can use OpenGL ES 3.
gammacorrect = love.graphics.
| gammacorrect | boolean | True if gamma-correct rendering is supported and was enabled in love.conf, false otherwise. |
Gets whether wireframe mode is used when drawing.
wireframe = love.graphics.
| wireframe | boolean | True if wireframe lines are used when drawing, false if it's not. |
Draws lines between points.
love.graphics.
| x1 | number | The position of first point on the x-axis. |
| y1 | number | The position of first point on the y-axis. |
| x2 | number | The position of second point on the x-axis. |
| y2 | number | The position of second point on the y-axis. |
| ... | number | You can continue passing point positions to draw a polyline. |
love.graphics.
| points | table | A table of point positions. |
Creates a new Canvas object for offscreen rendering.
Antialiased Canvases have slightly higher system requirements than normal Canvases. Additionally, the supported maximum number of MSAA samples varies depending on the system. Use love.graphics.getSystemLimit to check.
If the number of MSAA samples specified is greater than the maximum supported by the system, the Canvas will still be created but only using the maximum supported amount (this includes 0.)
canvas = love.graphics.
| canvas | Canvas | A new Canvas object. |
| width (window width) | number | The width of the Canvas. |
| height (window height) | number | The height of the Canvas. |
| format ("normal") | CanvasFormat | The desired texture mode of the Canvas. |
| msaa (0) | number | The desired number of antialiasing samples used when drawing to the Canvas. |
Creates a new Font from a TrueType Font or BMFont file. Created fonts are not cached, in that calling this function with the same arguments will always create a new Font object.
font = love.graphics.
| font | Font | A Font object which can be used to draw text on screen. |
| file | string / File / FileData | The file/File/FileData of the TrueType font file. |
| size (12) | number | The size of the font in pixels. |
font = love.graphics.
| font | Font | A Font object which can be used to draw text on screen. |
| file | string / File / FileData | The path/File/FileData of the BMFont file. |
| imagefilename (path inside BMFont file) | string / File / FileData | The path/File/FileData of the BMFont's image file. |
font = love.graphics.
Create a new instance of the default font (Vera Sans) with a custom size.
| font | Font | A Font object which can be used to draw text on screen. |
| size | number | The size of the font in pixels. |
Creates a new Mesh.
Use Mesh:setTexture if the Mesh should be textured with an Image or Canvas when it's drawn.
mesh = love.graphics.
Creates a Mesh with custom vertex attributes and the specified vertex data.
| mesh | Mesh | The new Mesh. |
| vertexformat (none) | table | A table in the form of {attribute, ...}. Each attribute is a table which specifies a custom vertex attribute used for each vertex. |
| vertexformat.attribute | table | A table containing the attribute's name, it's data type, and the number of components in the attribute, in the form of {name, datatype, components}. |
| vertexformat.... | table | Additional vertex attribute format tables. |
| vertices | table | The table filled with vertex information tables for each vertex, in the form of {vertex, ...} where each vertex is a table in the form of {attributecomponent, ...}. |
| vertices.attributecomponent | number | The first component of the first vertex attribute in the vertex. |
| vertices.... | number | Additional components of all vertex attributes in the vertex. |
| mode ("fan") | MeshDrawMode | How the vertices are used when drawing. The default mode "fan" is sufficient for simple convex polygons. |
| usage ("dynamic") | SpriteBatchUsage | The expected usage of the Mesh. The specified usage mode affects the Mesh's memory usage and performance. |
mesh = love.graphics.
Creates a Mesh with custom vertex attributes and the specified number of vertices.
| mesh | Mesh | The new Mesh. |
| vertexformat (none) | table | A table in the form of {attribute, ...}. Each attribute is a table which specifies a custom vertex attribute used for each vertex. |
| vertexformat.attribute | table | A table containing the attribute's name, it's data type, and the number of components in the attribute, in the form of {name, datatype, components}. |
| vertexformat.... | table | Additional vertex attribute format tables. |
| vertexcount | number | The total number of vertices the Mesh will use. |
| mode ("fan") | MeshDrawMode | How the vertices are used when drawing. The default mode "fan" is sufficient for simple convex polygons. |
| usage ("dynamic") | SpriteBatchUsage | The expected usage of the Mesh. The specified usage mode affects the Mesh's memory usage and performance. |
Creates a new Image from a filepath, FileData, an ImageData, or a CompressedImageData, and optionally generates or specifies mipmaps for the image.
Images using CompressedImageData will use it to reload itself when love.window.setMode is called.
image = love.graphics.
| image | Image | An Image object which can be drawn on screen. |
| file | path / File / FileData / ImageData / CompressedImageData | The file path/File/FileData/ImageData/CompressedImageData of the image. |
| flags | table | A table containing the following fields: |
| flags.linear (false) | boolean | True if the image's pixels should be interpreted as being linear RGB rather than sRGB-encoded, if gamma-correct rendering is enabled. Has no effect otherwise. |
| flags.mipmaps (false) | boolean or table | If true, mipmaps for the image will be automatically generated (or taken from the images's file if possible, if the image originated from a CompressedImageData). If this value is a table, it should contain a list of other filenames of images of the same format that have progressively half-sized dimensions, all the way down to 1x1. Those images will be used as this Image's mipmap levels. |
Creates a new Font by loading a specifically formatted image.
In versions prior to 0.9.0, LÖVE expects ISO 8859-1 encoding for the glyphs string.
font = love.graphics.
| font | Font | A Font object which can be used to draw text on screen. |
| file | path / File / FileData | The file path/File/FileData of the image file. |
| glyphs | string | A string of the characters in the image in order from left to right. |
| extraspacing (0) | number | Additional spacing (positive or negative) to apply to each glyph in the Font. |
love.graphics.
Creates a new ParticleSystem.
system = love.graphics.
| system | ParticleSystem | A new ParticleSystem. |
| texture | Texture | The Image or Canvas to use. |
| buffer (1000) | number | The max number of particles at the same time. |
Creates a new Shader object for hardware-accelerated vertex and pixel effects. A Shader contains either vertex shader code, pixel shader code, or both.
Vertex shader code must contain at least one function, named position, which is the function that will produce transformed vertex positions of drawn objects in screen-space.
Pixel shader code must contain at least one function, named effect, which is the function that will produce the color which is blended onto the screen for each pixel a drawn object touches.
shader = love.graphics.
| shader | Shader | A Shader object for use in drawing operations. |
| code | string / File / FileData | The pixel shader or vertex shader code, or a file with the code. |
shader = love.graphics.
| shader | Shader | A Shader object for use in drawing operations. |
| pixelcode | string / File / FileData | The pixel shader code, or a file with the code. |
| vertexcode | string / File / FileData | The vertex shader code, or a file with the code. |
Creates a new Font.
text = love.graphics.
| text | Text | The new drawable Text object. |
| font | Font | The font to use for the text. |
| textstring (nil) | string | The initial string of text that the new Text object will contain. May be nil. |
Creates a new Quad.
The purpose of a Quad is to describe the result of the following transformation on any drawable object. The object is first scaled to dimensions sw * sh. The Quad then describes the rectangular area of dimensions width * height whose upper left corner is at position (x, y) inside the scaled object.
quad = love.graphics.
| quad | Quad | The new Quad. |
| x | number | The top-left position along the x-axis. |
| y | number | The top-left position along the y-axis. |
| width | number | The width of the Quad. |
| height | number | The height of the Quad. |
| sw | number | The reference width, the width of the Image. |
| sh | number | The reference height, the height of the Image. |
Creates a screenshot and returns the image data.
screenshot = love.graphics.
| screenshot | ImageData | The image data of the screenshot. |
| copyAlpha (false) | boolean | Whether to include the screen's alpha channel in the ImageData. If false, the screenshot will be fully opaque. |
Creates a new SpriteBatch object.
spriteBatch = love.graphics.
| spriteBatch | SpriteBatch | The new SpriteBatch. |
| texture | Texture | The Image or Canvas to use for the sprites. |
| maxsprites (1000) | number | The max number of sprites. |
| usage ("dynamic") | SpriteBatchUsage | The expected usage of the SpriteBatch. The specified usage mode affects the SpriteBatch's memory usage and performance. |
Creates a new drawable Video. Currently only Ogg Theora video files are supported.
video = love.graphics.
| video | Video | A new Video. |
| file | string / File | The file path/File of the Ogg Theora video file. |
| loadaudio (nil) | boolean | Whether to try to load the video's audio into an audio Source. If not explicitly set to true or false, it will try without causing an error if the video has no audio. |
Resets the current coordinate transformation.
This function is always used to reverse any previous calls to love.graphics.rotate, love.graphics.scale, love.graphics.shear or love.graphics.translate. It returns the current transformation state to its defaults.
love.graphics.
Draws one or more points.
love.graphics.
| x | number | The position of the first point on the x-axis. |
| y | number | The position of the first point on the y-axis. |
| ... | number | The x and y coordinates of additional points. |
love.graphics.
| points | table | A table containing multiple point positions, in the form of {x, y, ...}. |
| points.x | number | The position of the first point on the x-axis. |
| points.y | number | The position of the first point on the y-axis. |
| points.... | number | The x and y coordinates of additional points. |
love.graphics.
| points | table | A table containing multiple individually colored points, in the form of {point, ...}. Each table contains the position and color of a point in the form of {x, y, r, g, b, a}. The color components are optional. |
| points.point | table | A table containing the position and color of the first point, in the form of {x, y, r, g, b, a}. The color components are optional. |
| points.... | table | Additional tables containing the position and color of more points, in the form of {x, y, r, g, b, a}. The color components are optional. |
Draw a polygon.
Following the mode argument, this function can accept multiple numeric arguments or a single table of numeric arguments. In either case the arguments are interpreted as alternating x and y coordinates of the polygon's vertices.
When in fill mode, the polygon must be convex and simple or rendering artifacts may occur.
love.graphics.
| mode | DrawMode | How to draw the polygon. |
| ... | number | The vertices of the polygon. |
love.graphics.
| mode | DrawMode | How to draw the polygon. |
| vertices | table | The vertices of the polygon as a table. |
Pops the current coordinate transformation from the transformation stack.
This function is always used to reverse a previous push operation. It returns the current transformation state to what it was before the last preceding push. For an example, see the description of love.graphics.push.
love.graphics.
Displays the results of drawing operations on the screen.
This function is used when writing your own love.run function. It presents all the results of your drawing operations on the screen. See the example in love.run for a typical use of this function.
love.graphics.
Draws text on screen. If no Font is set, one will be created and set (once) if needed.
As of LOVE 0.7.1, when using translation and scaling functions while drawing text, this function assumes the scale occurs first. If you don't script with this in mind, the text won't be in the right position, or possibly even on screen.
love.graphics.print and love.graphics.printf both suppport UTF-8 encoding. You'll also need a proper Font for special characters.
love.graphics.
| text | string | The text to draw. |
| x | number | The position to draw the object (x-axis). |
| y | number | The position to draw the object (y-axis). |
| r (0) | number | Orientation (radians). |
| sx (1) | number | Scale factor (x-axis). |
| sy (sx) | number | Scale factor (y-axis). |
| ox (0) | number | Origin offset (x-axis). |
| oy (0) | number | Origin offset (y-axis). |
| kx (0) | number | Shear factor (x-axis). |
| ky (0) | number | Shear factor (y-axis). |
love.graphics.
| coloredtext | table | A table containing colors and strings to add to the object, in the form of {color1, string1, color2, string2, ...}. |
| coloredtext.color1 | table | A table containing red, green, blue, and optional alpha components to use as a color for the next string in the table, in the form of {red, green, blue, alpha}. |
| coloredtext.string1 | string | A string of text which has a color specified by the previous color. |
| coloredtext.color2 | table | A table containing red, green, blue, and optional alpha components to use as a color for the next string in the table, in the form of {red, green, blue, alpha}. |
| coloredtext.string2 | string | A string of text which has a color specified by the previous color. |
| coloredtext.... | tables and strings | Additional colors and strings. |
| x | number | The position of the new text on the x-axis. |
| y | number | The position of the new text on the y-axis. |
| angle (0) | number | The orientation of the object in radians. |
| sx (1) | number | Scale factor on the x-axis. |
| sy (sx) | number | Scale factor on the y-axis. |
| ox (0) | number | Origin offset on the x-axis. |
| oy (0) | number | Origin offset on the y-axis. |
| kx (0) | number | Shearing / skew factor on the x-axis. |
| ky (0) | number | Shearing / skew factor on the y-axis. |
Draws formatted text, with word wrap and alignment.
See additional notes in love.graphics.print.
In version 0.9.2 and earlier, wrapping was implemented by breaking up words by spaces and putting them back together to make sure things fit nicely within the limit provided. However, due to the way this is done, extra spaces between words would end up missing when printed on the screen, and some lines could overflow past the provided wrap limit. In version 0.10.0 and newer this is no longer the case.
love.graphics.
| text | string | A text string. |
| x | number | The position on the x-axis. |
| y | number | The position on the y-axis. |
| limit | number | Wrap the line after this many horizontal pixels. |
| align ("left") | AlignMode | The alignment. |
| r (0) | number | Orientation (radians). |
| sx (1) | number | Scale factor (x-axis). |
| sy (sx) | number | Scale factor (y-axis). |
| ox (0) | number | Origin offset (x-axis). |
| oy (0) | number | Origin offset (y-axis). |
| kx (0) | number | Shear factor (x-axis). |
| ky (0) | number | Shear factor (y-axis). |
love.graphics.
| coloredtext | table | A table containing colors and strings to add to the object, in the form of {color1, string1, color2, string2, ...}. |
| coloredtext.color1 | table | A table containing red, green, blue, and optional alpha components to use as a color for the next string in the table, in the form of {red, green, blue, alpha}. |
| coloredtext.string1 | string | A string of text which has a color specified by the previous color. |
| coloredtext.color2 | table | A table containing red, green, blue, and optional alpha components to use as a color for the next string in the table, in the form of {red, green, blue, alpha}. |
| coloredtext.string2 | string | A string of text which has a color specified by the previous color. |
| coloredtext.... | tables and strings | Additional colors and strings. |
| x | number | The position of the new text on the x-axis. |
| y | number | The position of the new text on the y-axis. |
| wraplimit | number | The maximum width in pixels of the text before it gets automatically wrapped to a new line. |
| align | AlignMode | The alignment of the text. |
| angle (0) | number | The orientation of the object in radians. |
| sx (1) | number | Scale factor on the x-axis. |
| sy (sx) | number | Scale factor on the y-axis. |
| ox (0) | number | Origin offset on the x-axis. |
| oy (0) | number | Origin offset on the y-axis. |
| kx (0) | number | Shearing / skew factor on the x-axis. |
| ky (0) | number | Shearing / skew factor on the y-axis. |
Copies and pushes the current coordinate transformation to the transformation stack.
This function is always used to prepare for a corresponding pop operation later. It stores the current coordinate transformation state into the transformation stack and keeps it active. Later changes to the transformation can be undone by using the pop operation, which returns the coordinate transform to the state it was in before calling push.
love.graphics.
| stack ("transform") | StackType | The type of stack to push (e.g. just transformation state, or all love.graphics state). |
Draws a rectangle.
love.graphics.
Draws a rectangle with rounded corners.
| mode | DrawMode | How to draw the rectangle. |
| x | number | The position of top-left corner along the x-axis. |
| y | number | The position of top-left corner along the y-axis. |
| width | number | Width of the rectangle. |
| height | number | Height of the rectangle. |
| rx (0) | number | The x-axis radius of each round corner. Cannot be greater than half the rectangle's width. |
| ry (rx) | number | The y-axis radius of each round corner. Cannot be greater than half the rectangle's height. |
| segments (based on size) | number | The number of segments used for drawing the round corners. |
Resets the current graphics settings.
Calling reset makes the current drawing color white, the current background color black, resets any active Canvas or Shader, and removes any scissor settings. It sets the BlendMode to alpha. It also sets both the point and line drawing modes to smooth and their sizes to 1.0.
love.graphics.
Rotates the coordinate system in two dimensions.
Calling this function affects all future drawing operations by rotating the coordinate system around the origin by the given amount of radians. This change lasts until love.draw exits.
love.graphics.
| angle | number | The amount to rotate the coordinate system in radians. |
Scales the coordinate system in two dimensions.
By default the coordinate system in LÖVE corresponds to the display pixels in horizontal and vertical directions one-to-one, and the x-axis increases towards the right while the y-axis increases downwards. Scaling the coordinate system changes this relation.
After scaling by sx and sy, all coordinates are treated as if they were multiplied by sx and sy. Every result of a drawing operation is also correspondingly scaled, so scaling by (2, 2) for example would mean making everything twice as large in both x- and y-directions. Scaling by a negative value flips the coordinate system in the corresponding direction, which also means everything will be drawn flipped or upside down, or both. Scaling by zero is not a useful operation.
Scale and translate are not commutative operations, therefore, calling them in different orders will change the outcome.
Scaling lasts until love.draw exits.
love.graphics.
| sx | number | The scaling in the direction of the x-axis. |
| sy (sx) | number | The scaling in the direction of the y-axis. If omitted, it defaults to same as parameter sx. |
love.graphics.
Sets the background color.
love.graphics.
| r | number | The red component (0-255). |
| g | number | The green component (0-255). |
| b | number | The blue component (0-255). |
| a (255) | number | The alpha component (0-255). |
love.graphics.
| rgba | table | A numerical indexed table with the red, green and blue values as numbers. Alpha is 255 if it is not in the table |
Sets the blending mode.
love.graphics.
| mode | BlendMode | The blend mode to use. |
| alphamode ("alphamultiply") | BlendAlphaMode | What to do with the alpha of drawn objects when blending. |
Captures drawing operations to a Canvas.
love.graphics.
Sets the render target to a specified Canvas. All drawing operations until the next love.graphics.setCanvas call will be redirected to the Canvas and not shown on the screen.
| canvas | Canvas | A render target. |
love.graphics.
Resets the render target to the screen, i.e. re-enables drawing to the screen.
love.graphics.
Sets the render target to multiple simultaneous Canvases. All drawing operations until the next love.graphics.setCanvas call will be redirected to the specified canvases and not shown on the screen.
| canvas1 | Canvas | The first render target. |
| canvas2 | Canvas | The second render target. |
| ... | Canvas | More canvases. |
Sets the color used for drawing.
love.graphics.
| red | number | The amount of red. |
| green | number | The amount of green. |
| blue | number | The amount of blue. |
| alpha | number | The amount of alpha. The alpha value will be applied to all subsequent draw operations, even the drawing of an image. |
love.graphics.
| rgba | table | A numerical indexed table with the red, green, blue and alpha values as numbers. The alpha is optional and defaults to 255 if it is left out. |
Sets the color mask. Enables or disables specific color components when rendering and clearing the screen. For example, if red is set to false, no further changes will be made to the red component of any pixels.
Enables all color components when called without arguments.
love.graphics.
Enables color masking for the specified color components.
| red | boolean | Render red component. |
| green | boolean | Render green component. |
| blue | boolean | Render blue component. |
| alpha | boolean | Render alpha component. |
love.graphics.
Disables color masking.
love.graphics.
Sets the default scaling filters used with Images, Canvases, and Fonts.
This function does not apply retroactively to loaded images.
love.graphics.
| min | FilterMode | Filter mode used when scaling the image down. |
| mag (min) | FilterMode | Filter mode used when scaling the image up. |
| anisotropy (1) | number | Maximum amount of Anisotropic Filtering used. |
Set an already-loaded Font as the current font or create and load a new one from the file and size.
It's recommended that Font objects are created with love.graphics.newFont in the loading stage and then passed to this function in the drawing stage.
love.graphics.
| font | Font | The Font object to use. |
Sets the line width.
love.graphics.
| width | number | The width of the line. |
Creates and sets a new font.
font = love.graphics.
| font | Font | The new font. |
| filename | string / File / FileData | The file path/File/FileData of the font. |
| size (12) | number | The size of the font. |
Sets or resets a Shader as the current pixel effect or vertex shaders. All drawing operations until the next love.graphics.setShader will be drawn using the Shader object specified.
Disables the shaders when called without arguments.
love.graphics.
love.graphics.
| shader | Shader | The new shader. |
Sets the point size.
love.graphics.
| size | number | The new point size. |
Sets or disables scissor.
The scissor limits the drawing area to a specified rectangle. This affects all graphics calls, including love.graphics.clear.
love.graphics.
Limits the drawing area to a specified rectangle.
| x | number | The X coordinate of upper left corner. |
| y | number | The Y coordinate of upper left corner. |
| width | number | The width of clipping rectangle. |
| height | number | The height of clipping rectangle. |
love.graphics.
Disables scissor.
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.
Each Canvas has its own per-pixel stencil values.
love.graphics.
| comparemode | CompareMode | The type of comparison to make for each pixel. |
| comparevalue | number | The value to use when comparing with the stencil value of each pixel. Must be between 0 and 255. |
love.graphics.
Disables stencil testing.
Sets whether wireframe lines will be used when drawing.
Wireframe mode should only be used for debugging. The lines drawn with it enabled do not behave like regular love.graphics.lines: their widths don't scale with the coordinate transformations or with love.graphics.setLineWidth, and they don't use the smooth LineStyle.
love.graphics.
| enable | boolean | True to enable wireframe mode when drawing, false to disable it. |
Shears the coordinate system.
love.graphics.
| kx | number | The shear factor on the x-axis. |
| ky | number | The shear factor on the y-axis. |
Draws geometry as a stencil.
The geometry drawn by the supplied function sets invisible stencil values of pixels, instead of setting pixel colors. The stencil values of pixels can act like a mask / stencil - love.graphics.setStencilTest can be used afterward to determine how further rendering is affected by the stencil values in each pixel.
Each Canvas has its own per-pixel stencil values. Stencil values are within the range of [0, 255].
love.graphics.
| stencilfunction | function | Function which draws geometry. The stencil values of pixels, rather than the color of each pixel, will be affected by the geometry. |
| action ("replace") | StencilAction | How to modify any stencil values of pixels that are touched by what's drawn in the stencil function. |
| value (1) | number | The new stencil value to use for pixels if the "replace" stencil action is used. Has no effect with other stencil actions. Must be between 0 and 255. |
| keepvalues (false) | boolean | True to preserve old stencil values of pixels, false to re-set every pixel's stencil value to 0 before executing the stencil function. love.graphics.clear will also re-set all stencil values. |
Translates the coordinate system in two dimensions.
When this function is called with two numbers, dx, and dy, all the following drawing operations take effect as if their x and y coordinates were x+dx and y+dy.
Scale and translate are not commutative operations, therefore, calling them in different orders will change the outcome.
This change lasts until love.graphics.clear is called (which is called automatically before love.draw in the default love.run function), or a love.graphics.pop reverts to a previous coordinate system state.
Translating using whole numbers will prevent tearing/blurring of images and fonts draw after translating.
love.graphics.
| dx | number | The translation relative to the x-axis. |
| dy | number | The translation relative to the y-axis. |
center
Align text center.
left
Align text left.
right
Align text right.
justify
Align text both left and right.
pie
The arc is drawn like a slice of pie, with the arc circle connected to the center at its end-points.
open
The arc circle's two end-points are unconnected when the arc is drawn as a line. Behaves like the "closed" arc type when the arc is drawn in filled mode.
closed
The arc circle's two end-points are connected to each other.
uniform
Uniform distribution.
normal
Normal (gaussian) distribution.
ellipse
Uniform distribution in an ellipse.
none
No distribution - area spread is disabled.
alphamultiply
The RGB values of what's drawn are multiplied by the alpha values of those colors during blending. This is the default alpha mode.
premultiplied
The RGB values of what's drawn are not multiplied by the alpha values of those colors during blending. For most blend modes to work correctly with this alpha mode, the colors of a drawn object need to have had their RGB values multiplied by their alpha values at some point previously ("premultiplied alpha").
alpha
Alpha blending (normal). The alpha of what's drawn determines its opacity.
replace
The colors of what's drawn completely replace what was on the screen, with no additional blending. The BlendAlphaMode specified in love.graphics.setBlendMode still affects what happens.
screen
"Screen" blending.
add
The pixel colors of what's drawn are added to the pixel colors already on the screen. The alpha of the screen is not modified.
subtract
The pixel colors of what's drawn are subtracted from the pixel colors already on the screen. The alpha of the screen is not modified.
multiply
The pixel colors of what's drawn are multiplied with the pixel colors already on the screen (darkening them). The alpha of drawn objects is multiplied with the alpha of the screen rather than determining how much the colors on the screen are affected, even when the "alphamultiply" BlendAlphaMode is used.
lighten
The pixel colors of what's drawn are compared to the existing pixel colors, and the larger of the two values for each color component is used. Only works when the "premultiplied" BlendAlphaMode is used in love.graphics.setBlendMode.
darken
The pixel colors of what's drawn are compared to the existing pixel colors, and the smaller of the two values for each color component is used. Only works when the "premultiplied" BlendAlphaMode is used in love.graphics.setBlendMode.
normal
The default Canvas format - usually an alias for the rgba8 format, or the srgb format if gamma-correct rendering is enabled in LÖVE 0.10.0 and newer.
hdr
A format suitable for high dynamic range content - an alias for the rgba16f format, normally.
rgba8
8 bits per channel (32 bpp) RGBA. Color channel values range from 0-255 (0-1 in shaders).
rgba4
4 bits per channel (16 bpp) RGBA.
rgb5a1
RGB with 5 bits each, and a 1-bit alpha channel (16 bpp).
rgb565
RGB with 5, 6, and 5 bits each, respectively (16 bpp). There is no alpha channel in this format.
rgb10a2
RGB with 10 bits per channel, and a 2-bit alpha channel (32 bpp).
rgba16f
Floating point RGBA with 16 bits per channel (64 bpp). Color values can range from [-65504, +65504].
rgba32f
Floating point RGBA with 32 bits per channel (128 bpp).
rg11b10f
Floating point RGB with 11 bits in the red and green channels, and 10 bits in the blue channel (32 bpp). There is no alpha channel. Color values can range from [0, +65024].
srgb
The same as rgba8, but the Canvas is interpreted as being in the sRGB color space. Everything drawn to the Canvas will be converted from linear RGB to sRGB. When the Canvas is drawn (or used in a shader), it will be decoded from sRGB to linear RGB. This reduces color banding when doing gamma-correct rendering, since sRGB encoding has more precision than linear RGB for darker colors.
r8
Single-channel (red component) format (8 bpp).
rg8
Two channels (red and green components) with 8 bits per channel (16 bpp).
r16f
Floating point single-channel format (16 bpp). Color values can range from [-65504, +65504].
rg16f
Floating point two-channel format with 16 bits per channel (32 bpp). Color values can range from [-65504, +65504].
r32f
Floating point single-channel format (32 bpp).
rg32f
Floating point two-channel format with 32 bits per channel (64 bpp).
equal
The stencil value of the pixel must be equal to the supplied value.
notequal
The stencil value of the pixel must not be equal to the supplied value.
less
The stencil value of the pixel must be less than the supplied value.
lequal
The stencil value of the pixel must be less than or equal to the supplied value.
gequal
The stencil value of the pixel must be greater than or equal to the supplied value.
greater
The stencil value of the pixel must be greater than the supplied value.
linear
Scale image with linear interpolation.
nearest
Scale image with nearest neighbor interpolation.
clampzero
Whether the "clampzero" WrapMode is supported.
lighten
Whether the "lighten" and "darken" BlendModes are supported.
multicanvasformats
Whether multiple Canvases with different formats can be used in the same love.graphics.setCanvas call.
pointsize
The maximum size of points.
texturesize
The maximum width or height of Images and Canvases.
multicanvas
The maximum number of simultaneously active canvases (via love.graphics.setCanvas).
canvasmsaa
The maximum number of antialiasing samples for a Canvas.
miter
The ends of the line segments beveled in an angle so that they join seamlessly.
bevel
No cap applied to the ends of the line segments.
none
Flattens the point where line segments join together.
fan
The vertices create a "fan" shape with the first vertex acting as the hub point. Can be easily used to draw simple convex polygons.
strip
The vertices create a series of connected triangles using vertices 1, 2, 3, then 3, 2, 4 (note the order), then 3, 4, 5 and so on.
triangles
The vertices create unconnected triangles.
points
The vertices are drawn as unconnected points (see love.graphics.setPointSize.)
top
Particles are inserted at the top of the ParticleSystem's list of particles.
bottom
Particles are inserted at the bottom of the ParticleSystem's list of particles.
random
Particles are inserted at random positions in the ParticleSystem's list of particles.
dynamic
The object's data will change occasionally during its lifetime.
static
The object will not be modified after initial sprites or vertices are added.
stream
The object data will always change between draws.
transform
The transformation stack (love.graphics.translate, love.graphics.rotate, etc.)
all
All love.graphics state, including transform state.
replace
The stencil value of a pixel will be replaced by the value specified in love.graphics.stencil, if any object touches the pixel.
increment
The stencil value of a pixel will be incremented by 1 for each object that touches the pixel. If the stencil value reaches 255 it will stay at 255.
decrement
The stencil value of a pixel will be decremented by 1 for each object that touches the pixel. If the stencil value reaches 0 it will stay at 0.
incrementwrap
The stencil value of a pixel will be incremented by 1 for each object that touches the pixel. If a stencil value of 255 is incremented it will be set to 0.
decrementwrap
The stencil value of a pixel will be decremented by 1 for each object that touches the pixel. If the stencil value of 0 is decremented it will be set to 255.
invert
The stencil value of a pixel will be bitwise-inverted for each object that touches the pixel. If a stencil value of 0 is inverted it will become 255.
clamp
How the image wraps inside a Quad with a larger quad size than image size. This also affects how Meshes with texture coordinates which are outside the range of [0, 1] are drawn, and the color returned by the Texel Shader function when using it to sample from texture coordinates outside of the range of [0, 1].
repeat
Repeat the image. Fills the whole available extent.
mirroredrepeat
Repeat the texture, flipping it each time it repeats. May produce better visual results than the repeat mode when the texture doesn't seamlessly tile.
clampzero
Clamp the texture. Fills the area outside the texture's normal range with transparent black (or opaque black for textures with no alpha channel.)
A Canvas is used for off-screen rendering. Think of it as an invisible screen that you can draw to, but that will not be visible until you draw it to the actual visible screen. It is also known as "render to texture".
By drawing things that do not change position often (such as background items) to the Canvas, and then drawing the entire Canvas instead of each item, you can reduce the number of draw operations performed each frame.
In versions prior to 0.10.0, not all graphics cards that LÖVE supported could use Canvases. love.graphics.isSupported("canvas") could be used to check for support at runtime.
Gets the width and height of the Canvas.
width, height = Canvas:
| width | number | The width of the Canvas, in pixels. |
| height | number | The height of the Canvas, in pixels. |
Gets the filter mode of the Canvas.
min, mag, anisotropy = Canvas:
| min | FilterMode | Filter mode used when minifying the canvas. |
| mag | FilterMode | Filter mode used when magnifying the canvas. |
| anisotropy | number | Maximum amount of anisotropic filtering used. |
Gets the texture format of the Canvas.
format = Canvas:
| format | CanvasFormat | The format of the Canvas. |
Gets the height of the Canvas.
height = Canvas:
| height | number | The height of the Canvas, in pixels. |
Gets the number of multisample antialiasing (MSAA) samples used when drawing to the Canvas.
This may be different than the number used as an argument to love.graphics.newCanvas if the system running LÖVE doesn't support that number.
samples = Canvas:
| samples | number | The number of multisample antialiasing samples used by the canvas when drawing to it. |
Gets the width of the Canvas.
width = Canvas:
| width | number | The width of the Canvas, in pixels. |
Gets the wrapping properties of a Canvas.
This function returns the currently set horizontal and vertical wrapping modes for the Canvas.
horizontal, vertical = Canvas:
| horizontal | WrapMode | Horizontal wrapping mode of the Canvas. |
| vertical | WrapMode | Vertical wrapping mode of the Canvas. |
Generates ImageData from the contents of the Canvas.
data = Canvas:
| data | ImageData | The image data stored in the Canvas. |
data = Canvas:
| data | ImageData | The new ImageData made from the Canvas' contents. |
| x | number | The x-axis of the top-left corner of the area within the Canvas to capture. |
| y | number | The y-axis of the top-left corner of the area within the Canvas to capture. |
| width | number | The width of the area within the Canvas to capture. |
| height | number | The height of the area within the Canvas to capture. |
Render to the Canvas using a function.
Canvas:
| func | function | A function performing drawing operations. |
Sets the filter of the Canvas.
Canvas:
| min | FilterMode | How to scale a canvas down. |
| mag (min) | FilterMode | How to scale a canvas up. |
| anisotropy (1) | number | Maximum amount of anisotropic filtering used. |
Sets the wrapping properties of a Canvas.
This function sets the way the edges of a Canvas are treated if it is scaled or rotated. If the WrapMode is set to "clamp", the edge will not be interpolated. If set to "repeat", the edge will be interpolated with the pixels on the opposing side of the framebuffer.
Canvas:
| horizontal | WrapMode | Horizontal wrapping mode of the Canvas. |
| vertical (horizontal) | WrapMode | Vertical wrapping mode of the Canvas. |
Defines the shape of characters than can be drawn onto the screen.
Gets the ascent of the Font. The ascent spans the distance between the baseline and the top of the glyph that reaches farthest from the baseline.
ascent = Font:
| ascent | number | The ascent of the Font in pixels. |
Gets the baseline of the Font. Most scripts share the notion of a baseline: an imaginary horizontal line on which characters rest. In some scripts, parts of glyphs lie below the baseline.
baseline = Font:
| baseline | number | The baseline of the Font in pixels. |
Gets the descent of the Font. The descent spans the distance between the baseline and the lowest descending glyph in a typeface.
descent = Font:
| descent | number | The descent of the Font in pixels. |
Gets the filter mode for a font.
min, mag, anisotropy = Font:
| min | FilterMode | Filter mode used when minifying the font. |
| mag | FilterMode | Filter mode used when magnifying the font. |
| anisotropy | number | Maximum amount of anisotropic filtering used. |
Gets the height of the Font. The height of the font is the size including any spacing; the height which it will need.
height = Font:
| height | number | The height of the Font in pixels. |
Gets the line height. This will be the value previously set by Font:setLineHeight, or 1.0 by default.
height = Font:
| height | number | The current line height. |
Determines the horizontal size a line of text needs. Does not support line-breaks.
width = Font:
| width | number | The width of the line. |
| line | string | A line of text. |
Gets formatting information for text, given a wrap limit.
This function accounts for newlines correctly (i.e. '\n').
width, wrappedtext = Font:
| width | number | The maximum width of the wrapped text. |
| wrappedtext | table | A sequence containing each line of text that was wrapped. |
| text | string | The text that will be wrapped. |
| wraplimit | number | The maximum width in pixels of each line that text is allowed before wrapping. |
Gets whether the font can render a particular character.
hasglyph = Font:
| hasglyph | boolean | Whether the font can render the glyph represented by the character. |
| character | string | A unicode character. |
hasglyph = Font:
| hasglyph | boolean | Whether the font can render the glyph represented by the codepoint number. |
| codepoint | number | A unicode codepoint number. |
Sets the fallback fonts. When the Font doesn't contain a glyph, it will substitute the glyph from the next subsequent fallback Fonts. This is akin to setting a "font stack" in Cascading Style Sheets (CSS).
Font:
| fallbackfont1 | Font | The first fallback Font to use. |
| ... | Font | Additional fallback Fonts. |
Sets the filter mode for a font.
Font:
| min | FilterMode | How to scale a font down. |
| mag (min) | FilterMode | How to scale a font up. |
| anisotropy (1) | number | Maximum amount of anisotropic filtering used. |
Sets the line height. When rendering the font in lines the actual height will be determined by the line height multiplied by the height of the font. The default is 1.0.
Font:
| height | number | The new line height. |
A 2D polygon mesh used for drawing arbitrary textured shapes.
Attaches a vertex attribute from a different Mesh onto this Mesh, for use when drawing. This can be used to share vertex attribute data between several different Meshes.
Mesh:
| name | string | The name of the vertex attribute to attach. |
| mesh | Mesh | The Mesh to get the vertex attribute from. |
Gets the mode used when drawing the Mesh.
mode = Mesh:
| mode | MeshDrawMode | The mode used when drawing the Mesh. |
Gets the range of vertices used when drawing the Mesh.
If the Mesh's draw range has not been set previously with Mesh:setDrawRange, this function will return nil.
min, max = Mesh:
| min | number | The index of the first vertex used when drawing, or the index of the first value in the vertex map used if one is set for this Mesh. |
| max | number | The index of the last vertex used when drawing, or the index of the last value in the vertex map used if one is set for this Mesh. |
Gets the texture (Image or Canvas) used when drawing the Mesh.
texture = Mesh:
| texture | Texture | The Image or Canvas to texture the Mesh with when drawing, or nil if none is set. |
Gets the properties of a vertex in the Mesh.
attributecomponent, ... = Mesh:
| attributecomponent | number | The first component of the first vertex attribute in the specified vertex. |
| ... | number | Additional components of all vertex attributes in the specified vertex. |
| index | number | The index of the the vertex you want to retrieve the information for. |
x, y, u, v, r, g, b, a = Mesh:
| x | number | The position of the vertex on the x-axis. |
| y | number | The position of the vertex on the y-axis. |
| u | number | The horizontal component of the texture coordinate. |
| v | number | The vertical component of the texture coordinate. |
| r | number | The red component of the vertex's color. |
| g | number | The green component of the vertex's color. |
| b | number | The blue component of the vertex's color. |
| a | number | The alpha component of the vertex's color. |
| index | number | The index of the the vertex you want to retrieve the information for. |
Gets the properties of a specific attribute within a vertex in the Mesh.
Meshes without a custom vertex format specified in love.graphics.newMesh have position as their first attribute, texture coordinates as their second attribute, and color as their third attribute.
value1, value2, ... = Mesh:
| value1 | number | The value of the first component of the attribute. |
| value2 | number | The value of the second component of the attribute. |
| ... | number | Any additional vertex attribute components. |
| vertexindex | number | The index of the the vertex to be modified. |
| attributeindex | number | The index of the attribute within the vertex to be modified. |
Gets the total number of vertices in the Mesh.
num = Mesh:
| num | number | The total number of vertices in this Mesh. |
Gets the vertex format that the Mesh was created with.
format = Mesh:
| format | table | The vertex format of the Mesh, which is a table containing tables for each vertex attribute the Mesh was created with, in the form of {attribute, ...}. |
| format.attribute | table | A table containing the attribute's name, it's data type, and the number of components in the attribute, in the form of {name, datatype, components}. |
| format.... | table | Additional vertex attributes in the Mesh. |
Gets the vertex map for the Mesh. The vertex map describes the order in which the vertices are used when the Mesh is drawn. The vertices, vertex map, and mesh draw mode work together to determine what exactly is displayed on the screen.
If no vertex map has been set previously via Mesh:setVertexMap, then this function will return nil in LÖVE 0.10.0+, or an empty table in 0.9.2 and older.
map = Mesh:
| map | table | A table containing a list of vertex indices used when drawing. |
Gets whether a specific vertex attribute in the Mesh is enabled. Vertex data from disabled attributes is not used when drawing the Mesh.
enabled = Mesh:
| enabled | boolean | Whether the vertex attribute is used when drawing this Mesh. |
| name | string | The name of the vertex attribute to enable or disable. |
Enables or disables a specific vertex attribute in the Mesh. Vertex data from disabled attributes is not used when drawing the Mesh.
Mesh:
| name | string | The name of the vertex attribute to enable or disable. |
| enable | boolean | Whether the vertex attribute is used when drawing this Mesh. |
Sets the mode used when drawing the Mesh.
Mesh:
| mode | MeshDrawMode | The mode to use when drawing the Mesh. |
Restricts the drawn vertices of the Mesh to a subset of the total.
If a vertex map is used with the Mesh, this method will set a subset of the values in the vertex map array to use, instead of a subset of the total vertices in the Mesh.
For example, if Mesh:setVertexMap(1, 2, 3, 1, 3, 4) and Mesh:setDrawRange(4, 6) are called, vertices 1, 3, and 4 will be drawn.
Mesh:
| min | number | The index of the first vertex to use when drawing, or the index of the first value in the vertex map to use if one is set for this Mesh. |
| max | number | The index of the last vertex to use when drawing, or the index of the last value in the vertex map to use if one is set for this Mesh. |
Mesh:
Allows all vertices in the Mesh to be drawn.
Sets the texture (Image or Canvas) used when drawing the Mesh.
When called without an argument disables the texture. Untextured meshes have a white color by default.
Mesh:
Mesh:
| texture | Texture | The Image or Canvas to texture the Mesh with when drawing. |
Sets the properties of a vertex in the Mesh.
Mesh:
| index | number | The index of the the vertex you want to modify. |
| attributecomponent | number | The first component of the first vertex attribute in the specified vertex. |
| ... | number | Additional components of all vertex attributes in the specified vertex. |
Mesh:
| index | number | The index of the the vertex you want to modify. |
| vertex | table | A table with vertex information, in the form of {attributecomponent, ...}. |
| vertex.attributecomponent | number | The first component of the first vertex attribute in the specified vertex. |
| vertex.... | number | Additional components of all vertex attributes in the specified vertex. |
Mesh:
Sets the vertex components of a Mesh that wasn't created with a custom vertex format.
| index | number | The index of the the vertex you want to modify. |
| x | number | The position of the vertex on the x-axis. |
| y | number | The position of the vertex on the y-axis. |
| u | number | The horizontal component of the texture coordinate. |
| v | number | The vertical component of the texture coordinate. |
| r (255) | number | The red component of the vertex's color. |
| g (255) | number | The green component of the vertex's color. |
| b (255) | number | The blue component of the vertex's color. |
| a (255) | number | The alpha component of the vertex's color. |
Mesh:
Sets the vertex components of a Mesh that wasn't created with a custom vertex format.
| index | number | The index of the the vertex you want to modify. |
| vertex | table | A table with vertex information. |
| vertex.[1] | number | The position of the vertex on the x-axis. |
| vertex.[2] | number | The position of the vertex on the y-axis. |
| vertex.[3] | number | The horizontal component of the texture coordinate. |
| vertex.[4] | number | The vertical component of the texture coordinate. |
| vertex.[5] (255) | number | The red component of the vertex's color. |
| vertex.[6] (255) | number | The green component of the vertex's color. |
| vertex.[7] (255) | number | The blue component of the vertex's color. |
| vertex.[8] (255) | number | The alpha component of the vertex's color. |
Sets the properties of a specific attribute within a vertex in the Mesh.
Meshes without a custom vertex format specified in love.graphics.newMesh have position as their first attribute, texture coordinates as their second attribute, and color as their third attribute.
Mesh:
| vertexindex | number | The index of the the vertex to be modified. |
| attributeindex | number | The index of the attribute within the vertex to be modified. |
| value1 | number | The value of the first component of the attribute. |
| value2 | number | The value of the second component of the attribute. |
| ... | number | Any additional vertex attribute components. |
Sets the vertex map for the Mesh. The vertex map describes the order in which the vertices are used when the Mesh is drawn. The vertices, vertex map, and mesh draw mode work together to determine what exactly is displayed on the screen.
The vertex map allows you to re-order or reuse vertices when drawing without changing the actual vertex parameters or duplicating vertices. It is especially useful when combined with different Mesh Draw Modes.
Mesh:
| map | table | A table containing a list of vertex indices to use when drawing. Values must be in the range of [1, Mesh:getVertexCount()]. |
Mesh:
| vi1 | number | The index of the first vertex to use when drawing. Must be in the range of [1, Mesh:getVertexCount()]. |
| vi2 | number | The index of the second vertex to use when drawing. |
| vi3 | number | The index of the third vertex to use when drawing. |
Replaces a range of vertices in the Mesh with new ones. The total number of vertices in a Mesh cannot be changed after it has been created.
Mesh:
| vertices | table | The table filled with vertex information tables for each vertex, in the form of {vertex, ...} where each vertex is a table in the form of {attributecomponent, ...}. |
| vertices.attributecomponent | number | The first component of the first vertex attribute in the vertex. |
| vertices.... | number | Additional components of all vertex attributes in the vertex. |
| vertices.startvertex (1) | number | The index of the first vertex to replace. |
Mesh:
Sets the vertex components of a Mesh that wasn't created with a custom vertex format.
| vertices | table | The table filled with vertex information tables for each vertex as follows: |
| vertices.[1] | number | The position of the vertex on the x-axis. |
| vertices.[2] | number | The position of the vertex on the y-axis. |
| vertices.[3] | number | The horizontal component of the texture coordinate. Texture coordinates are normally in the range of [0, 1], but can be greater or less (see WrapMode). |
| vertices.[4] | number | The vertical component of the texture coordinate. Texture coordinates are normally in the range of [0, 1], but can be greater or less (see WrapMode). |
| vertices.[5] (255) | number | The red color component. |
| vertices.[6] (255) | number | The green color component. |
| vertices.[7] (255) | number | The blue color component. |
| vertices.[8] (255) | number | The alpha color component. |
Drawable image type.
Gets the original ImageData or CompressedImageData used to create the Image.
All Images keep a reference to the Data that was used to create the Image. The Data is used to refresh the Image when love.window.setMode or Image:refresh is called.
data = Image:
| data | ImageData | The original ImageData used to create the Image, if the image is not compressed. |
data = Image:
| data | CompressedImageData | The original CompressedImageData used to create the Image, if the image is compressed. |
Gets the width and height of the Image.
width, height = Image:
| width | number | The width of the Image, in pixels. |
| height | number | The height of the Image, in pixels. |
Gets the filter mode for an image.
min, mag = Image:
| min | FilterMode | Filter mode used when minifying the image. |
| mag | FilterMode | Filter mode used when magnifying the image. |
Gets the flags used when the image was created.
flags = Image:
| flags | table | A table with ImageFlag keys. |
Gets the height of the Image.
height = Image:
| height | number | The height of the Image, in pixels. |
Gets the mipmap filter mode for an Image.
mode, sharpness = Image:
| mode | FilterMode | The filter mode used in between mipmap levels. nil if mipmap filtering is not enabled. |
| sharpness | number | Value used to determine whether the image should use more or less detailed mipmap levels than normal when drawing. |
Gets the wrapping properties of an Image.
This function returns the currently set horizontal and vertical wrapping modes for the image.
horizontal, vertical = Image:
| horizontal | WrapMode | Horizontal wrapping mode of the image. |
| vertical | WrapMode | Vertical wrapping mode of the image. |
Reloads the Image's contents from the ImageData or CompressedImageData used to create the image.
Image:
Image:
| x | number | The x-axis of the top-left corner of the area within the Image to reload. |
| y | number | The y-axis of the top-left corner of the area within the Image to reload. |
| width | number | The width of the area within the Image to reload. |
| height | number | The height of the area within the Image to reload. |
Sets the filter mode for an image.
Image:
| min | FilterMode | How to scale an image down. |
| mag (min) | FilterMode | How to scale an image up. |
Sets the mipmap filter mode for an Image.
Mipmapping is useful when drawing an image at a reduced scale. It can improve performance and reduce aliasing issues.
In 0.10.0 and newer, the Image must be created with the mipmaps flag enabled for the mipmap filter to have any effect.
Image:
| filtermode | FilterMode | The filter mode to use in between mipmap levels. "nearest" will often give better performance. |
| sharpness (0) | number | A positive sharpness value makes the image use a more detailed mipmap level when drawing, at the expense of performance. A negative value does the reverse. |
Image:
Disables mipmap filtering.
Sets the wrapping properties of an Image.
This function sets the way an Image is repeated when it is drawn with a Quad that is larger than the image's extent. An image may be clamped or set to repeat in both horizontal and vertical directions. Clamped images appear only once, but repeated ones repeat as many times as there is room in the Quad.
If you use a Quad that is larger than the image extent and do not use repeated tiling, there may be an unwanted visual effect of the image stretching all the way to fill the Quad. If this is the case, setting Image:getWrap("repeat", "repeat") for all the images to be repeated, and using Quad of appropriate size will result in the best visual appearance.
Image:
| horizontal | WrapMode | Horizontal wrapping mode of the image. |
| vertical (horizontal) | WrapMode | Vertical wrapping mode of the image. |
Used to create cool effects, like fire. The particle systems are created and drawn on the screen using functions in love.graphics. They also need to be updated in the update(dt) callback for you to see any changes in the particles emitted.
Creates an identical copy of the ParticleSystem in the stopped state.
Cloned ParticleSystem inherit all the set-able state of the original ParticleSystem, but they are initialized stopped.
particlesystem = ParticleSystem:
| particlesystem | ParticleSystem | The new identical copy of this ParticleSystem. |
Emits a burst of particles from the particle emitter.
ParticleSystem:
| numparticles | number | The amount of particles to emit. The number of emitted particles will be truncated if the particle system's max buffer size is reached. |
Gets the amount of particles that are currently in the system.
count = ParticleSystem:
| count | number | The current number of live particles. |
Gets the area-based spawn parameters for the particles.
distribution, dx, dy = ParticleSystem:
| distribution | AreaSpreadDistribution | The type of distribution for new particles. |
| dx | number | The maximum spawn distance from the emitter along the x-axis for uniform distribution, or the standard deviation along the x-axis for normal distribution. |
| dy | number | The maximum spawn distance from the emitter along the y-axis for uniform distribution, or the standard deviation along the y-axis for normal distribution. |
Gets the size of the buffer (the max allowed amount of particles in the system).
buffer = ParticleSystem:
| buffer | number | The buffer size. |
Gets a series of colors to apply to the particle sprite. The particle system will interpolate between each color evenly over the particle's lifetime. Color modulation needs to be activated for this function to have any effect.
Arguments are passed in groups of four, representing the components of the desired RGBA value. At least one color must be specified. A maximum of eight may be used.
r1, g1, b1, a1, r2, g2, b2, a2, ... = ParticleSystem:
| r1 | number | First color, red component (0-255). |
| g1 | number | First color, green component (0-255). |
| b1 | number | First color, blue component (0-255). |
| a1 | number | First color, alpha component (0-255). |
| r2 | number | Second color, red component (0-255). |
| g2 | number | Second color, green component (0-255). |
| b2 | number | Second color, blue component (0-255). |
| a2 | number | Second color, alpha component (0-255). |
| ... | number | Etc. |
Gets the direction the particles will be emitted in.
direction = ParticleSystem:
| direction | number | The direction of the particles (in radians). |
ParticleSystem:
Gets the amount of particles emitted per second.
rate = ParticleSystem:
| rate | number | The amount of particles per second. |
Gets the mode to use when the ParticleSystem adds new particles.
mode = ParticleSystem:
| mode | ParticleInsertMode | The mode to use when the ParticleSystem adds new particles. |
ParticleSystem:
Gets the linear acceleration (acceleration along the x and y axes) for particles.
Every particle created will accelerate along the x and y axes between xmin,ymin and xmax,ymax.
xmin, ymin, xmax, ymax = ParticleSystem:
| xmin | number | The minimum acceleration along the x axis. |
| ymin | number | The minimum acceleration along the y axis. |
| xmax | number | The maximum acceleration along the x axis. |
| ymax | number | The maximum acceleration along the y axis. |
ParticleSystem:
Gets the amount of linear damping (constant deceleration) for particles.
min, max = ParticleSystem:
| min | number | The minimum amount of linear damping applied to particles. |
| max | number | The maximum amount of linear damping applied to particles. |
ParticleSystem:
Gets how long the particle system should emit particles (if -1 then it emits particles forever).
life = ParticleSystem:
| life | number | The lifetime of the emitter (in seconds). |
Get the offget position which the particle sprite is rotated around. If this function is not used, the particles rotate around their center.
x, y = ParticleSystem:
| x | number | The x coordinate of the rotation offget. |
| y | number | The y coordinate of the rotation offget. |
ParticleSystem:
Gets the life of the particles.
min, max = ParticleSystem:
| min | number | The minimum life of the particles (seconds). |
| max (min) | number | The maximum life of the particles (seconds). |
Gets the series of Quads used for the particle sprites.
quads = ParticleSystem:
| quads | table | A table containing the Quads used. |
Gets the position of the emitter.
x, y = ParticleSystem:
| x | number | Position along x-axis. |
| y | number | Position along y-axis. |
ParticleSystem:
Get the radial acceleration (away from the emitter).
min, max = ParticleSystem:
| min | number | The minimum acceleration. |
| max (min) | number | The maximum acceleration. |
Gets the rotation of the image upon particle creation (in radians).
min, max = ParticleSystem:
| min | number | The minimum initial angle (radians). |
| max (min) | number | The maximum initial angle (radians). |
Gets a series of sizes by which to scale a particle sprite. 1.0 is normal size. The particle system will interpolate between each size evenly over the particle's lifetime.
At least one size must be specified. A maximum of eight may be used.
size1, size2, ... = ParticleSystem:
| size1 | number | The first size. |
| size2 | number | The second size. |
| ... | number | Etc. |
ParticleSystem:
Gets the degree of variation (0 meaning no variation and 1 meaning full variation between start and end).
variation = ParticleSystem:
| variation | number | The degree of variation (0 meaning no variation and 1 meaning full variation between start and end). |
Gets the speed of the particles.
min, max = ParticleSystem:
| min | number | The minimum linear speed of the particles. |
| max (min) | number | The maximum linear speed of the particles. |
Gets the spin of the sprite.
min, max = ParticleSystem:
| min | number | The minimum spin (radians per second). |
| max (min) | number | The maximum spin (radians per second). |
ParticleSystem:
Gets the degree of variation (0 meaning no variation and 1 meaning full variation between start and end).
variation = ParticleSystem:
| variation | number | The degree of variation (0 meaning no variation and 1 meaning full variation between start and end). |
Gets the amount of spread for the system.
spread = ParticleSystem:
| spread | number | The amount of spread (radians). |
Gets the Image or Canvas which is to be emitted.
texture = ParticleSystem:
| texture | Texture | An Image or Canvas to use for the particle. |
ParticleSystem:
Gets the tangential acceleration (acceleration perpendicular to the particle's direction).
min, max = ParticleSystem:
| min | number | The minimum acceleration. |
| max (min) | number | The maximum acceleration. |
ParticleSystem:
Gets whether particle angles and rotations are relative to their velocities. If enabled, particles are aligned to the angle of their velocities and rotate relative to that angle.
enabled = ParticleSystem:
| enabled | boolean | True if relative particle rotation is enabled, false if it's disabled. |
Checks whether the particle system is actively emitting particles.
active = ParticleSystem:
| active | boolean | True if system is active, false otherwise. |
Checks whether the particle system is paused.
paused = ParticleSystem:
| paused | boolean | True if system is paused, false otherwise. |
Checks whether the particle system is stopped.
stopped = ParticleSystem:
| stopped | boolean | True if system is stopped, false otherwise. |
Moves the position of the emitter. This results in smoother particle spawning behaviour than if ParticleSystem:setPosition is used every frame.
ParticleSystem:
| x | number | Position along x-axis. |
| y | number | Position along y-axis. |
Resets the particle emitter, removing any existing particles and resetting the lifetime counter.
ParticleSystem:
Sets area-based spawn parameters for the particles. Newly created particles will spawn in an area around the emitter based on the parameters to this function.
ParticleSystem:
| distribution | AreaSpreadDistribution | The type of distribution for new particles. |
| dx | number | The maximum spawn distance from the emitter along the x-axis for uniform distribution, or the standard deviation along the x-axis for normal distribution. |
| dy | number | The maximum spawn distance from the emitter along the y-axis for uniform distribution, or the standard deviation along the y-axis for normal distribution. |
Sets the size of the buffer (the max allowed amount of particles in the system).
ParticleSystem:
| buffer | number | The buffer size. |
Sets a series of colors to apply to the particle sprite. The particle system will interpolate between each color evenly over the particle's lifetime. Color modulation needs to be activated for this function to have any effect.
Arguments are passed in groups of four, representing the components of the desired RGBA value. At least one color must be specified. A maximum of eight may be used.
ParticleSystem:
| r1 | number | First color, red component (0-255). |
| g1 | number | First color, green component (0-255). |
| b1 | number | First color, blue component (0-255). |
| a1 | number | First color, alpha component (0-255). |
| r2 | number | Second color, red component (0-255). |
| g2 | number | Second color, green component (0-255). |
| b2 | number | Second color, blue component (0-255). |
| a2 | number | Second color, alpha component (0-255). |
| ... | number | Etc. |
Sets the direction the particles will be emitted in.
ParticleSystem:
| direction | number | The direction of the particles (in radians). |
ParticleSystem:
Sets the amount of particles emitted per second.
ParticleSystem:
| rate | number | The amount of particles per second. |
ParticleSystem:
Sets how long the particle system should emit particles (if -1 then it emits particles forever).
ParticleSystem:
| life | number | The lifetime of the emitter (in seconds). |
Sets the mode to use when the ParticleSystem adds new particles.
ParticleSystem:
| mode | ParticleInsertMode | The mode to use when the ParticleSystem adds new particles. |
ParticleSystem:
Sets the linear acceleration (acceleration along the x and y axes) for particles.
Every particle created will accelerate along the x and y axes between xmin,ymin and xmax,ymax.
ParticleSystem:
| xmin | number | The minimum acceleration along the x axis. |
| ymin (0) | number | The minimum acceleration along the y axis. |
| xmax (xmin) | number | The maximum acceleration along the x axis. |
| ymax (ymin) | number | The maximum acceleration along the y axis. |
ParticleSystem:
Sets the amount of linear damping (constant deceleration) for particles.
ParticleSystem:
| min | number | The minimum amount of linear damping applied to particles. |
| max | number | The maximum amount of linear damping applied to particles. |
Set the offset position which the particle sprite is rotated around. If this function is not used, the particles rotate around their center.
ParticleSystem:
| x | number | The x coordinate of the rotation offset. |
| y | number | The y coordinate of the rotation offset. |
ParticleSystem:
Sets the life of the particles.
ParticleSystem:
| min | number | The minimum life of the particles (seconds). |
| max (min) | number | The maximum life of the particles (seconds). |
Sets the position of the emitter.
ParticleSystem:
| x | number | Position along x-axis. |
| y | number | Position along y-axis. |
Sets a series of Quads to use for the particle sprites. Particles will choose a Quad from the list based on the particle's current lifetime, allowing for the use of animated sprite sheets with ParticleSystems.
ParticleSystem:
| quad1 | Quad | The first Quad to use. |
| quad2 | Quad | The second Quad to use. |
ParticleSystem:
| quads | table | A table containing the Quads to use. |
ParticleSystem:
Set the radial acceleration (away from the emitter).
ParticleSystem:
| min | number | The minimum acceleration. |
| max (min) | number | The maximum acceleration. |
ParticleSystem:
Sets whether particle angles and rotations are relative to their velocities. If enabled, particles are aligned to the angle of their velocities and rotate relative to that angle.
ParticleSystem:
| enable | boolean | True to enable relative particle rotation, false to disable it. |
Sets the rotation of the image upon particle creation (in radians).
ParticleSystem:
| min | number | The minimum initial angle (radians). |
| max (min) | number | The maximum initial angle (radians). |
Sets a series of sizes by which to scale a particle sprite. 1.0 is normal size. The particle system will interpolate between each size evenly over the particle's lifetime.
At least one size must be specified. A maximum of eight may be used.
ParticleSystem:
| size1 | number | The first size. |
| size2 | number | The second size. |
| ... | number | Etc. |
ParticleSystem:
Sets the degree of variation (0 meaning no variation and 1 meaning full variation between start and end).
ParticleSystem:
| variation | number | The degree of variation (0 meaning no variation and 1 meaning full variation between start and end). |
Sets the speed of the particles.
ParticleSystem:
| min | number | The minimum linear speed of the particles. |
| max (min) | number | The maximum linear speed of the particles. |
Sets the spin of the sprite.
ParticleSystem:
| min | number | The minimum spin (radians per second). |
| max (min) | number | The maximum spin (radians per second). |
ParticleSystem:
Sets the degree of variation (0 meaning no variation and 1 meaning full variation between start and end).
ParticleSystem:
| variation | number | The degree of variation (0 meaning no variation and 1 meaning full variation between start and end). |
Sets the amount of spread for the system.
ParticleSystem:
| spread | number | The amount of spread (radians). |
Sets the Image or Canvas which is to be emitted.
ParticleSystem:
| texture | Texture | An Image or Canvas to use for the particle. |
ParticleSystem:
Sets the tangential acceleration (acceleration perpendicular to the particle's direction).
ParticleSystem:
| min | number | The minimum acceleration. |
| max (min) | number | The maximum acceleration. |
Updates the particle system; moving, creating and killing particles.
ParticleSystem:
| dt | number | The time (seconds) since last frame. |
A quadrilateral (a polygon with four sides and four corners) with texture coordinate information.
Quads can be used to select part of a texture to draw. In this way, one large texture atlas can be loaded, and then split up into sub-images.
Gets reference texture dimensions initially specified in love.graphics.newQuad.
sw, sh = Quad:
| sw | number | The Texture width used by the Quad. |
| sh | number | The Texture height used by the Quad. |
Gets the current viewport of this Quad.
x, y, w, h = Quad:
| x | number | The top-left corner along the x-axis. |
| y | number | The top-right corner along the y-axis. |
| w | number | The width of the viewport. |
| h | number | The height of the viewport. |
Sets the texture coordinates according to a viewport.
Quad:
| x | number | The top-left corner along the x-axis. |
| y | number | The top-right corner along the y-axis. |
| w | number | The width of the viewport. |
| h | number | The height of the viewport. |
A Shader is used for advanced hardware-accelerated pixel or vertex manipulation. These effects are written in a language based on GLSL (OpenGL Shading Language) with a few things simplified for easier coding.
Potential uses for shaders include HDR/bloom, motion blur, grayscale/invert/sepia/any kind of color effect, reflection/refraction, distortions, bump mapping, and much more! Here is a collection of basic shaders and good starting point to learn: https://github.com/vrld/shine
Gets information about an 'extern' ('uniform') variable in the shader.
type, components, arrayelements = Shader:
| type | ShaderVariableType | The base type of the variable. |
| components | number | The number of components in the variable (e.g. 2 for a vec2 or mat2.) |
| arrayelements | number | The number of elements in the array if the variable is an array, or 1 if not. |
| name | string | The name of the extern variable. |
Gets any warning and error messages from compiling the shader code. This can be used for debugging your shaders if there's anything the graphics hardware doesn't like.
warnings = Shader:
| warnings | string | Warning messages (if any). |
Sends one or more values to a special (uniform) variable inside the shader. Uniform variables have to be marked using the uniform or extern keyword.
Shader:
| name | string | Name of the number to send to the shader. |
| number | number | Number to send to store in the uniform variable. |
| ... | number | Additional numbers to send if the uniform variable is an array. |
Shader:
| name | string | Name of the vector to send to the shader. |
| vector | table | Numbers to send to the uniform variable as a vector. The number of elements in the table determines the type of the vector (e.g. two numbers -> vec2). At least two and at most four numbers can be used. |
| ... | table | Additional vectors to send if the uniform variable is an array. All vectors need to be of the same size (e.g. only vec3's). |
Shader:
| name | string | Name of the matrix to send to the shader. |
| matrix | table | 2x2, 3x3, or 4x4 matrix to send to the uniform variable. Using table form: {{a,b,c,d}, {e,f,g,h}, ... }. |
| ... | table | Additional matrices of the same type as matrix to store in a uniform array. |
Shader:
| name | string | Name of the Texture to send to the shader. |
| texture | Texture | Texture (Image or Canvas) to send to the uniform variable. |
Shader:
| name | string | Name of the boolean to send to the shader. |
| boolean | boolean | Boolean to send to store in the uniform variable. |
| ... | boolean | Additional booleans to send if the uniform variable is an array. |
Sends one or more colors to a special (extern / uniform) vec3 or vec4 variable inside the shader. The color components must be in the range of [0, 255], unlike Shader:send. The colors are gamma-corrected if global gamma-correction is enabled.
Shader:
| name | string | The name of the color extern variable to send to in the shader. |
| color | table | A table with red, green, blue, and optional alpha color components in the range of [0, 255] to send to the extern as a vector. |
| ... | table | Additional colors to send in case the extern is an array. All colors need to be of the same size (e.g. only vec3's). |
Using a single image, draw any number of identical copies of the image using a single call to love.graphics.draw. This can be used, for example, to draw repeating copies of a single background image.
A SpriteBatch can be even more useful when the underlying image is a Texture Atlas (a single image file containing many independent images); by adding Quad to the batch, different sub-images from within the atlas can be drawn.
Add a sprite to the batch.
id = SpriteBatch:
| id | number | An identifier for the added sprite. |
| x | number | The position to draw the object (x-axis). |
| y | number | The position to draw the object (y-axis). |
| r (0) | number | Orientation (radians). |
| sx (1) | number | Scale factor (x-axis). |
| sy (sx) | number | Scale factor (y-axis). |
| ox (0) | number | Origin offset (x-axis). |
| oy (0) | number | Origin offset (y-axis). |
| kx (0) | number | Shear factor (x-axis). |
| ky (0) | number | Shear factor (y-axis). |
id = SpriteBatch:
| id | number | An identifier for the added sprite. |
| quad | Quad | The Quad to add. |
| x | number | The position to draw the object (x-axis). |
| y | number | The position to draw the object (y-axis). |
| r (0) | number | Orientation (radians). |
| sx (1) | number | Scale factor (x-axis). |
| sy (sx) | number | Scale factor (y-axis). |
| ox (0) | number | Origin offset (x-axis). |
| oy (0) | number | Origin offset (y-axis). |
| kx (0) | number | Shear factor (x-axis). |
| ky (0) | number | Shear factor (y-axis). |
Attaches a per-vertex attribute from a Mesh onto this SpriteBatch, for use when drawing. This can be combined with a Shader to augment a SpriteBatch with per-vertex or additional per-sprite information instead of just having per-sprite colors.
Each sprite in a SpriteBatch has 4 vertices in the following order: top-left, bottom-left, top-right, bottom-right. The index returned by SpriteBatch:add (and used by SpriteBatch:set) can be multiplied by 4 to determine the first vertex in a specific sprite.
SpriteBatch:
| name | string | The name of the vertex attribute to attach. |
| mesh | Mesh | The Mesh to get the vertex attribute from. |
Immediately sends all new and modified sprite data in the batch to the graphics card.
SpriteBatch:
Gets the maximum number of sprites the SpriteBatch can hold.
size = SpriteBatch:
| size | number | The maximum number of sprites the batch can hold. |
Gets the color that will be used for the next add and set operations.
If no color has been set with SpriteBatch:setColor or the current SpriteBatch color has been cleared, this method will return nil.
r, g, b, a = SpriteBatch:
| r | number | The red component (0-255). |
| g | number | The green component (0-255). |
| b | number | The blue component (0-255). |
| a | number | The alpha component (0-255). |
Gets the amount of sprites currently in the SpriteBatch.
count = SpriteBatch:
| count | number | The amount of sprites currently in the batch. |
Gets the Image or Canvas used by the SpriteBatch.
texture = SpriteBatch:
| texture | Texture | The Image or Canvas for the sprites. |
Changes a sprite in the batch. This requires the identifier returned by add and addq.
SpriteBatch:
| id | number | The identifier of the sprite that will be changed. |
| x | number | The position to draw the object (x-axis). |
| y | number | The position to draw the object (y-axis). |
| r (0) | number | Orientation (radians). |
| sx (1) | number | Scale factor (x-axis). |
| sy (sx) | number | Scale factor (y-axis). |
| ox (0) | number | Origin offset (x-axis). |
| oy (0) | number | Origin offset (y-axis). |
| kx (0) | number | Shear factor (x-axis). |
| ky (0) | number | Shear factor (y-axis). |
SpriteBatch:
| id | number | The identifier of the sprite that will be changed. |
| quad | Quad | The quad used on the image of the batch. |
| x | number | The position to draw the object (x-axis). |
| y | number | The position to draw the object (y-axis). |
| r (0) | number | Orientation (radians). |
| sx (1) | number | Scale factor (x-axis). |
| sy (sx) | number | Scale factor (y-axis). |
| ox (0) | number | Origin offset (x-axis). |
| oy (0) | number | Origin offset (y-axis). |
| kx (0) | number | Shear factor (x-axis). |
| ky (0) | number | Shear factor (y-axis). |
Sets the maximum number of sprites the SpriteBatch can hold. Existing sprites in the batch (up to the new maximum) will not be cleared when this function is called.
SpriteBatch:
| size | number | The new maximum number of sprites the batch can hold. |
Sets the color that will be used for the next add and set operations. Calling the function without arguments will clear the color.
In version [[0.9.2]] and older, the global color set with love.graphics.setColor will not work on the SpriteBatch if any of the sprites has its own color.
SpriteBatch:
| r | number | The amount of red. |
| g | number | The amount of green. |
| b | number | The amount of blue. |
| a (255) | number | The amount of alpha. |
SpriteBatch:
Disables all per-sprite colors for this SpriteBatch.
Replaces the Image or Canvas used for the sprites.
SpriteBatch:
| texture | Texture | The new Image or Canvas to use for the sprites. |
Drawable text.
Adds additional colored text to the Text object at the specified position.
index = Text:
| index | number | An index number that can be used with Text:getWidth or Text:getHeight. |
| textstring | string | The text to add to the object. |
| x (0) | number | The position of the new text on the x-axis. |
| y (0) | number | The position of the new text on the y-axis. |
| angle (0) | number | The orientation of the new text in radians. |
| sx (1) | number | Scale factor on the x-axis. |
| sy (sx) | number | Scale factor on the y-axis. |
| ox (0) | number | Origin offset on the x-axis. |
| oy (0) | number | Origin offset on the y-axis. |
| kx (0) | number | Shearing / skew factor on the x-axis. |
| ky (0) | number | Shearing / skew factor on the y-axis. |
index = Text:
| index | number | An index number that can be used with Text:getWidth or Text:getHeight. |
| coloredtext | table | A table containing colors and strings to use as the new text, in the form of { color1, string1, color2, string2, ... }. |
| coloredtext.color1 | table | A table containing red, green, blue, and optional alpha components to use as a color for the next string in the table, in the form of {red, green, blue, alpha}. |
| coloredtext.string1 | string | A string of text which has a color specified by the previous color. |
| coloredtext.color2 | table | A table containing red, green, blue, and optional alpha components to use as a color for the next string in the table, in the form of {red, green, blue, alpha}. |
| coloredtext.string2 | string | A string of text which has a color specified by the previous color. |
| coloredtext.... | tables and strings | Additional colors and strings. |
| x (0) | number | The position of the new text on the x-axis. |
| y (0) | number | The position of the new text on the y-axis. |
| angle (0) | number | The orientation of the new text in radians. |
| sx (1) | number | Scale factor on the x-axis. |
| sy (sx) | number | Scale factor on the y-axis. |
| ox (0) | number | Origin offset on the x-axis. |
| oy (0) | number | Origin offset on the y-axis. |
| kx (0) | number | Shearing / skew factor on the x-axis. |
| ky (0) | number | Shearing / skew factor on the y-axis. |
Adds additional formatted / colored text to the Text object at the specified position.
index = Text:
| index | number | An index number that can be used with Text:getWidth or Text:getHeight. |
| textstring | string | The text to add to the object. |
| wraplimit | number | The maximum width in pixels of the text before it gets automatically wrapped to a new line. |
| align | AlignMode | The alignment of the text. |
| x | number | The position of the new text on the x-axis. |
| y | number | The position of the new text on the y-axis. |
| angle (0) | number | The orientation of the object in radians. |
| sx (1) | number | Scale factor on the x-axis. |
| sy (sx) | number | Scale factor on the y-axis. |
| ox (0) | number | Origin offset on the x-axis. |
| oy (0) | number | Origin offset on the y-axis. |
| kx (0) | number | Shearing / skew factor on the x-axis. |
| ky (0) | number | Shearing / skew factor on the y-axis. |
index = Text:
| index | number | An index number that can be used with Text:getWidth or Text:getHeight. |
| coloredtext | table | A table containing colors and strings to use as the new text, in the form of { color1, string1, color2, string2, ... }. |
| coloredtext.color1 | table | A table containing red, green, blue, and optional alpha components to use as a color for the next string in the table, in the form of {red, green, blue, alpha}. |
| coloredtext.string1 | string | A string of text which has a color specified by the previous color. |
| coloredtext.color2 | table | A table containing red, green, blue, and optional alpha components to use as a color for the next string in the table, in the form of {red, green, blue, alpha}. |
| coloredtext.string2 | string | A string of text which has a color specified by the previous color. |
| coloredtext.... | tables and strings | Additional colors and strings. |
| wraplimit | number | The maximum width in pixels of the text before it gets automatically wrapped to a new line. |
| align | AlignMode | The alignment of the text. |
| x | number | The position of the new text on the x-axis. |
| y | number | The position of the new text on the y-axis. |
| angle (0) | number | The orientation of the object in radians. |
| sx (1) | number | Scale factor on the x-axis. |
| sy (sx) | number | Scale factor on the y-axis. |
| ox (0) | number | Origin offset on the x-axis. |
| oy (0) | number | Origin offset on the y-axis. |
| kx (0) | number | Shearing / skew factor on the x-axis. |
| ky (0) | number | Shearing / skew factor on the y-axis. |
Gets the width and height of the text in pixels.
width, height = Text:
| width | number | The width of the text. If multiple sub-strings have been added with Text:add, the width of the last sub-string is returned. |
| height | number | The height of the text. If multiple sub-strings have been added with Text:add, the height of the last sub-string is returned. |
width, height = Text:
Gets the width and height of a specific sub-string that was previously added to the Text object.
| width | number | The width of the sub-string (before scaling and other transformations). |
| height | number | The height of the sub-string (before scaling and other transformations). |
| index | number | An index number returned by Text:add or Text:addf. |
Gets the Font used with the Text object.
font = Text:
| font | Font | The font used with this Text object. |
Gets the height of the text in pixels.
height = Text:
| height | number | The height of the text. If multiple sub-strings have been added with Text:add, the height of the last sub-string is returned. |
height = Text:
Gets the height of a specific sub-string that was previously added to the Text object.
| height | number | The height of the sub-string (before scaling and other transformations). |
| index | number | An index number returned by Text:add or Text:addf. |
Gets the width of the text in pixels.
width = Text:
| width | number | The width of the text. If multiple sub-strings have been added with Text:add, the width of the last sub-string is returned. |
width = Text:
Gets the width of a specific sub-string that was previously added to the Text object.
| width | number | The width of the sub-string (before scaling and other transformations). |
| index | number | An index number returned by Text:add or Text:addf. |
Replaces the contents of the Text object with a new unformatted string.
Text:
| textstring | string | The new string of text to use. |
Text:
| coloredtext | table | A table containing colors and strings to use as the new text, in the form of { color1, string1, color2, string2, ... }. |
| coloredtext.color1 | table | A table containing red, green, blue, and optional alpha components to use as a color for the next string in the table, in the form of {red, green, blue, alpha}. |
| coloredtext.string1 | string | A string of text which has a color specified by the previous color. |
| coloredtext.color2 | table | A table containing red, green, blue, and optional alpha components to use as a color for the next string in the table, in the form of {red, green, blue, alpha}. |
| coloredtext.string2 | string | A string of text which has a color specified by the previous color. |
| coloredtext.... | tables and strings | Additional colors and strings. |
Text:
Clears the contents of the Text object.
Replaces the contents of the Text object with a new formatted string.
Text:
| textstring | string | The new string of text to use. |
| wraplimit | number | The maximum width in pixels of the text before it gets automatically wrapped to a new line. |
| align ("left") | AlignMode | The alignment of the text. |
Text:
| coloredtext | table | A table containing colors and strings to use as the new text, in the form of { color1, string1, color2, string2, ... }. |
| coloredtext.color1 | table | A table containing red, green, blue, and optional alpha components to use as a color for the next string in the table, in the form of {red, green, blue, alpha}. |
| coloredtext.string1 | string | A string of text which has a color specified by the previous color. |
| coloredtext.color2 | table | A table containing red, green, blue, and optional alpha components to use as a color for the next string in the table, in the form of {red, green, blue, alpha}. |
| coloredtext.string2 | string | A string of text which has a color specified by the previous color. |
| coloredtext.... | tables and strings | Additional colors and strings. |
| wraplimit | number | The maximum width in pixels of the text before it gets automatically wrapped to a new line. |
| align ("left") | AlignMode | The alignment of the text. |
Text:
Clears the contents of the Text object.
Replaces the Font used with the text.
Text:
| font | Font | The new font to use with this Text object. |
Superclass for drawable objects which represent a texture. All Textures can be drawn with Quads. This is an abstract type that can't be created directly.
A drawable video.
Gets the width and height of the Video in pixels.
width, height = Video:
| width | number | The width of the Video. |
| height | number | The height of the video. |
Gets the scaling filters used when drawing the Video.
min, mag, anisotropy = Video:
| min | FilterMode | The filter mode used when scaling the Video down. |
| mag | FilterMode | The filter mode used when scaling the Video up. |
| anisotropy (1) | number | Maximum amount of anisotropic filtering used. |
Gets the height of the Video in pixels.
height = Video:
| height | number | The height of the Video. |
Gets the audio Source used for playing back the video's audio. May return nil if the video has no audio, or if Video:setSource is called with a nil argument.
source = Video:
| source | Source | The audio Source used for audio playback, or nil if the video has no audio. |
Gets whether the Video is currently playing.
playing = Video:
| playing | boolean | Whether the video is playing. |
Starts playing the Video. In order for the video to appear onscreen it must be drawn with love.graphics.draw.
Video:
Sets the current playback position of the Video.
Video:
| offset | number | The time in seconds since the beginning of the Video. |
Sets the scaling filters used when drawing the Video.
Video:
| min | FilterMode | The filter mode used when scaling the Video down. |
| mag | FilterMode | The filter mode used when scaling the Video up. |
| anisotropy (1) | number | Maximum amount of anisotropic filtering used. |
Sets the audio Source used for playing back the video's audio. The audio Source also controls playback speed and synchronization.
Video:
| source (nil) | Source | The audio Source used for audio playback, or nil to disable audio synchronization. |
Gets the current playback position of the Video.
Video:
| seconds | number | The time in seconds since the beginning of the Video. |
Determines whether a file can be loaded as CompressedImageData.
compressed = love.image.
| compressed | boolean | Whether the file can be loaded as CompressedImageData or not. |
| filename | string | The filename of the potentially compressed image file. |
compressed = love.image.
| compressed | boolean | Whether the FileData can be loaded as CompressedImageData or not. |
| fileData | FileData | A FileData potentially containing a compressed image. |
Create a new CompressedImageData object from a compressed image file. LÖVE supports several compressed texture formats, enumerated in the CompressedImageFormat page.
compressedImageData = love.image.
| compressedImageData | CompressedImageData | The new CompressedImageData object. |
| file | string / File / FileData | The file path/File/FileData of the compressed image file. |
Create a new ImageData object.
imageData = love.image.
| imageData | ImageData | The new blank ImageData object. Each pixel's color values, (including the alpha values!) will be set to zero. |
| width | number | The width of the ImageData. |
| height | number | The height of the ImageData. |
| data (none) | string | The data to load into the ImageData (RGBA bytes, left to right and top to bottom). |
imageData = love.image.
| imageData | ImageData | The new ImageData object. |
| file | string / File / FileData | The file path/File/FileData of the image file. |
DXT1
The DXT1 format. RGB data at 4 bits per pixel (compared to 32 bits for ImageData and regular Images.) Suitable for fully opaque images. Suitable for fully opaque images on desktop systems.
DXT3
The DXT3 format. RGBA data at 8 bits per pixel. Smooth variations in opacity do not mix well with this format.
DXT5
The DXT5 format. RGBA data at 8 bits per pixel. Recommended for images with varying opacity on desktop systems.
BC4
The BC4 format (also known as 3Dc+ or ATI1.) Stores just the red channel, at 4 bits per pixel.
BC4s
The signed variant of the BC4 format. Same as above but the pixel values in the texture are in the range of [-1, 1] instead of [0, 1] in shaders.
BC5
The BC5 format (also known as 3Dc or ATI2.) Stores red and green channels at 8 bits per pixel.
BC5s
The signed variant of the BC5 format.
BC6h
The BC6H format. Stores half-precision floating-point RGB data in the range of [0, 65504] at 8 bits per pixel. Suitable for HDR images on desktop systems.
BC6hs
The signed variant of the BC6H format. Stores RGB data in the range of [-65504, +65504].
BC7
The BC7 format (also known as BPTC.) Stores RGB or RGBA data at 8 bits per pixel.
ETC1
The ETC1 format. RGB data at 4 bits per pixel. Suitable for fully opaque images on older Android devices.
ETC2rgb
The RGB variant of the ETC2 format. RGB data at 4 bits per pixel. Suitable for fully opaque images on newer mobile devices.
ETC2rgba
The RGBA variant of the ETC2 format. RGBA data at 8 bits per pixel. Recommended for images with varying opacity on newer mobile devices.
ETC2rgba1
The RGBA variant of the ETC2 format where pixels are either fully transparent or fully opaque. RGBA data at 4 bits per pixel.
EACr
The single-channel variant of the EAC format. Stores just the red channel, at 4 bits per pixel.
EACrs
The signed single-channel variant of the EAC format. Same as above but pixel values in the texture are in the range of [-1, 1] instead of [0, 1] in shaders.
EACrg
The two-channel variant of the EAC format. Stores red and green channels at 8 bits per pixel.
EACrgs
The signed two-channel variant of the EAC format.
PVR1rgb2
The 2 bit per pixel RGB variant of the PVRTC1 format. Stores RGB data at 2 bits per pixel. Textures compressed with PVRTC1 formats must be square and power-of-two sized.
PVR1rgb4
The 4 bit per pixel RGB variant of the PVRTC1 format. Stores RGB data at 4 bits per pixel.
PVR1rgba2
The 2 bit per pixel RGBA variant of the PVRTC1 format.
PVR1rgba4
The 4 bit per pixel RGBA variant of the PVRTC1 format.
ASTC4x4
The 4x4 pixels per block variant of the ASTC format. RGBA data at 8 bits per pixel.
ASTC5x4
The 5x4 pixels per block variant of the ASTC format. RGBA data at 6.4 bits per pixel.
ASTC5x5
The 5x5 pixels per block variant of the ASTC format. RGBA data at 5.12 bits per pixel.
ASTC6x5
The 6x5 pixels per block variant of the ASTC format. RGBA data at 4.27 bits per pixel.
ASTC6x6
The 6x6 pixels per block variant of the ASTC format. RGBA data at 3.56 bits per pixel.
ASTC8x5
The 8x5 pixels per block variant of the ASTC format. RGBA data at 3.2 bits per pixel.
ASTC8x6
The 8x6 pixels per block variant of the ASTC format. RGBA data at 2.67 bits per pixel.
ASTC8x8
The 8x8 pixels per block variant of the ASTC format. RGBA data at 2 bits per pixel.
ASTC10x5
The 10x5 pixels per block variant of the ASTC format. RGBA data at 2.56 bits per pixel.
ASTC10x6
The 10x6 pixels per block variant of the ASTC format. RGBA data at 2.13 bits per pixel.
ASTC10x8
The 10x8 pixels per block variant of the ASTC format. RGBA data at 1.6 bits per pixel.
ASTC10x10
The 10x10 pixels per block variant of the ASTC format. RGBA data at 1.28 bits per pixel.
ASTC12x10
The 12x10 pixels per block variant of the ASTC format. RGBA data at 1.07 bits per pixel.
ASTC12x12
The 12x12 pixels per block variant of the ASTC format. RGBA data at 0.89 bits per pixel.
Represents compressed image data designed to stay compressed in RAM.
CompressedImageData encompasses standard compressed texture formats such as DXT1, DXT5, and BC5 / 3Dc.
You can't draw CompressedImageData directly to the screen. See Image for that.
CompressedImageData:
Gets the width and height of the CompressedImageData.
width, height = CompressedImageData:
| width | number | The width of the CompressedImageData. |
| height | number | The height of the CompressedImageData. |
width, height = CompressedImageData:
| width | number | The width of the CompressedImageData. |
| height | number | The height of the CompressedImageData. |
| level | number | A mipmap level. Must be in the range of [1, CompressedImageData:getMipmapCount()]. |
Gets the format of the CompressedImageData.
format = CompressedImageData:
| format | CompressedImageFormat | The format of the CompressedImageData. |
Gets the height of the CompressedImageData.
height = CompressedImageData:
| height | number | The height of the CompressedImageData. |
height = CompressedImageData:
| height | number | The height of the CompressedImageData. |
| level | number | A mipmap level. Must be in the range of [1, CompressedImageData:getMipmapCount()]. |
CompressedImageData:
Gets the number of mipmap levels in the CompressedImageData. The base mipmap level (original image) is included in the count.
mipmaps = CompressedImageData:
| mipmaps | number | The number of mipmap levels stored in the CompressedImageData. |
Gets the width of the CompressedImageData.
width = CompressedImageData:
| width | number | The width of the CompressedImageData. |
width = CompressedImageData:
| width | number | The width of the CompressedImageData. |
| level | number | A mipmap level. Must be in the range of [1, CompressedImageData:getMipmapCount()]. |
Encodes the ImageData and optionally writes it to the save directory.
filedata = ImageData:
| filedata | FileData | The encoded image as a new FileData object. |
| format | ImageFormat | The format to encode the image as. |
| filename (nil) | string | The filename to write the file to. If nil, no file will be written but the FileData will still be returned. |
Gets the width and height of the ImageData in pixels.
width, height = ImageData:
| width | number | The width of the ImageData in pixels. |
| height | number | The height of the ImageData in pixels. |
Gets the height of the ImageData in pixels.
height = ImageData:
| height | number | The height of the ImageData in pixels. |
Gets the color of a pixel at a specific position in the image.
Valid x and y values start at 0 and go up to image width and height minus 1. Non-integer values are floored.
r, g, b, a = ImageData:
| r | number | The red component (0-255). |
| g | number | The green component (0-255). |
| b | number | The blue component (0-255). |
| a | number | The alpha component (0-255). |
| x | number | The position of the pixel on the x-axis. |
| y | number | The position of the pixel on the y-axis. |
Gets the width of the ImageData in pixels.
width = ImageData:
| width | number | The width of the ImageData in pixels. |
Transform an image by applying a function to every pixel.
This function is a higher order function. It takes another function as a parameter, and calls it once for each pixel in the ImageData.
The function parameter is called with six parameters for each pixel in turn. The parameters are numbers that represent the x and y coordinates of the pixel and its red, green, blue and alpha values. The function parameter can return up to four number values, which become the new r, g, b and a values of the pixel. If the function returns fewer values, the remaining components are set to 0.
ImageData:
| pixelFunction | function | Function parameter to apply to every pixel. |
Paste into ImageData from another source ImageData.
ImageData:
| source | ImageData | Source ImageData from which to copy. |
| dx | number | Destination top-left position on x-axis. |
| dy | number | Destination top-left position on y-axis. |
| sx | number | Source top-left position on x-axis. |
| sy | number | Source top-left position on y-axis. |
| sw | number | Source width. |
| sh | number | Source height. |
Sets the color of a pixel at a specific position in the image.
Valid x and y values start at 0 and go up to image width and height minus 1.
ImageData:
| x | number | The position of the pixel on the x-axis. |
| y | number | The position of the pixel on the y-axis. |
| r | number | The red component (0-255). |
| g | number | The green component (0-255). |
| b | number | The blue component (0-255). |
| a | number | The alpha component (0-255). |
love.joystick.
Gets the number of connected joysticks.
joystickcount = love.joystick.
| joystickcount | number | The number of connected joysticks. |
Gets a list of connected Joysticks.
joysticks = love.joystick.
| joysticks | table | The list of currently connected Joysticks. |
love.joystick.
Loads a gamepad mappings string or file created with love.joystick.saveGamepadMappings.
love.joystick.
| filename | string | The filename to load the mappings string from. |
love.joystick.
| mappings | string | The mappings string to load. |
love.joystick.
Saves the virtual gamepad mappings of all Joysticks that are recognized as gamepads and have either been recently used or their gamepad bindings have been modified.
mappings = love.joystick.
| mappings | string | The mappings string that was written to the file. |
| filename (no file) | string | The filename to save the mappings string to. |
love.joystick.
Binds a virtual gamepad input to a button, axis or hat for all Joysticks of a certain type. For example, if this function is used with a GUID returned by a Dualshock 3 controller in OS X, the binding will affect Joystick:getGamepadAxis and Joystick:isGamepadDown for all Dualshock 3 controllers used with the game when run in OS X.
LÖVE includes built-in gamepad bindings for many common controllers. This function lets you change the bindings or add new ones for types of Joysticks which aren't recognized as gamepads by default.
The virtual gamepad buttons and axes are designed around the Xbox 360 controller layout.
success = love.joystick.
| success | boolean | Whether the virtual gamepad button was successfully bound. |
| guid | string | The OS-dependent GUID for the type of Joystick the binding will affect. |
| button | GamepadButton | The virtual gamepad button to bind. |
| inputtype | JoystickInputType | The type of input to bind the virtual gamepad button to. |
| inputindex | number | The index of the axis, button, or hat to bind the virtual gamepad button to. |
| hatdirection | JoystickHat | The direction of the hat, if the virtual gamepad button will be bound to a hat. nil otherwise. |
success = love.joystick.
| success | boolean | Whether the virtual gamepad button was successfully bound. |
| guid | string | The OS-dependent GUID for the type of Joystick the binding will affect. |
| axis | GamepadAxis | The virtual gamepad axis to bind. |
| inputtype | JoystickInputType | The type of input to bind the virtual gamepad axis to. |
| inputindex | number | The index of the axis, button, or hat to bind the virtual gamepad axis to. |
| hatdirection | JoystickHat | The direction of the hat, if the virtual gamepad axis will be bound to a hat. nil otherwise. |
leftx
The x-axis of the left thumbstick.
lefty
The y-axis of the left thumbstick.
rightx
The x-axis of the right thumbstick.
righty
The y-axis of the right thumbstick.
triggerleft
Left analog trigger.
triggerright
Right analog trigger.
a
Bottom face button (A).
b
Right face button (B).
x
Left face button (X).
y
Top face button (Y).
back
Back button.
guide
Guide button.
start
Start button.
leftstick
Left stick click button.
rightstick
Right stick click button.
leftshoulder
Left bumper.
rightshoulder
Right bumper.
dpup
D-pad up.
dpdown
D-pad down.
dpleft
D-pad left.
dpright
D-pad right.
Represents a physical joystick.
Gets the direction of each axis.
axisDir1, axisDir2, axisDirN = Joystick:
| axisDir1 | number | Direction of axis1. |
| axisDir2 | number | Direction of axis2. |
| axisDirN | number | Direction of axisN. |
Gets the direction of an axis.
direction = Joystick:
| direction | number | Current value of the axis. |
| axis | number | The index of the axis to be checked. |
Gets the number of axes on the joystick.
axes = Joystick:
| axes | number | The number of axes available. |
Gets the number of buttons on the joystick.
buttons = Joystick:
| buttons | number | The number of buttons available. |
Gets a stable GUID unique to the type of the physical joystick which does not change over time. For example, all Sony Dualshock 3 controllers in OS X have the same GUID. The value is platform-dependent.
guid = Joystick:
| guid | string | The Joystick type's OS-dependent unique identifier. |
Gets the direction of a virtual gamepad axis. If the Joystick isn't recognized as a gamepad or isn't connected, this function will always return 0.
direction = Joystick:
| direction | number | Current value of the axis. |
| axis | GamepadAxis | The virtual axis to be checked. |
Gets the button, axis or hat that a virtual gamepad input is bound to.
inputtype, inputindex, hatdirection = Joystick:
| inputtype | JoystickInputType | The type of input the virtual gamepad axis is bound to. |
| inputindex | number | The index of the Joystick's button, axis or hat that the virtual gamepad axis is bound to. |
| hatdirection | JoystickHat | The direction of the hat, if the virtual gamepad axis is bound to a hat. nil otherwise. |
| axis | GamepadAxis | The virtual gamepad axis to get the binding for. |
inputtype, inputindex, hatdirection = Joystick:
| inputtype | JoystickInputType | The type of input the virtual gamepad button is bound to. |
| inputindex | number | The index of the Joystick's button, axis or hat that the virtual gamepad button is bound to. |
| hatdirection | JoystickHat | The direction of the hat, if the virtual gamepad button is bound to a hat. nil otherwise. |
| button | GamepadAxis | The virtual gamepad button to get the binding for. |
Gets the direction of the Joystick's hat.
direction = Joystick:
| direction | JoystickHat | The direction the hat is pushed. |
| hat | number | The index of the hat to be checked. |
Gets the number of hats on the joystick.
hats = Joystick:
| hats | number | How many hats the joystick has. |
Gets the joystick's unique identifier. The identifier will remain the same for the life of the game, even when the Joystick is disconnected and reconnected, but it will change when the game is re-launched.
id, instanceid = Joystick:
| id | number | The Joystick's unique identifier. Remains the same as long as the game is running. |
| instanceid | number | Unique instance identifier. Changes every time the Joystick is reconnected. nil if the Joystick is not connected. |
Gets the name of the joystick.
name = Joystick:
| name | string | The name of the joystick. |
Gets the current vibration motor strengths on a Joystick with rumble support.
left, right = Joystick:
| left | number | Current strength of the left vibration motor on the Joystick. |
| right | number | Current strength of the right vibration motor on the Joystick. |
Gets whether the Joystick is connected.
connected = Joystick:
| connected | boolean | True if the Joystick is currently connected, false otherwise. |
Checks if a button on the Joystick is pressed.
LÖVE 0.9.0 had a bug which required the button indices passed to Joystick:isDown to be 0-based instead of 1-based, for example button 1 would be 0 for this function. It was fixed in 0.9.1.
anyDown = Joystick:
| anyDown | boolean | True if any supplied button is down, false if not. |
| ... | number | The index of a button to check. |
Gets whether the Joystick is recognized as a gamepad. If this is the case, the Joystick's buttons and axes can be used in a standardized manner across different operating systems and joystick models via Joystick:getGamepadAxis and related functions.
LÖVE automatically recognizes most popular controllers with a similar layout to the Xbox 360 controller as gamepads, but you can add more with love.joystick.setGamepadMapping.
isgamepad = Joystick:
| isgamepad | boolean | True if the Joystick is recognized as a gamepad, false otherwise. |
Checks if a virtual gamepad button on the Joystick is pressed. If the Joystick is not recognized as a Gamepad or isn't connected, then this function will always return false.
anyDown = Joystick:
| anyDown | boolean | True if any supplied button is down, false if not. |
| ... | GamepadButton | The gamepad button to check. |
Gets whether the Joystick supports vibration.
supported = Joystick:
| supported | boolean | True if rumble / force feedback vibration is supported on this Joystick, false if not. |
Sets the vibration motor speeds on a Joystick with rumble support.
success = Joystick:
| success | boolean | True if the vibration was successfully applied, false if not. |
| left | number | Strength of the left vibration motor on the Joystick. Must be in the range of [0, 1]. |
| right | number | Strength of the right vibration motor on the Joystick. Must be in the range of [0, 1]. |
| duration (-1) | number | The duration of the vibration in seconds. A negative value means infinite duration. |
love.keyboard.
Gets the key corresponding to the given hardware scancode.
Unlike key constants, Scancodes are keyboard layout-independent. For example the scancode "w" will be generated if the key in the same place as the "w" key on an American keyboard is pressed, no matter what the key is labelled or what the user's operating system settings are.
Scancodes are useful for creating default controls that have the same physical locations on on all systems.
key = love.keyboard.
| key | KeyConstant | The key corresponding to the given scancode, or "unknown" if the scancode doesn't map to a KeyConstant on the current system. |
| scancode | Scancode | The scancode to get the key from. |
love.keyboard.
Gets the hardware scancode corresponding to the given key.
Unlike key constants, Scancodes are keyboard layout-independent. For example the scancode "w" will be generated if the key in the same place as the "w" key on an American keyboard is pressed, no matter what the key is labelled or what the user's operating system settings are.
Scancodes are useful for creating default controls that have the same physical locations on on all systems.
scancode = love.keyboard.
| scancode | Scancode | The scancode corresponding to the given key, or "unknown" if the given key has no known physical representation on the current system. |
| key | KeyConstant | The key to get the scancode from. |
Gets whether key repeat is enabled.
enabled = love.keyboard.
| enabled | boolean | Whether key repeat is enabled. |
Gets whether text input events are enabled.
enabled = love.keyboard.
| enabled | boolean | Whether text input events are enabled. |
Checks whether a certain key is down. Not to be confused with love.keypressed or love.keyreleased.
anyDown = love.keyboard.
| anyDown | boolean | True if any supplied key is down, false if not. |
| key | KeyConstant | A key to check. |
| ... | KeyConstant | Additional keys to check. |
Checks whether the specified Scancodes are pressed. Not to be confused with love.keypressed or love.keyreleased.
Unlike regular KeyConstants, Scancodes are keyboard layout-independent. The scancode "w" is used if the key in the same place as the "w" key on an American keyboard is pressed, no matter what the key is labelled or what the user's operating system settings are.
down = love.keyboard.
| down | boolean | True if any supplied Scancode is down, false if not. |
| scancode | Scancode | A Scancode to check. |
| ... | Scancode | Additional Scancodes to check. |
Enables or disables key repeat. It is disabled by default.
The interval between repeats depends on the user's system settings.
love.keyboard.
| enable | boolean | Whether repeat keypress events should be enabled when a key is held down. |
Enables or disables text input events. It is enabled by default on Windows, Mac, and Linux, and disabled by default on iOS and Android.
love.keyboard.
| enable | boolean | Whether text input events should be enabled. |
love.keyboard.
| enable | boolean | Whether text input events should be enabled. |
| x | number | On-screen keyboard x position. |
| y | number | On-screen keyboard y position. |
| w | number | On-screen keyboard width. |
| h | number | On-screen keyboard height. |
a
The A key
b
The B key
c
The C key
d
The D key
e
The E key
f
The F key
g
The G key
h
The H key
i
The I key
j
The J key
k
The K key
l
The L key
m
The M key
n
The N key
o
The O key
p
The P key
q
The Q key
r
The R key
s
The S key
t
The T key
u
The U key
v
The V key
w
The W key
x
The X key
y
The Y key
z
The Z key
0
The zero key
1
The one key
2
The two key
3
The three key
4
The four key
5
The five key
6
The six key
7
The seven key
8
The eight key
9
The nine key
space
Space key
In version 0.9.2 and earlier this is represented by the actual space character
!
Exclamation mark key
"
Double quote key
#
Hash key
$
Dollar key
&
Ampersand key
'
Single quote key
(
Left parenthesis key
)
Right parenthesis key
*
Asterisk key
+
Plus key
,
Comma key
-
Hyphen-minus key
.
Full stop key
/
Slash key
:
Colon key
;
Semicolon key
<
Less-than key
=
Equal key
>
Greater-than key
?
Question mark key
@
At sign key
[
Left square bracket key
\
Backslash key
]
Right square bracket key
^
Caret key
_
Underscore key
`
Grave accent key
Also known as the "Back tick" key
kp0
The numpad zero key
kp1
The numpad one key
kp2
The numpad two key
kp3
The numpad three key
kp4
The numpad four key
kp5
The numpad five key
kp6
The numpad six key
kp7
The numpad seven key
kp8
The numpad eight key
kp9
The numpad nine key
kp.
The numpad decimal point key
kp/
The numpad division key
kp*
The numpad multiplication key
kp-
The numpad substraction key
kp+
The numpad addition key
kpenter
The numpad enter key
kp=
The numpad equals key
up
Up cursor key
down
Down cursor key
right
Right cursor key
left
Left cursor key
home
Home key
end
End key
pageup
Page up key
pagedown
Page down key
insert
Insert key
backspace
Backspace key
tab
Tab key
clear
Clear key
return
Return key
Also known as the Enter key
delete
Delete key
f1
The 1st function key
f2
The 2nd function key
f3
The 3rd function key
f4
The 4th function key
f5
The 5th function key
f6
The 6th function key
f7
The 7th function key
f8
The 8th function key
f9
The 9th function key
f10
The 10th function key
f11
The 11th function key
f12
The 12th function key
f13
The 13th function key
f14
The 14th function key
f15
The 15th function key
numlock
Num-lock key
capslock
Caps-lock key
Caps-on is a key press. Caps-off is a key release.
scrollock
Scroll-lock key
rshift
Right shift key
lshift
Left shift key
rctrl
Right control key
lctrl
Left control key
ralt
Right alt key
lalt
Left alt key
rmeta
Right meta key
lmeta
Left meta key
lsuper
Left super key
rsuper
Right super key
mode
Mode key
compose
Compose key
pause
Pause key
escape
Escape key
help
Help key
Print key
sysreq
System request key
break
Break key
menu
Menu key
power
Power key
euro
Euro (€) key
undo
Undo key
www
WWW key
Mail key
calculator
Calculator key
appsearch
Application search key
apphome
Application home key
appback
Application back key
appforward
Application forward key
apprefresh
Application refresh key
appbookmarks
Application bookmarks key
a
The 'A' key on an American layout.
b
The 'B' key on an American layout.
c
The 'C' key on an American layout.
d
The 'D' key on an American layout.
e
The 'E' key on an American layout.
f
The 'F' key on an American layout.
g
The 'G' key on an American layout.
h
The 'H' key on an American layout.
i
The 'I' key on an American layout.
j
The 'J' key on an American layout.
k
The 'K' key on an American layout.
l
The 'L' key on an American layout.
m
The 'M' key on an American layout.
n
The 'N' key on an American layout.
o
The 'O' key on an American layout.
p
The 'P' key on an American layout.
q
The 'Q' key on an American layout.
r
The 'R' key on an American layout.
s
The 'S' key on an American layout.
t
The 'T' key on an American layout.
u
The 'U' key on an American layout.
v
The 'V' key on an American layout.
w
The 'W' key on an American layout.
x
The 'X' key on an American layout.
y
The 'Y' key on an American layout.
z
The 'Z' key on an American layout.
1
The '1' key on an American layout.
2
The '2' key on an American layout.
3
The '3' key on an American layout.
4
The '4' key on an American layout.
5
The '5' key on an American layout.
6
The '6' key on an American layout.
7
The '7' key on an American layout.
8
The '8' key on an American layout.
9
The '9' key on an American layout.
0
The '0' key on an American layout.
return
The 'return' / 'enter' key on an American layout.
escape
The 'escape' key on an American layout.
backspace
The 'backspace' key on an American layout.
tab
The 'tab' key on an American layout.
space
The spacebar on an American layout.
-
The minus key on an American layout.
=
The equals key on an American layout.
[
The left-bracket key on an American layout.
]
The right-bracket key on an American layout.
\
The backslash key on an American layout.
nonus#
The non-U.S. hash scancode.
;
The semicolon key on an American layout.
'
The apostrophe key on an American layout.
`
The back-tick / grave key on an American layout.
,
The comma key on an American layout.
.
The period key on an American layout.
/
The forward-slash key on an American layout.
capslock
The capslock key on an American layout.
f1
The F1 key on an American layout.
f2
The F2 key on an American layout.
f3
The F3 key on an American layout.
f4
The F4 key on an American layout.
f5
The F5 key on an American layout.
f6
The F6 key on an American layout.
f7
The F7 key on an American layout.
f8
The F8 key on an American layout.
f9
The F9 key on an American layout.
f10
The F10 key on an American layout.
f11
The F11 key on an American layout.
f12
The F12 key on an American layout.
f13
The F13 key on an American layout.
f14
The F14 key on an American layout.
f15
The F15 key on an American layout.
f16
The F16 key on an American layout.
f17
The F17 key on an American layout.
f18
The F18 key on an American layout.
f19
The F19 key on an American layout.
f20
The F20 key on an American layout.
f21
The F21 key on an American layout.
f22
The F22 key on an American layout.
f23
The F23 key on an American layout.
f24
The F24 key on an American layout.
lctrl
The left control key on an American layout.
lshift
The left shift key on an American layout.
lalt
The left alt / option key on an American layout.
lgui
The left GUI (command / windows / super) key on an American layout.
rctrl
The right control key on an American layout.
rshift
The right shift key on an American layout.
ralt
The right alt / option key on an American layout.
rgui
The right GUI (command / windows / super) key on an American layout.
printscreen
The printscreen key on an American layout.
scrolllock
The scroll-lock key on an American layout.
pause
The pause key on an American layout.
insert
The insert key on an American layout.
home
The home key on an American layout.
numlock
The numlock / clear key on an American layout.
pageup
The page-up key on an American layout.
delete
The forward-delete key on an American layout.
end
The end key on an American layout.
pagedown
The page-down key on an American layout.
right
The right-arrow key on an American layout.
left
The left-arrow key on an American layout.
down
The down-arrow key on an American layout.
up
The up-arrow key on an American layout.
nonusbackslash
The non-U.S. backslash scancode.
application
The application key on an American layout. Windows contextual menu, compose key.
execute
The 'execute' key on an American layout.
help
The 'help' key on an American layout.
menu
The 'menu' key on an American layout.
select
The 'select' key on an American layout.
stop
The 'stop' key on an American layout.
again
The 'again' key on an American layout.
undo
The 'undo' key on an American layout.
cut
The 'cut' key on an American layout.
copy
The 'copy' key on an American layout.
paste
The 'paste' key on an American layout.
find
The 'find' key on an American layout.
kp/
The keypad forward-slash key on an American layout.
kp*
The keypad '*' key on an American layout.
kp-
The keypad minus key on an American layout.
kp+
The keypad plus key on an American layout.
kp=
The keypad equals key on an American layout.
kpenter
The keypad enter key on an American layout.
kp1
The keypad '1' key on an American layout.
kp2
The keypad '2' key on an American layout.
kp3
The keypad '3' key on an American layout.
kp4
The keypad '4' key on an American layout.
kp5
The keypad '5' key on an American layout.
kp6
The keypad '6' key on an American layout.
kp7
The keypad '7' key on an American layout.
kp8
The keypad '8' key on an American layout.
kp9
The keypad '9' key on an American layout.
kp0
The keypad '0' key on an American layout.
kp.
The keypad period key on an American layout.
international1
The 1st international key on an American layout. Used on Asian keyboards.
international2
The 2nd international key on an American layout.
international3
The 3rd international key on an American layout. Yen.
international4
The 4th international key on an American layout.
international5
The 5th international key on an American layout.
international6
The 6th international key on an American layout.
international7
The 7th international key on an American layout.
international8
The 8th international key on an American layout.
international9
The 9th international key on an American layout.
lang1
Hangul/English toggle scancode.
lang2
Hanja conversion scancode.
lang3
Katakana scancode.
lang4
Hiragana scancode.
lang5
Zenkaku/Hankaku scancode.
mute
The mute key on an American layout.
volumeup
The volume up key on an American layout.
volumedown
The volume down key on an American layout.
audionext
The audio next track key on an American layout.
audioprev
The audio previous track key on an American layout.
audiostop
The audio stop key on an American layout.
audioplay
The audio play key on an American layout.
audiomute
The audio mute key on an American layout.
mediaselect
The media select key on an American layout.
www
The 'WWW' key on an American layout.
The Mail key on an American layout.
calculator
The calculator key on an American layout.
computer
The 'computer' key on an American layout.
acsearch
The AC Search key on an American layout.
achome
The AC Home key on an American layout.
acback
The AC Back key on an American layout.
acforward
The AC Forward key on an American layout.
acstop
Th AC Stop key on an American layout.
acrefresh
The AC Refresh key on an American layout.
acbookmarks
The AC Bookmarks key on an American layout.
power
The system power scancode.
brightnessdown
The brightness-down scancode.
brightnessup
The brightness-up scancode.
displayswitch
The display switch scancode.
kbdillumtoggle
The keyboard illumination toggle scancode.
kbdillumdown
The keyboard illumination down scancode.
kbdillumup
The keyboard illumination up scancode.
eject
The eject scancode.
sleep
The system sleep scancode.
alterase
The alt-erase key on an American layout.
sysreq
The sysreq key on an American layout.
cancel
The 'cancel' key on an American layout.
clear
The 'clear' key on an American layout.
prior
The 'prior' key on an American layout.
return2
The 'return2' key on an American layout.
separator
The 'separator' key on an American layout.
out
The 'out' key on an American layout.
oper
The 'oper' key on an American layout.
clearagain
The 'clearagain' key on an American layout.
crsel
The 'crsel' key on an American layout.
exsel
The 'exsel' key on an American layout.
kp00
The keypad 00 key on an American layout.
kp000
The keypad 000 key on an American layout.
thsousandsseparator
The thousands-separator key on an American layout.
decimalseparator
The decimal separator key on an American layout.
currencyunit
The currency unit key on an American layout.
currencysubunit
The currency sub-unit key on an American layout.
app1
The 'app1' scancode.
app2
The 'app2' scancode.
unknown
An unknown key.
Compresses a string or data using a specific compression algorithm.
compressedData = love.math.
| compressedData | CompressedData | A new Data object containing the compressed version of the string. |
| rawstring | string | The raw (un-compressed) string to compress. |
| format ("lz4") | CompressedDataFormat | The format to use when compressing the string. |
| level (-1) | number | The level of compression to use, between 0 and 9. -1 indicates the default level. The meaning of this argument depends on the compression format being used. |
compressedData = love.math.
| compressedData | CompressedData | A new Data object containing the compressed version of the raw data. |
| data | Data | A Data object containing the raw (un-compressed) data to compress. |
| format ("lz4") | CompressedDataFormat | The format to use when compressing the data. |
| level (-1) | number | The level of compression to use, between 0 and 9. -1 indicates the default level. The meaning of this argument depends on the compression format being used. |
Decompresses a CompressedData or previously compressed string or Data object.
rawstring = love.math.
| rawstring | string | A string containing the raw decompressed data. |
| compressedData | CompressedData | The compressed data to decompress. |
rawstring = love.math.
| rawstring | string | A string containing the raw decompressed data. |
| compressedString | string | A string containing data previously compressed with love.math.compress. |
| format | CompressedDataFormat | The format that was used to compress the given string. |
rawstring = love.math.
| rawstring | string | A string containing the raw decompressed data. |
| data | Data | A Data object containing data previously compressed with love.math.compress. |
| format | CompressedDataFormat | The format that was used to compress the given data. |
Converts a color from gamma-space (sRGB) to linear-space (RGB). This is useful when doing gamma-correct rendering and you need to do math in linear RGB in the few cases where LÖVE doesn't handle conversions automatically.
lr, lg, lb = love.math.
| lr | number | The red channel of the converted color in linear RGB space. |
| lg | number | The green channel of the converted color in linear RGB space. |
| lb | number | The blue channel of the converted color in linear RGB space. |
| r | number | The red channel of the sRGB color to convert. |
| g | number | The green channel of the sRGB color to convert. |
| b | number | The blue channel of the sRGB color to convert. |
lr, lg, lb = love.math.
| lr | number | The red channel of the converted color in linear RGB space. |
| lg | number | The green channel of the converted color in linear RGB space. |
| lb | number | The blue channel of the converted color in linear RGB space. |
| color | table | An array with the red, green, and blue channels of the sRGB color to convert. |
lc = love.math.
| lc | number | The value of the color channel in linear RGB space. |
| c | number | The value of a color channel in sRGB space to convert. |
Gets the seed of the random number generator.
The state is split into two numbers due to Lua's use of doubles for all number values - doubles can't accurately represent integer values above 2^53.
low, high = love.math.
| low | number | Integer number representing the lower 32 bits of the random number generator's 64 bit state value. |
| high | number | Integer number representing the higher 32 bits of the random number generator's 64 bit state value. |
Gets the current state of the random number generator. This returns an opaque implementation-dependent string which is only useful for later use with RandomGenerator:setState.
This is different from RandomGenerator:getSeed in that getState gets the RandomGenerator's current state, whereas getSeed gets the previously set seed number.
The value of the state string does not depend on the current operating system.
state = love.math.
| state | string | The current state of the RandomGenerator object, represented as a string. |
Checks whether a polygon is convex.
PolygonShapes in love.physics, some forms of Mesh, and polygons drawn with love.graphics.polygon must be simple convex polygons.
convex = love.math.
| convex | boolean | Whether the given polygon is convex. |
| vertices | table | The vertices of the polygon as a table in the form of {x1, y1, x2, y2, x3, y3, ...}. |
convex = love.math.
| convex | boolean | Whether the given polygon is convex. |
| x1 | number | The position of the first vertex of the polygon on the x-axis. |
| y1 | number | The position of the first vertex of the polygon on the y-axis. |
| x2 | number | The position of the second vertex of the polygon on the x-axis. |
| y2 | number | The position of the second vertex of the polygon on the y-axis. |
| x3 | number | The position of the third vertex of the polygon on the x-axis. |
| y3 | number | The position of the third vertex of the polygon on the y-axis. |
| ... | number | Additional vertices. |
Converts a color from linear-space (RGB) to gamma-space (sRGB). This is useful when storing linear RGB color values in an image, because the linear RGB color space has less precision than sRGB for dark colors, which can result in noticeable color banding when drawing.
In general, colors chosen based on what they look like on-screen are already in gamma-space and should not be double-converted. Colors calculated using math are often in the linear RGB space.
cr, cg, cb = love.math.
| cr | number | The red channel of the converted color in gamma sRGB space. |
| cg | number | The green channel of the converted color in gamma sRGB space. |
| cb | number | The blue channel of the converted color in gamma sRGB space. |
| lr | number | The red channel of the linear RGB color to convert. |
| lg | number | The green channel of the linear RGB color to convert. |
| lb | number | The blue channel of the linear RGB color to convert. |
cr, cg, cb = love.math.
| cr | number | The red channel of the converted color in gamma sRGB space. |
| cg | number | The green channel of the converted color in gamma sRGB space. |
| cb | number | The blue channel of the converted color in gamma sRGB space. |
| color | table | An array with the red, green, and blue channels of the linear RGB color to convert. |
c = love.math.
| c | number | The value of the color channel in gamma sRGB space. |
| lc | number | The value of a color channel in linear RGB space to convert. |
Creates a new BezierCurve object.
The number of vertices in the control polygon determines the degree of the curve, e.g. three vertices define a quadratic (degree 2) Bézier curve, four vertices define a cubic (degree 3) Bézier curve, etc.
curve = love.math.
| curve | BezierCurve | A Bézier curve object. |
| vertices | table | The vertices of the control polygon as a table in the form of {x1, y1, x2, y2, x3, y3, ...}. |
curve = love.math.
| curve | BezierCurve | A Bézier curve object. |
| x1 | number | The position of the first vertex of the control polygon on the x-axis. |
| y1 | number | The position of the first vertex of the control polygon on the y-axis. |
| x2 | number | The position of the second vertex of the control polygon on the x-axis. |
| y2 | number | The position of the second vertex of the control polygon on the y-axis. |
| x3 | number | The position of the third vertex of the control polygon on the x-axis. |
| y3 | number | The position of the third vertex of the control polygon on the y-axis. |
| ... | number | Additional vertices. |
Creates a new RandomGenerator object which is completely independent of other RandomGenerator objects and random functions.
rng = love.math.
| rng | RandomGenerator | The new Random Number Generator object. |
rng = love.math.
| rng | RandomGenerator | The new Random Number Generator object. |
| seed | number | The initial seed number to use for this object. |
rng = love.math.
| rng | RandomGenerator | The new Random Number Generator object. |
| low | number | The lower 32 bits of the state number to use for this instance of the object. |
| high | number | The higher 32 bits of the state number to use for this instance of the object. |
Generates a Simplex or Perlin noise value in 1-4 dimensions. The return value will always be the same, given the same arguments.
Simplex noise is closely related to Perlin noise. It is widely used for procedural content generation.
There are many webpages which discuss Perlin and Simplex noise in detail.
value = love.math.
Generates Simplex noise from 1 dimension.
| value | number | The noise value in the range of [0, 1]. |
| x | number | The number used to generate the noise value. |
value = love.math.
Generates Simplex noise from 2 dimensions.
| value | number | The noise value in the range of [0, 1]. |
| x | number | The first value of the 2-dimensional vector used to generate the noise value. |
| y | number | The second value of the 2-dimensional vector used to generate the noise value. |
value = love.math.
Generates Perlin noise (Simplex noise in version 0.9.2 and older) from 3 dimensions.
| value | number | The noise value in the range of [0, 1]. |
| x | number | The first value of the 3-dimensional vector used to generate the noise value. |
| y | number | The second value of the 3-dimensional vector used to generate the noise value. |
| z | number | The third value of the 3-dimensional vector used to generate the noise value. |
value = love.math.
Generates Perlin noise (Simplex noise in version 0.9.2 and older) from 4 dimensions.
| value | number | The noise value in the range of [0, 1]. |
| x | number | The first value of the 4-dimensional vector used to generate the noise value. |
| y | number | The second value of the 4-dimensional vector used to generate the noise value. |
| z | number | The third value of the 4-dimensional vector used to generate the noise value. |
| w | number | The fourth value of the 4-dimensional vector used to generate the noise value. |
Generates a pseudo-random number in a platform independent manner.
number = love.math.
Get uniformly distributed pseudo-random real number within [0, 1].
| number | number | The pseudo-random number. |
number = love.math.
Get a uniformly distributed pseudo-random integer within [1, max].
| number | number | The pseudo-random integer number. |
| max | number | The maximum possible value it should return. |
number = love.math.
Get uniformly distributed pseudo-random integer within [min, max].
| number | number | The pseudo-random integer number. |
| min | number | The minimum possible value it should return. |
| max | number | The maximum possible value it should return. |
Get a normally distributed pseudo random number.
number = love.math.
| number | number | Normally distributed random number with variance (stddev)² and the specified mean. |
| stddev (1) | number | Standard deviation of the distribution. |
| mean (0) | number | The mean of the distribution. |
Sets the seed of the random number generator using the specified integer number.
love.math.
| seed | number | The integer number with which you want to seed the randomization. Must be within the range of [1, 2^53]. |
love.math.
| low | number | The lower 32 bits of the state value. Must be within the range of [0, 2^32 - 1]. |
| high | number | The higher 32 bits of the state value. Must be within the range of [0, 2^32 - 1]. |
Gets the current state of the random number generator. This returns an opaque implementation-dependent string which is only useful for later use with RandomGenerator:setState.
This is different from RandomGenerator:getSeed in that getState gets the RandomGenerator's current state, whereas getSeed gets the previously set seed number.
The value of the state string does not depend on the current operating system.
love.math.
| state | string | The current state of the RandomGenerator object, represented as a string. |
Triangulate a simple polygon.
triangles = love.math.
| triangles | table | List of triangles the polygon is composed of, in the form of {{x1, y1, x2, y2, x3, y3}, {x1, y1, x2, y2, x3, y3}, ...}. |
| polygon | table | Polygon to triangulate. Must not intersect itself. |
triangles = love.math.
| triangles | table | List of triangles the polygon is composed of, in the form of {{x1, y1, x2, y2, x3, y3}, {x1, y1, x2, y2, x3, y3}, ...}. |
| x1 | number | The position of the first vertex of the polygon on the x-axis. |
| y1 | number | The position of the first vertex of the polygon on the y-axis. |
| x2 | number | The position of the second vertex of the polygon on the x-axis. |
| y2 | number | The position of the second vertex of the polygon on the y-axis. |
| x3 | number | The position of the third vertex of the polygon on the x-axis. |
| y3 | number | The position of the third vertex of the polygon on the y-axis. |
| ... | number | Additional vertices. |
lz4
The LZ4 compression format. Compresses and decompresses very quickly, but the compression ratio is not the best. LZ4-HC is used when compression level 9 is specified.
zlib
The zlib format is DEFLATE-compressed data with a small bit of header data. Compresses relatively slowly and decompresses moderately quickly, and has a decent compression ratio.
gzip
The gzip format is DEFLATE-compressed data with a slightly larger header than zlib. Since it uses DEFLATE it has the same compression characteristics as the zlib format.
A Bézier curve object that can evaluate and render Bézier curves of arbitrary degree.
Evaluate Bézier curve at parameter t. The parameter must be between 0 and 1 (inclusive).
This function can be used to move objects along paths or tween parameters. However it should not be used to render the curve, see BezierCurve:render for that purpose.
x, y = BezierCurve:
| x | number | x coordinate of the curve at parameter t. |
| y | number | y coordinate of the curve at parameter t. |
| t | number | Where to evaluate the curve. |
Get coordinates of the i-th control point. Indices start with 1.
x, y = BezierCurve:
| x | number | Position of the control point along the x axis. |
| y | number | Position of the control point along the y axis. |
| i | number | Index of the control point. |
BezierCurve:
Get the number of control points in the Bézier curve.
count = BezierCurve:
| count | number | The number of control points. |
Get degree of the Bézier curve. The degree is equal to number-of-control-points - 1.
degree = BezierCurve:
| degree | number | Degree of the Bézier curve. |
Get the derivative of the Bézier curve.
This function can be used to rotate sprites moving along a curve in the direction of the movement and compute the direction perpendicular to the curve at some parameter t.
derivative = BezierCurve:
| derivative | BezierCurve | The derivative curve. |
Gets a BezierCurve that corresponds to the specified segment of this BezierCurve.
curve = BezierCurve:
| curve | BezierCurve | A BezierCurve that corresponds to the specified segment. |
| startpoint | number | The starting point along the curve. Must be between 0 and 1. |
| endpoint | number | The end of the segment. Must be between 0 and 1. |
BezierCurve:
Insert control point as the new i-th control point. Existing control points from i onwards are pushed back by 1. Indices start with 1. Negative indices wrap around: -1 is the last control point, -2 the one before the last, etc.
BezierCurve:
| x | number | Position of the control point along the x axis. |
| y | number | Position of the control point along the y axis. |
| i (-1) | number | Index of the control point. |
BezierCurve:
Removes the specified control point.
BezierCurve:
| index | number | The index of the control point to remove. |
Get a list of coordinates to be used with love.graphics.line.
This function samples the Bézier curve using recursive subdivision. You can control the recursion depth using the depth parameter.
If you are just interested to know the position on the curve given a parameter, use BezierCurve:evaluate.
coordinates = BezierCurve:
| coordinates | table | List of x,y-coordinate pairs of points on the curve. |
| depth (5) | number | Number of recursive subdivision steps. |
Get a list of coordinates on a specific part of the curve, to be used with love.graphics.line.
This function samples the Bézier curve using recursive subdivision. You can control the recursion depth using the depth parameter.
If you are just need to know the position on the curve given a parameter, use BezierCurve:evaluate.
coordinates = BezierCurve:
| coordinates | table | List of x,y-coordinate pairs of points on the curve. |
| startpoint | number | The starting point along the curve. Must be between 0 and 1. |
| endpoint | number | The end of the segment to render. Must be between 0 and 1. |
| depth (5) | number | Number of recursive subdivision steps. |
Rotate the Bézier curve by an angle.
BezierCurve:
| angle | number | Rotation angle in radians. |
| ox (0) | number | X coordinate of the rotation center. |
| oy (0) | number | Y coordinate of the rotation center. |
Scale the Bézier curve by a factor.
BezierCurve:
| s | number | Scale factor. |
| ox (0) | number | X coordinate of the scaling center. |
| oy (0) | number | Y coordinate of the scaling center. |
Set coordinates of the i-th control point. Indices start with 1.
BezierCurve:
| i | number | Index of the control point. |
| ox | number | Position of the control point along the x axis. |
| oy | number | Position of the control point along the y axis. |
Move the Bézier curve by an offset.
BezierCurve:
| dx | number | Offset along the x axis. |
| dy | number | Offset along the y axis. |
Represents byte data compressed using a specific algorithm.
love.math.decompress can be used to de-compress the data.
Gets the compression format of the CompressedData.
format = CompressedData:
| format | CompressedDataFormat | The format of the CompressedData. |
A random number generation object which has its own random state.
Gets the state of the random number generator.
The state is split into two numbers due to Lua's use of doubles for all number values - doubles can't accurately represent integer values above 2^53.
low, high = RandomGenerator:
| low | number | Integer number representing the lower 32 bits of the random number generator's 64 bit state value. |
| high | number | Integer number representing the higher 32 bits of the random number generator's 64 bit state value. |
Gets the current state of the random number generator. This returns an opaque implementation-dependent string which is only useful for later use with RandomGenerator:setState.
This is different from RandomGenerator:getSeed in that getState gets the RandomGenerator's current state, whereas getSeed gets the previously set seed number.
The value of the state string does not depend on the current operating system.
state = RandomGenerator:
| state | string | The current state of the RandomGenerator object, represented as a string. |
Generates a pseudo-random number in a platform independent manner.
number = RandomGenerator:
Get uniformly distributed pseudo-random number within [0, 1].
| number | number | The pseudo random number. |
number = RandomGenerator:
Get uniformly distributed pseudo-random integer number within [1, max].
| number | number | The pseudo-random integer number. |
| max | number | The maximum possible value it should return. |
number = RandomGenerator:
Get uniformly distributed pseudo-random integer number within [min, max].
| number | number | The pseudo-random integer number. |
| min | number | The minimum possible value it should return. |
| max | number | The maximum possible value it should return. |
Get a normally distributed pseudo random number.
number = RandomGenerator:
| number | number | Normally distributed random number with variance (stddev)² and the specified mean. |
| stddev (1) | number | Standard deviation of the distribution. |
| mean (0) | number | The mean of the distribution. |
Sets the seed of the random number generator using the specified integer number.
RandomGenerator:
| seed | number | The integer number with which you want to seed the randomization. Must be within the range of [1, 2^53]. |
RandomGenerator:
| low | number | The lower 32 bits of the state value. Must be within the range of [0, 2^32 - 1]. |
| high (0) | number | The higher 32 bits of the state value. Must be within the range of [0, 2^32 - 1]. |
Sets the current state of the random number generator. The value used as an argument for this function is an opaque implementation-dependent string and should only originate from a previous call to RandomGenerator:getState.
This is different from RandomGenerator:setSeed in that setState directly sets the RandomGenerator's current implementation-dependent state, whereas setSeed gives it a new seed value.
The effect of the state string does not depend on the current operating system.
RandomGenerator:
| state | string | The new state of the RandomGenerator object, represented as a string. This should originate from a previous call to RandomGenerator:getState. |
Gets the current Cursor.
cursor = love.mouse.
| cursor | Cursor | The current cursor, or nil if no cursor is set. |
Gets the current position of the mouse.
x, y = love.mouse.
| x | number | The position of the mouse along the x-axis. |
| y | number | The position of the mouse along the y-axis. |
Gets whether relative mode is enabled for the mouse.
If relative mode is enabled, the cursor is hidden and doesn't move when the mouse does, but relative mouse motion events are still generated via love.mousemoved. This lets the mouse move in any direction indefinitely without the cursor getting stuck at the edges of the screen.
The reported position of the mouse is not updated while relative mode is enabled, even when relative mouse motion events are generated.
enabled = love.mouse.
| enabled | boolean | True if relative mode is enabled, false if it's disabled. |
Gets a Cursor object representing a system-native hardware cursor.
Hardware cursors are framerate-independent and work the same way as normal operating system cursors. Unlike drawing an image at the mouse's current coordinates, hardware cursors never have visible lag between when the mouse is moved and when the cursor position updates, even at low framerates.
cursor = love.mouse.
| cursor | Cursor | The Cursor object representing the system cursor type. |
| ctype | CursorType | The type of system cursor to get. |
Gets the current x position of the mouse.
x = love.mouse.
| x | number | The position of the mouse along the x-axis. |
Gets the current y position of the mouse.
y = love.mouse.
| y | number | The position of the mouse along the y-axis. |
Gets whether cursor functionality is supported.
If it isn't supported, calling love.mouse.newCursor and love.mouse.getSystemCursor will cause an error. Mobile devices do not support cursors.
hascursor = love.mouse.
| hascursor | boolean | Whether the system has cursor functionality. |
Checks whether a certain mouse button is down. This function does not detect mousewheel scrolling; you must use the love.wheelmoved (or love.mousepressed in version 0.9.2 and older) callback for that.
down = love.mouse.
| down | boolean | True if the specified button is down. |
| button | number | The index of a button to check. 1 is the primary mouse button, 2 is the secondary mouse button, etc. |
| ... | number | Additional button numbers to check. |
Checks if the mouse is grabbed.
grabbed = love.mouse.
| grabbed | boolean | True if the cursor is grabbed, false if it is not. |
Checks if the cursor is visible.
visible = love.mouse.
| visible | boolean | True if the cursor to visible, false if the cursor is hidden. |
Creates a new hardware Cursor object from an image file or ImageData.
Hardware cursors are framerate-independent and work the same way as normal operating system cursors. Unlike drawing an image at the mouse's current coordinates, hardware cursors never have visible lag between when the mouse is moved and when the cursor position updates, even at low framerates.
The hot spot is the point the operating system uses to determine what was clicked and at what position the mouse cursor is. For example, the normal arrow pointer normally has its hot spot at the top left of the image, but a crosshair cursor might have it in the middle.
cursor = love.mouse.
| cursor | Cursor | The new Cursor object. |
| imageData | ImageData | The ImageData to use for the the new Cursor. |
| hotx (0) | number | The x-coordinate in the ImageData of the cursor's hot spot. |
| hoty (0) | number | The y-coordinate in the ImageData of the cursor's hot spot. |
cursor = love.mouse.
| cursor | Cursor | The new Cursor object. |
| filepath | string | Path to the image to use for the new Cursor. |
| hotx (0) | number | The x-coordinate in the ImageData of the cursor's hot spot. |
| hoty (0) | number | The y-coordinate in the ImageData of the cursor's hot spot. |
cursor = love.mouse.
| cursor | Cursor | The new Cursor object. |
| fileData | FileData | Data representing the image to use for the new Cursor. |
| hotx (0) | number | The x-coordinate in the ImageData of the cursor's hot spot. |
| hoty (0) | number | The y-coordinate in the ImageData of the cursor's hot spot. |
Sets the current mouse cursor.
Resets the current mouse cursor to the default when called without arguments.
love.mouse.
love.mouse.
| cursor | Cursor | The Cursor object to use as the current mouse cursor. |
Grabs the mouse and confines it to the window.
love.mouse.
| grab | boolean | True to confine the mouse, false to let it leave the window. |
Sets the current position of the mouse. Non-integer values are floored.
love.mouse.
| x | number | The new position of the mouse along the x-axis. |
| y | number | The new position of the mouse along the y-axis. |
Sets whether relative mode is enabled for the mouse.
When relative mode is enabled, the cursor is hidden and doesn't move when the mouse does, but relative mouse motion events are still generated via love.mousemoved. This lets the mouse move in any direction indefinitely without the cursor getting stuck at the edges of the screen.
The reported position of the mouse is not updated while relative mode is enabled, even when relative mouse motion events are generated.
love.mouse.
| enable | boolean | True to enable relative mode, false to disable it. |
Sets the visibility of the cursor.
love.mouse.
| visible | boolean | True to set the cursor to visible, false to hide the cursor. |
Sets the current X position of the mouse. Non-integer values are floored.
love.mouse.
| x | number | The new position of the mouse along the x-axis. |
Sets the current Y position of the mouse. Non-integer values are floored.
love.mouse.
| y | number | The new position of the mouse along the y-axis. |
image
The cursor is using a custom image.
arrow
An arrow pointer.
ibeam
An I-beam, normally used when mousing over editable or selectable text.
wait
Wait graphic.
waitarrow
Small wait cursor with an arrow pointer.
crosshair
Crosshair symbol.
sizenwse
Double arrow pointing to the top-left and bottom-right.
sizenesw
Double arrow pointing to the top-right and bottom-left.
sizewe
Double arrow pointing left and right.
sizens
Double arrow pointing up and down.
sizeall
Four-pointed arrow pointing up, down, left, and right.
no
Slashed circle or crossbones.
hand
Hand symbol.
Represents a hardware cursor.
Gets the type of the Cursor.
cursortype = Cursor:
| cursortype | CursorType | The type of the Cursor. |
Gets the two closest points between two fixtures and their distance.
distance, x1, y1, x2, y2 = love.physics.
| distance | number | The distance of the two points. |
| x1 | number | The x-coordinate of the first point. |
| y1 | number | The y-coordinate of the first point. |
| x2 | number | The x-coordinate of the second point. |
| y2 | number | The y-coordinate of the second point. |
| fixture1 | Fixture | The first fixture. |
| fixture2 | Fixture | The second fixture. |
Get the scale of the world.
The world scale is the number of pixels per meter. Try to keep your shape sizes less than 10 times this scale.
This is important because the physics in Box2D is tuned to work well for objects of size 0.1m up to 10m. All physics coordinates are divided by this number for the physics calculations.
scale = love.physics.
| scale | number | The size of 1 meter in pixels. |
Creates a new body.
There are three types of bodies. Static bodies do not move, have a infinite mass, and can be used for level boundaries. Dynamic bodies are the main actors in the simulation, they collide with everything. Kinematic bodies do not react to forces and only collide with dynamic bodies.
The mass of the body gets calculated when a Fixture is attached or removed, but can be changed at any time with Body:setMass or Body:resetMassData.
body = love.physics.
| body | Body | A new body. |
| world | World | The world to create the body in. |
| x (0) | number | The x position of the body. |
| y (0) | number | The y position of the body. |
| type ("static") | BodyType | The type of the body. |
Creates a new ChainShape.
shape = love.physics.
| shape | ChainShape | The new shape. |
| loop | boolean | If the chain should loop back to the first point. |
| x1 | number | The x position of the first point. |
| y1 | number | The y position of the first point. |
| x2 | number | The x position of the second point. |
| y2 | number | The y position of the second point. |
| ... | number | Additional point positions. |
shape = love.physics.
| shape | ChainShape | The new shape. |
| loop | boolean | If the chain should loop back to the first point. |
| points | table | A list of points to construct the ChainShape, in the form of {x1, y1, x2, y2, ...}. |
Creates a new CircleShape.
shape = love.physics.
| shape | CircleShape | The new shape. |
| radius | number | The radius of the circle. |
shape = love.physics.
| shape | CircleShape | The new shape. |
| x | number | The x offset of the circle. |
| y | number | The y offset of the circle. |
| radius | number | The radius of the circle. |
Create a distance joint between two bodies.
This joint constrains the distance between two points on two bodies to be constant. These two points are specified in world coordinates and the two bodies are assumed to be in place when this joint is created. The first anchor point is connected to the first body and the second to the second body, and the points define the length of the distance joint.
joint = love.physics.
| joint | DistanceJoint | The new distance joint. |
| body1 | Body | The first body to attach to the joint. |
| body2 | Body | The second body to attach to the joint. |
| x1 | number | The x position of the first anchor point (world space). |
| y1 | number | The y position of the first anchor point (world space). |
| x2 | number | The x position of the second anchor point (world space). |
| y2 | number | The y position of the second anchor point (world space). |
| collideConnected (false) | boolean | Specifies whether the two bodies should collide with each other. |
Creates a edge shape.
shape = love.physics.
| shape | EdgeShape | The new shape. |
| x1 | number | The x position of the first point. |
| y1 | number | The y position of the first point. |
| x2 | number | The x position of the second point. |
| y2 | number | The y position of the second point. |
Creates and attaches a Fixture to a body.
fixture = love.physics.
| fixture | Fixture | The new fixture. |
| body | Body | The body which gets the fixture attached. |
| shape | Shape | The shape of the fixture. |
| density (1) | number | The density of the fixture. |
Create a friction joint between two bodies. A FrictionJoint applies friction to a body.
joint = love.physics.
| joint | FrictionJoint | The new FrictionJoint. |
| body1 | Body | The first body to attach to the joint. |
| body2 | Body | The second body to attach to the joint. |
| x | number | The x position of the anchor point. |
| y | number | The y position of the anchor point. |
| collideConnected (false) | boolean | Specifies whether the two bodies should collide with eachother. |
Create a gear joint connecting two joints.
The gear joint connects two joints that must be either prismatic or revolute joints. Using this joint requires that the joints it uses connect their respective bodies to the ground and have the ground as the first body. When destroying the bodies and joints you must make sure you destroy the gear joint before the other joints.
The gear joint has a ratio the determines how the angular or distance values of the connected joints relate to each other. The formula coordinate1 + ratio * coordinate2 always has a constant value that is set when the gear joint is created.
joint = love.physics.
| joint | GearJoint | The new gear joint. |
| joint1 | Joint | The first joint to connect with a gear joint. |
| joint2 | Joint | The second joint to connect with a gear joint. |
| ratio (1) | number | The gear ratio. |
| collideConnected (false) | boolean | Specifies whether the two bodies should collide with each other. |
Creates a joint between two bodies which controls the relative motion between them.
Position and rotation offsets can be specified once the MotorJoint has been created, as well as the maximum motor force and torque that will be be applied to reach the target offsets.
joint = love.physics.
| joint | MotorJoint | The new MotorJoint. |
| body1 | Body | The first body to attach to the joint. |
| body2 | Body | The second body to attach to the joint. |
| correctionFactor (0.3) | number | The joint's initial position correction factor, in the range of [0, 1]. |
| collideConnected (false) | boolean | Specifies whether the two bodies should collide with each other. |
Create a joint between a body and the mouse.
This joint actually connects the body to a fixed point in the world. To make it follow the mouse, the fixed point must be updated every timestep (example below).
The advantage of using a MouseJoint instead of just changing a body position directly is that collisions and reactions to other joints are handled by the physics engine.
joint = love.physics.
| joint | MouseJoint | The new mouse joint. |
| body | Body | The body to attach to the mouse. |
| x | number | The x position of the connecting point. |
| y | number | The y position of the connecting point. |
Creates a new PolygonShape.
This shape can have 8 vertices at most, and must form a convex shape.
shape = love.physics.
| shape | PolygonShape | A new PolygonShape. |
| x1 | number | The position of first point on the x-axis. |
| y1 | number | The position of first point on the y-axis. |
| x2 | number | The position of second point on the x-axis. |
| y2 | number | The position of second point on the y-axis. |
| ... | number | You can continue passing more point positions to create the PolygonShape. |
shape = love.physics.
| shape | PolygonShape | A new PolygonShape. |
| vertices | table | A list of vertices to construct the polygon, in the form of {x1, y1, x2, y2, x3, y3, ...}. |
love.physics.
Create a prismatic joints between two bodies.
A prismatic joint constrains two bodies to move relatively to each other on a specified axis. It does not allow for relative rotation. Its definition and operation are similar to a revolute joint, but with translation and force substituted for angle and torque.
joint = love.physics.
| joint | PrismaticJoint | The new prismatic joint. |
| body1 | Body | The first body to connect with a prismatic joint. |
| body2 | Body | The second body to connect with a prismatic joint. |
| x1 | number | The x coordinate of the first anchor point. |
| y1 | number | The y coordinate of the first anchor point. |
| x2 | number | The x coordinate of the second anchor point. |
| y2 | number | The y coordinate of the second anchor point. |
| ax | number | The x coordinate of the axis unit vector. |
| ay | number | The y coordinate of the axis unit vector. |
| collideConnected (false) | boolean | Specifies whether the two bodies should collide with each other. |
| referenceAngle (0) | number | The reference angle between body1 and body2, in radians. |
Create a pulley joint to join two bodies to each other and the ground.
The pulley joint simulates a pulley with an optional block and tackle. If the ratio parameter has a value different from one, then the simulated rope extends faster on one side than the other. In a pulley joint the total length of the simulated rope is the constant length1 + ratio * length2, which is set when the pulley joint is created.
Pulley joints can behave unpredictably if one side is fully extended. It is recommended that the method setMaxLengths be used to constrain the maximum lengths each side can attain.
joint = love.physics.
| joint | PulleyJoint | The new pulley joint. |
| body1 | Body | The first body to connect with a pulley joint. |
| body2 | Body | The second body to connect with a pulley joint. |
| gx1 | number | The x coordinate of the first body's ground anchor. |
| gy1 | number | The y coordinate of the first body's ground anchor. |
| gx2 | number | The x coordinate of the second body's ground anchor. |
| gy2 | number | The y coordinate of the second body's ground anchor. |
| x1 | number | The x coordinate of the pulley joint anchor in the first body. |
| y1 | number | The y coordinate of the pulley joint anchor in the first body. |
| x2 | number | The x coordinate of the pulley joint anchor in the second body. |
| y2 | number | The y coordinate of the pulley joint anchor in the second body. |
| ratio (1) | number | The joint ratio. |
| collideConnected (true) | boolean | Specifies whether the two bodies should collide with each other. |
love.physics.
Shorthand for creating rectangular PolygonShapes.
By default, the local origin is located at the center of the rectangle as opposed to the top left for graphics.
shape = love.physics.
| shape | PolygonShape | A new PolygonShape. |
| width | number | The width of the rectangle. |
| height | number | The height of the rectangle. |
shape = love.physics.
| shape | PolygonShape | A new PolygonShape. |
| x | number | The offset along the x-axis. |
| y | number | The offset along the y-axis. |
| width | number | The width of the rectangle. |
| height | number | The height of the rectangle. |
| angle (0) | number | The initial angle of the rectangle. |
Creates a pivot joint between two bodies.
This joint connects two bodies to a point around which they can pivot.
joint = love.physics.
| joint | RevoluteJoint | The new revolute joint. |
| body1 | Body | The first body. |
| body2 | Body | The second body. |
| x | number | The x position of the connecting point. |
| y | number | The y position of the connecting point. |
| collideConnected (false) | boolean | Specifies whether the two bodies should collide with each other. |
joint = love.physics.
| joint | RevoluteJoint | The new revolute joint. |
| body1 | Body | The first body. |
| body2 | Body | The second body. |
| x1 | number | The x position of the first connecting point. |
| y1 | number | The y position of the first connecting point. |
| x2 | number | The x position of the second connecting point. |
| y2 | number | The y position of the second connecting point. |
| collideConnected (false) | boolean | Specifies whether the two bodies should collide with each other. |
| referenceAngle (0) | number | Specifies whether the two bodies should collide with each other. |
Create a joint between two bodies. Its only function is enforcing a max distance between these bodies.
joint = love.physics.
| joint | RopeJoint | The new RopeJoint. |
| body1 | Body | The first body to attach to the joint. |
| body2 | Body | The second body to attach to the joint. |
| x1 | number | The x position of the first anchor point. |
| y1 | number | The y position of the first anchor point. |
| x2 | number | The x position of the second anchor point. |
| y2 | number | The y position of the second anchor point. |
| maxLength | number | The maximum distance for the bodies. |
| collideConnected (false) | boolean | Specifies whether the two bodies should collide with each other. |
Creates a constraint joint between two bodies. A WeldJoint essentially glues two bodies together. The constraint is a bit soft, however, due to Box2D's iterative solver.
joint = love.physics.
| joint | WeldJoint | The new WeldJoint. |
| body1 | Body | The first body to attach to the joint. |
| body2 | Body | The second body to attach to the joint. |
| x1 | number | The x position of the first anchor point (world space). |
| y1 | number | The y position of the first anchor point (world space). |
| x2 | number | The x position of the second anchor point (world space). |
| y2 | number | The y position of the second anchor point (world space). |
| collideConnected (false) | boolean | Specifies whether the two bodies should collide with each other. |
| referenceAngle (0) | number | The reference angle between body1 and body2, in radians. |
Creates a wheel joint.
joint = love.physics.
| joint | WheelJoint | The new WheelJoint. |
| body1 | Body | The first body. |
| body2 | Body | The second body. |
| x | number | The x position of the anchor point. |
| y | number | The y position of the anchor point. |
| ax | number | The x position of the axis unit vector. |
| ay | number | The y position of the axis unit vector. |
| collideConnected (false) | boolean | Specifies whether the two bodies should collide with each other. |
Creates a new World.
world = love.physics.
| world | World | A brave new World. |
| xg (0) | number | The x component of gravity. |
| yg (0) | number | The y component of gravity. |
| sleep (true) | boolean | Whether the bodies in this world are allowed to sleep. |
Sets the pixels to meter scale factor.
All coordinates in the physics module are divided by this number and converted to meters, and it creates a convenient way to draw the objects directly to the screen without the need for graphics transformations.
It is recommended to create shapes no larger than 10 times the scale. This is important because Box2D is tuned to work well with shape sizes from 0.1 to 10 meters. The default meter scale is 30.
love.physics.setMeter does not apply retroactively to created objects. Created objects retain their meter coordinates but the scale factor will affect their pixel coordinates.
love.physics.
| scale | number | The scale factor as an integer. |
static
Static bodies do not move.
dynamic
Dynamic bodies collide with all bodies.
kinematic
Kinematic bodies only collide with dynamic bodies.
distance
A DistanceJoint.
gear
A GearJoint.
mouse
A MouseJoint.
prismatic
A PrismaticJoint.
pulley
A PulleyJoint.
revolute
A RevoluteJoint.
friction
A FrictionJoint.
weld
A WeldJoint.
rope
A RopeJoint.
circle
The Shape is a CircleShape.
polygon
The Shape is a PolygonShape.
edge
chain
The Shape is a ChainShape.
Bodies are objects with velocity and position.
Applies an angular impulse to a body. This makes a single, instantaneous addition to the body momentum.
A body with with a larger mass will react less. The reaction does not depend on the timestep, and is equivalent to applying a force continuously for 1 second. Impulses are best used to give a single push to a body. For a continuous push to a body it is better to use Body:applyForce.
Body:
| impulse | number | The impulse in kilogram-square meter per second. |
Apply force to a Body.
A force pushes a body in a direction. A body with with a larger mass will react less. The reaction also depends on how long a force is applied: since the force acts continuously over the entire timestep, a short timestep will only push the body for a short time. Thus forces are best used for many timesteps to give a continuous push to a body (like gravity). For a single push that is independent of timestep, it is better to use Body:applyLinearImpulse.
If the position to apply the force is not given, it will act on the center of mass of the body. The part of the force not directed towards the center of mass will cause the body to spin (and depends on the rotational inertia).
Note that the force components and position must be given in world coordinates.
Body:
| fx | number | The x component of force to apply to the center of mass. |
| fy | number | The y component of force to apply to the center of mass. |
Body:
| fx | number | The x component of force to apply. |
| fy | number | The y component of force to apply. |
| x | number | The x position to apply the force. |
| y | number | The y position to apply the force. |
Applies an impulse to a body. This makes a single, instantaneous addition to the body momentum.
An impulse pushes a body in a direction. A body with with a larger mass will react less. The reaction does not depend on the timestep, and is equivalent to applying a force continuously for 1 second. Impulses are best used to give a single push to a body. For a continuous push to a body it is better to use Body:applyForce.
If the position to apply the impulse is not given, it will act on the center of mass of the body. The part of the impulse not directed towards the center of mass will cause the body to spin (and depends on the rotational inertia).
Note that the impulse components and position must be given in world coordinates.
Body:
| ix | number | The x component of the impulse applied to the center of mass. |
| iy | number | The y component of the impulse applied to the center of mass. |
Body:
| ix | number | The x component of the impulse. |
| iy | number | The y component of the impulse. |
| x | number | The x position to apply the impulse. |
| y | number | The y position to apply the impulse. |
Apply torque to a body.
Torque is like a force that will change the angular velocity (spin) of a body. The effect will depend on the rotational inertia a body has.
Body:
| torque | number | The torque to apply. |
Explicitly destroys the Body. When you don't have time to wait for garbage collection, this function may be used to free the object immediately, but note that an error will occur if you attempt to use the object after calling this function.
Body:
Get the angle of the body.
The angle is measured in radians. If you need to transform it to degrees, use math.deg.
A value of 0 radians will mean "looking to the right". Although radians increase counter-clockwise, the y-axis points down so it becomes clockwise from our point of view.
angle = Body:
| angle | number | The angle in radians. |
Gets the Angular damping of the Body
The angular damping is the rate of decrease of the angular velocity over time: A spinning body with no damping and no external forces will continue spinning indefinitely. A spinning body with damping will gradually stop spinning.
Damping is not the same as friction - they can be modelled together. However, only damping is provided by Box2D (and LÖVE).
Damping parameters should be between 0 and infinity, with 0 meaning no damping, and infinity meaning full damping. Normally you will use a damping value between 0 and 0.1.
damping = Body:
| damping | number | The value of the angular damping. |
Get the angular velocity of the Body.
The angular velocity is the rate of change of angle over time.
It is changed in World:update by applying torques, off centre forces/impulses, and angular damping. It can be set directly with Body:setAngularVelocity.
If you need the rate of change of position over time, use Body:getLinearVelocity.
w = Body:
| w | number | The angular velocity in radians/second. |
Gets a list of all Contacts attached to the Body.
contacts = Body:
| contacts | table | A list with all contacts associated with the Body. |
Gets a table with all fixtures.
fixtures = Body:
| fixtures | table | A sequence with all fixtures. |
Gets the gravity scale factor.
scale = Body:
| scale | number | The gravity scale factor. |
Gets the rotational inertia of the body.
The rotational inertia is how hard is it to make the body spin.
inertia = Body:
| inertia | number | The rotational inertial of the body. |
Gets a table containing the Joints attached to this Body.
joints = Body:
| joints | table | A sequence with the Joints attached to the Body. |
Gets the linear damping of the Body.
The linear damping is the rate of decrease of the linear velocity over time. A moving body with no damping and no external forces will continue moving indefinitely, as is the case in space. A moving body with damping will gradually stop moving.
Damping is not the same as friction - they can be modelled together. However, only damping is provided by Box2D (and LÖVE).
damping = Body:
| damping | number | The value of the linear damping. |
Gets the linear velocity of the Body from its center of mass.
The linear velocity is the rate of change of position over time.
If you need the rate of change of angle over time, use Body:getAngularVelocity. If you need to get the linear velocity of a point different from the center of mass:
Body:getLinearVelocityFromLocalPoint allows you to specify the point in local coordinates.
Body:getLinearVelocityFromWorldPoint allows you to specify the point in world coordinates.
x, y = Body:
| x | number | The x component of the velocity vector. |
| y | number | The y component of the velocity vector. |
Body:
Get the linear velocity of a point on the body.
The linear velocity for a point on the body is the velocity of the body center of mass plus the velocity at that point from the body spinning.
The point on the body must given in local coordinates. Use Body:getLinearVelocityFromWorldPoint to specify this with world coordinates.
vx, vy = Body:
| vx | number | The x component of velocity at point (x,y). |
| vy | number | The y component of velocity at point (x,y). |
| x | number | The x position to measure velocity. |
| y | number | The y position to measure velocity. |
Body:
Get the linear velocity of a point on the body.
The linear velocity for a point on the body is the velocity of the body center of mass plus the velocity at that point from the body spinning.
The point on the body must given in world coordinates. Use Body:getLinearVelocityFromLocalPoint to specify this with local coordinates.
vx, vy = Body:
| vx | number | The x component of velocity at point (x,y). |
| vy | number | The y component of velocity at point (x,y). |
| x | number | The x position to measure velocity. |
| y | number | The y position to measure velocity. |
Get the center of mass position in local coordinates.
Use Body:getWorldCenter to get the center of mass in world coordinates.
x, y = Body:
| x | number | The x coordinate of the center of mass. |
| y | number | The y coordinate of the center of mass. |
Transform a point from world coordinates to local coordinates.
localX, localY = Body:
| localX | number | The x position in local coordinates. |
| localY | number | The y position in local coordinates. |
| worldX | number | The x position in world coordinates. |
| worldY | number | The y position in world coordinates. |
Transform a vector from world coordinates to local coordinates.
localX, localY = Body:
| localX | number | The vector x component in local coordinates. |
| localY | number | The vector y component in local coordinates. |
| worldX | number | The vector x component in world coordinates. |
| worldY | number | The vector y component in world coordinates. |
Get the mass of the body.
mass = Body:
| mass | number | The mass of the body (in kilograms). |
Gets the mass, its center, and the rotational inertia.
x, y, mass, inertia = Body:
| x | number | The x position of the center of mass. |
| y | number | The y position of the center of mass. |
| mass | number | The mass of the body. |
| inertia | number | The rotational inertia. |
Get the position of the body.
Note that this may not be the center of mass of the body.
x, y = Body:
| x | number | The x position. |
| y | number | The y position. |
Gets the Lua value associated with this Body.
value = Body:
| value | any | The Lua value associated with the Body. |
Get the center of mass position in world coordinates.
Use Body:getLocalCenter to get the center of mass in local coordinates.
x, y = Body:
| x | number | The x coordinate of the center of mass. |
| y | number | The y coordinate of the center of mass. |
Transform a point from local coordinates to world coordinates.
worldX, worldY = Body:
| worldX | number | The x position in world coordinates. |
| worldY | number | The y position in world coordinates. |
| localX | number | The x position in local coordinates. |
| localY | number | The y position in local coordinates. |
Transforms multiple points from local coordinates to world coordinates.
x1, y1, x2, y2, ... = Body:
| x1 | number | The transformed x position of the first point. |
| y1 | number | The transformed y position of the first point. |
| x2 | number | The transformed x position of the second point. |
| y2 | number | The transformed y position of the second point. |
| ... | number | The transformed x and y positions of additional points. |
| x1 | number | The x position of the first point. |
| y1 | number | The y position of the first point. |
| x2 | number | The x position of the second point. |
| y2 | number | The y position of the second point. |
| ... | number | More x and y points. |
Transform a vector from local coordinates to world coordinates.
worldX, worldY = Body:
| worldX | number | The vector x component in world coordinates. |
| worldY | number | The vector y component in world coordinates. |
| localX | number | The vector x component in local coordinates. |
| localY | number | The vector y component in local coordinates. |
Get the x position of the body in world coordinates.
x = Body:
| x | number | The x position in world coordinates. |
Get the y position of the body in world coordinates.
y = Body:
| y | number | The y position in world coordinates. |
Gets whether the body is actively used in the simulation.
status = Body:
| status | boolean | True if the body is active or false if not. |
Gets the sleep status of the body.
status = Body:
| status | boolean | True if the body is awake or false if not. |
Get the bullet status of a body.
There are two methods to check for body collisions:
at their location when the world is updated (default)
using continuous collision detection (CCD)
The default method is efficient, but a body moving very quickly may sometimes jump over another body without producing a collision. A body that is set as a bullet will use CCD. This is less efficient, but is guaranteed not to jump when moving quickly.
Note that static bodies (with zero mass) always use CCD, so your walls will not let a fast moving body pass through even if it is not a bullet.
status = Body:
| status | boolean | The bullet status of the body. |
Gets whether the Body is destroyed. Destroyed bodies cannot be used.
destroyed = Body:
| destroyed | boolean | Whether the Body is destroyed. |
Gets whether the body rotation is locked.
fixed = Body:
| fixed | boolean | True if the body's rotation is locked or false if not. |
Gets the sleeping behaviour of the body.
status = Body:
| status | boolean | True if the body is allowed to sleep or false if not. |
Resets the mass of the body by recalculating it from the mass properties of the fixtures.
Body:
Sets whether the body is active in the world.
An inactive body does not take part in the simulation. It will not move or cause any collisions.
Body:
| active | boolean | If the body is active or not. |
Set the angle of the body.
The angle is measured in radians. If you need to transform it from degrees, use math.rad.
A value of 0 radians will mean "looking to the right". Although radians increase counter-clockwise, the y-axis points down so it becomes clockwise from our point of view.
It is possible to cause a collision with another body by changing its angle.
Body:
| angle | number | The angle in radians. |
Sets the angular damping of a Body.
See Body:getAngularDamping for a definition of angular damping.
Angular damping can take any value from 0 to infinity. It is recommended to stay between 0 and 0.1, though. Other values will look unrealistic.
Body:
| damping | number | The new angular damping. |
Sets the angular velocity of a Body.
The angular velocity is the rate of change of angle over time.
This function will not accumulate anything; any impulses previously applied since the last call to World:update will be lost.
Body:
| w | number | The new angular velocity, in radians per second |
Wakes the body up or puts it to sleep.
Body:
| awake | boolean | The body sleep status. |
Set the bullet status of a body.
There are two methods to check for body collisions:
at their location when the world is updated (default)
using continuous collision detection (CCD)
The default method is efficient, but a body moving very quickly may sometimes jump over another body without producing a collision. A body that is set as a bullet will use CCD. This is less efficient, but is guaranteed not to jump when moving quickly.
Note that static bodies (with zero mass) always use CCD, so your walls will not let a fast moving body pass through even if it is not a bullet.
Body:
| status | boolean | The bullet status of the body. |
Set whether a body has fixed rotation.
Bodies with fixed rotation don't vary the speed at which they rotate.
Body:
| fixed | boolean | Whether the body should have fixed rotation. |
Sets a new gravity scale factor for the body.
Body:
| scale | number | The new gravity scale factor. |
Set the inertia of a body.
Body:
| inertia | number | The new moment of inertia, in kilograms per meter squared. |
Sets the linear damping of a Body
See Body:getLinearDamping for a definition of linear damping.
Linear damping can take any value from 0 to infinity. It is recommended to stay between 0 and 0.1, though. Other values will make the objects look "floaty".
Body:
| ld | number | The new linear damping. |
Sets a new linear velocity for the Body.
This function will not accumulate anything; any impulses previously applied since the last call to World:update will be lost.
Body:
| x | number | The x component of the velocity vector. |
| y | number | The y component of the velocity vector. |
Overrides the calculated mass data.
Body:
| x | number | The x component of the center of mass in local coordinates. |
| y | number | The y component of the center of mass in local coordinates. |
| mass | number | The mass, in kilograms. |
| inertia | number | The rotational inertia, in kilograms per squared meter. |
Set the position of the body.
Note that this may not be the center of mass of the body.
Body:
| x | number | The x position. |
| y | number | The y position. |
Sets the sleeping behaviour of the body.
Body:
| allowed | boolean | True if the body is allowed to sleep or false if not. |
Associates a Lua value with the Body.
To delete the reference, explicitly pass nil.
Body:
| value | any | The Lua value to associate with the Body. |
A ChainShape consists of multiple line segments. It can be used to create the boundaries of your terrain. The shape does not have volume and can only collide with PolygonShape and CircleShape.
Unlike the PolygonShape, the ChainShape does not have a vertices limit or has to form a convex shape, but self intersections are not supported.
Gets a child of the shape as an EdgeShape.
EdgeShape = ChainShape:
| EdgeShape | number | The child as an EdgeShape. |
| index | number | The index of the child. |
Gets the vertex that establishes a connection to the next shape.
Setting next and previous ChainShape vertices can help prevent unwanted collisions when a flat shape slides along the edge and moves over to the new shape.
ChainShape:
| x (nil) | number | The x-component of the vertex, or nil if ChainShape:setNextVertex hasn't been called. |
| y (nil) | number | The y-component of the vertex, or nil if ChainShape:setNextVertex hasn't been called. |
Gets a point of the shape.
x, y = ChainShape:
| x | number | The x-coordinate of the point. |
| y | number | The y-coordinate of the point. |
| index | number | The index of the point to return. |
Gets all points of the shape.
x1, y1, x2, y2, ... = ChainShape:
| x1 | number | The x-coordinate of the first point. |
| y1 | number | The y-coordinate of the first point. |
| x2 | number | The x-coordinate of the second point. |
| y2 | number | The y-coordinate of the second point. |
| ... | number | Additional x and y values. |
Gets the vertex that establishes a connection to the previous shape.
Setting next and previous ChainShape vertices can help prevent unwanted collisions when a flat shape slides along the edge and moves over to the new shape.
x, y = ChainShape:
| x (nil) | number | The x-component of the vertex, or nil if ChainShape:setNextVertex hasn't been called. |
| y (nil) | number | The y-component of the vertex, or nil if ChainShape:setNextVertex hasn't been called. |
Gets the number of vertices the shape has.
count = ChainShape:
| count | number | The number of vertices. |
Sets a vertex that establishes a connection to the next shape.
This can help prevent unwanted collisions when a flat shape slides along the edge and moves over to the new shape.
ChainShape:
| x | number | The x component of the vertex. |
| y | number | The y component of the vertex. |
Sets a vertex that establishes a connection to the previous shape.
This can help prevent unwanted collisions when a flat shape slides along the edge and moves over to the new shape.
ChainShape:
| x | number | The x component of the vertex. |
| y | number | The y component of the vertex. |
Circle extends Shape and adds a radius and a local position.
Gets the center point of the circle shape.
x, y = CircleShape:
| x | number | The x-component of the center point of the circle. |
| y | number | The y-component of the center point of the circle. |
Gets the radius of the circle shape.
radius = CircleShape:
| radius | number | The radius of the circle. |
Sets the location of the center of the circle shape.
CircleShape:
| x | number | The x-component of the new center point of the circle. |
| y | number | The y-component of the new center point of the circle. |
Sets the radius of the circle.
CircleShape:
| radius | number | The radius of the circle. |
Contacts are objects created to manage collisions in worlds.
Gets the two Fixtures that hold the shapes that are in contact.
fixtureA, fixtureB = Contact:
| fixtureA | Fixture | The first Fixture. |
| fixtureB | Fixture | The second Fixture. |
Get the friction between two shapes that are in contact.
friction = Contact:
| friction | number | The friction of the contact. |
Get the normal vector between two shapes that are in contact.
This function returns the coordinates of a unit vector that points from the first shape to the second.
nx, ny = Contact:
| nx | number | The x component of the normal vector. |
| ny | number | The y component of the normal vector. |
Gets the contact points of the two colliding fixtures. There can be one or two points.
x1, y1, x2, y2 = Contact:
| x1 | number | The x coordinate of the first contact point. |
| y1 | number | The y coordinate of the first contact point. |
| x2 | number | The x coordinate of the second contact point. |
| y2 | number | The y coordinate of the second contact point. |
Get the restitution between two shapes that are in contact.
restitution = Contact:
| restitution | number | The restitution between the two shapes. |
Gets whether the contact is enabled. The collision will be ignored if a contact gets disabled in the preSolve callback.
enabled = Contact:
| enabled | boolean | True if enabled, false otherwise. |
Gets whether the two colliding fixtures are touching each other.
touching = Contact:
| touching | boolean | True if they touch or false if not. |
Resets the contact friction to the mixture value of both fixtures.
Contact:
Resets the contact restitution to the mixture value of both fixtures.
Contact:
Enables or disables the contact.
Contact:
| enabled | boolean | True to enable or false to disable. |
Sets the contact friction.
Contact:
| friction | number | The contact friction. |
Sets the contact restitution.
Contact:
| restitution | number | The contact restitution. |
A EdgeShape is a line segment. They can be used to create the boundaries of your terrain. The shape does not have volume and can only collide with PolygonShape and CircleShape.
Gets the local coordinates of the edge points.
x1, y1, x2, y2 = EdgeShape:
| x1 | number | The x component of the first vertex. |
| y1 | number | The y component of the first vertex. |
| x2 | number | The x component of the second vertex. |
| y2 | number | The y component of the second vertex. |
Gets the vertex that establishes a connection to the next shape.
Setting next and previous EdgeShape vertices can help prevent unwanted collisions when a flat shape slides along the edge and moves over to the new shape.
x, y = EdgeShape:
| x | number | The x-component of the vertex, or nil if EdgeShape:setNextVertex hasn't been called. |
| y | number | The y-component of the vertex, or nil if EdgeShape:setNextVertex hasn't been called. |
Gets the vertex that establishes a connection to the previous shape.
Setting next and previous EdgeShape vertices can help prevent unwanted collisions when a flat shape slides along the edge and moves over to the new shape.
x, y = EdgeShape:
| x | number | The x-component of the vertex, or nil if EdgeShape:setPreviousVertex hasn't been called. |
| y | number | The y-component of the vertex, or nil if EdgeShape:setPreviousVertex hasn't been called. |
Sets a vertex that establishes a connection to the next shape.
This can help prevent unwanted collisions when a flat shape slides along the edge and moves over to the new shape.
EdgeShape:
| x | number | The x-component of the vertex. |
| y | number | The y-component of the vertex. |
Sets a vertex that establishes a connection to the previous shape.
This can help prevent unwanted collisions when a flat shape slides along the edge and moves over to the new shape.
EdgeShape:
| x | number | The x-component of the vertex. |
| y | number | The y-component of the vertex. |
Keeps two bodies at the same distance.
Gets the damping ratio.
ratio = DistanceJoint:
| ratio | number | The damping ratio. |
Gets the response speed.
Hz = DistanceJoint:
| Hz | number | The response speed. |
Gets the equilibrium distance between the two Bodies.
l = DistanceJoint:
| l | number | The length between the two Bodies. |
Sets the damping ratio.
DistanceJoint:
| ratio | number | The damping ratio. |
Sets the response speed.
DistanceJoint:
| Hz | number | The response speed. |
Sets the equilibrium distance between the two Bodies.
DistanceJoint:
| l | number | The length between the two Bodies. |
Fixtures attach shapes to bodies.
Gets the points of the fixture bounding box. In case the fixture has multiple children a 1-based index can be specified. For example, a fixture will have multiple children with a chain shape.
topLeftX, topLeftY, bottomRightX, bottomRightY = Fixture:
| topLeftX | number | The x position of the top-left point. |
| topLeftY | number | The y position of the top-left point. |
| bottomRightX | number | The x position of the bottom-right point. |
| bottomRightY | number | The y position of the bottom-right point. |
| index (1) | number | A bounding box of the fixture. |
Gets the categories the fixture belongs to.
category1, category2, ... = Fixture:
| category1 | number | The first category. |
| category2 | number | The second category. |
| ... | number | Additional categories. |
Gets the density of the fixture.
density = Fixture:
| density | number | The fixture density in kilograms per square meter. |
Gets the filter data of the fixture. Categories and masks are encoded as the bits of a 16-bit integer.
categories, mask, group = Fixture:
| categories | number | The categories as an integer from 0 to 65535. |
| mask | number | The mask as an integer from 0 to 65535. |
| group | number | The group as an integer from -32768 to 32767. |
Gets the friction of the fixture.
friction = Fixture:
| friction | number | The fixture friction. |
Gets the group the fixture belongs to. Fixtures with the same group will always collide if the group is positive or never collide if it's negative. The group zero means no group.
The groups range from -32768 to 32767.
group = Fixture:
| group | number | The group of the fixture. |
Gets the category mask of the fixture.
mask1, mask2, ... = Fixture:
| mask1 | number | The first category selected by the mask. |
| mask2 | number | The second category selected by the mask. |
| ... | number | Additional categories selected by the mask. |
Gets the mass, its center and the rotational inertia.
x, y, mass, inertia = Fixture:
| x | number | The x position of the center of mass. |
| y | number | The y position of the center of mass. |
| mass | number | The mass of the fixture. |
| inertia | number | The rotational inertia. |
Gets the restitution of the fixture.
restitution = Fixture:
| restitution | number | The fixture restitution. |
Gets the shape of the fixture. This shape is a reference to the actual data used in the simulation. It's possible to change its values between timesteps.
Do not call any functions on this shape after the parent fixture has been destroyed. This shape will point to an invalid memory address and likely cause crashes if you interact further with it.
shape = Fixture:
| shape | Shape | The fixture's shape. |
Gets the Lua value associated with this fixture.
Use this function in one thread only.
value = Fixture:
| value | any | The Lua value associated with the fixture. |
Gets whether the Fixture is destroyed. Destroyed fixtures cannot be used.
destroyed = Fixture:
| destroyed | boolean | Whether the Fixture is destroyed. |
Gets whether the fixture is a sensor.
sensor = Fixture:
| sensor | boolean | If the fixture is a sensor. |
Casts a ray against the shape of the fixture and returns the surface normal vector and the line position where the ray hit. If the ray missed the shape, nil will be returned.
The ray starts on the first point of the input line and goes towards the second point of the line. The fourth argument is the maximum distance the ray is going to travel as a scale factor of the input line length.
The childIndex parameter is used to specify which child of a parent shape, such as a ChainShape, will be ray casted. For ChainShapes, the index of 1 is the first edge on the chain. Ray casting a parent shape will only test the child specified so if you want to test every shape of the parent, you must loop through all of its children.
The world position of the impact can be calculated by multiplying the line vector with the third return value and adding it to the line starting point.
hitx, hity = x1 + (x2 - x1) * fraction, y1 + (y2 - y1) * fraction
x, y, fraction = Fixture:
| x | number | The x position where the ray intersects with the shape. |
| y | number | The y position where the ray intersects with the shape. |
| fraction | number | The position on the input vector where the intersection happened as a number from 0 to 1. |
| x1 | number | The x position of the ray starting point. |
| y1 | number | The y position of the ray starting point. |
| x2 | number | The x position of the ray end point. |
| y1 | number | The y position of the ray end point. |
| maxFraction | number | The maximum distance the ray is going to travel as a number from 0 to 1. |
| childIndex (1) | number | The index of the child the ray gets cast against. |
Sets the categories the fixture belongs to. There can be up to 16 categories represented as a number from 1 to 16.
Fixture:
| category1 | number | The first category. |
| category2 | number | The second category. |
| ... | number | Additional categories. |
Sets the density of the fixture. Call Body:resetMassData if this needs to take effect immediately.
Fixture:
| density | number | The fixture density in kilograms per square meter. |
Sets the filter data of the fixture.
Groups, categories, and mask can be used to define the collision behaviour of the fixture.
If two fixtures are in the same group they either always collide if the group is positive, or never collide if it's negative. If the group is zero or they do not match, then the contact filter checks if the fixtures select a category of the other fixture with their masks. The fixtures do not collide if that's not the case. If they do have each other's categories selected, the return value of the custom contact filter will be used. They always collide if none was set.
There can be up to 16 categories. Categories and masks are encoded as the bits of a 16-bit integer.
Fixture:
| categories | number | The categories as an integer from 0 to 65535. |
| mask | number | The mask as an integer from 0 to 65535. |
| group | number | The group as an integer from -32768 to 32767. |
Sets the friction of the fixture.
Fixture:
| friction | number | The fixture friction. |
Sets the group the fixture belongs to. Fixtures with the same group will always collide if the group is positive or never collide if it's negative. The group zero means no group.
The groups range from -32768 to 32767.
Fixture:
| group | number | The group as an integer from -32768 to 32767. |
Sets the category mask of the fixture. There can be up to 16 categories represented as a number from 1 to 16.
This fixture will collide with the fixtures that are in the selected categories if the other fixture also has a category of this fixture selected.
Fixture:
| mask1 | number | The first category. |
| mask2 | number | The second category. |
| ... | number | Additional categories. |
Sets the restitution of the fixture.
Fixture:
| restitution | number | The fixture restitution. |
Sets whether the fixture should act as a sensor.
Sensor do not produce collisions responses, but the begin and end callbacks will still be called for this fixture.
Fixture:
| sensor | boolean | The sensor status. |
Associates a Lua value with the fixture.
Use this function in one thread only.
Fixture:
| value | any | The Lua value associated with the fixture. |
Checks if a point is inside the shape of the fixture.
isInside = Fixture:
| isInside | boolean | True if the point is inside or false if it is outside. |
| x | number | The x position of the point. |
| y | number | The y position of the point. |
A FrictionJoint applies friction to a body.
Gets the maximum friction force in Newtons.
force = FrictionJoint:
| force | number | Maximum force in Newtons. |
Gets the maximum friction torque in Newton-meters.
torque = FrictionJoint:
| torque | number | Maximum torque in Newton-meters. |
Sets the maximum friction force in Newtons.
FrictionJoint:
| maxForce | number | Max force in Newtons. |
Sets the maximum friction torque in Newton-meters.
FrictionJoint:
| torque | number | Maximum torque in Newton-meters. |
Keeps bodies together in such a way that they act like gears.
Get the Joints connected by this GearJoint.
joint1, joint2 = GearJoint:
| joint1 | Joint | The first connected Joint. |
| joint2 | Joint | The second connected Joint. |
Get the ratio of a gear joint.
ratio = GearJoint:
| ratio | number | The ratio of the joint. |
Set the ratio of a gear joint.
GearJoint:
| ratio | number | The new ratio of the joint. |
Attach multiple bodies together to interact in unique ways.
Explicitly destroys the Joint. When you don't have time to wait for garbage collection, this function may be used to free the object immediately, but note that an error will occur if you attempt to use the object after calling this function.
Joint:
Get the anchor points of the joint.
x1, y1, x2, y2 = Joint:
| x1 | number | The x component of the anchor on Body 1. |
| y1 | number | The y component of the anchor on Body 1. |
| x2 | number | The x component of the anchor on Body 2. |
| y2 | number | The y component of the anchor on Body 2. |
Gets the bodies that the Joint is attached to.
bodyA, bodyB = Joint:
| bodyA | Body | The first Body. |
| bodyB | Body | The second Body. |
Gets whether the connected Bodies collide.
c = Joint:
| c | boolean | True if they collide, false otherwise. |
Gets the reaction force on Body 2 at the joint anchor.
x, y = Joint:
| x | number | The x component of the force. |
| y | number | The y component of the force. |
Gets the reaction torque on the second body.
torque = Joint:
| torque | number | The reaction torque on the second body. |
| invdt | number | How long the force applies. Usually the inverse time step or 1/dt. |
Gets a string representing the type.
type = Joint:
| type | JointType | A string with the name of the Joint type. |
Gets the Lua value associated with this Joint.
value = Joint:
| value | any | The Lua value associated with the Joint. |
Gets whether the Joint is destroyed. Destroyed joints cannot be used.
destroyed = Joint:
| destroyed | boolean | Whether the Joint is destroyed. |
Associates a Lua value with the Joint.
To delete the reference, explicitly pass nil.
Joint:
| value | any | The Lua value to associate with the Joint. |
Controls the relative motion between two Bodies. Position and rotation offsets can be specified, as well as the maximum motor force and torque that will be applied to reach the target offsets.
Gets the target angular offset between the two Bodies the Joint is attached to.
angularoffset = MotorJoint:
| angularoffset | number | The target angular offset in radians: the second body's angle minus the first body's angle. |
Gets the target linear offset between the two Bodies the Joint is attached to.
x, y = MotorJoint:
| x | number | The x component of the target linear offset, relative to the first Body. |
| y | number | The y component of the target linear offset, relative to the first Body. |
Sets the target angluar offset between the two Bodies the Joint is attached to.
MotorJoint:
| angularoffset | number | The target angular offset in radians: the second body's angle minus the first body's angle. |
Sets the target linear offset between the two Bodies the Joint is attached to.
MotorJoint:
| x | number | The x component of the target linear offset, relative to the first Body. |
| y | number | The y component of the target linear offset, relative to the first Body. |
For controlling objects with the mouse.
Gets the damping ratio.
ratio = MouseJoint:
| ratio | number | The new damping ratio. |
Gets the frequency.
freq = MouseJoint:
| freq | number | The frequency in hertz. |
Gets the highest allowed force.
f = MouseJoint:
| f | number | The max allowed force. |
Gets the target point.
x, y = MouseJoint:
| x | number | The x component of the target. |
| y | number | The x component of the target. |
Sets a new damping ratio.
MouseJoint:
| ratio | number | The new damping ratio. |
Sets a new frequency.
MouseJoint:
| freq | number | The new frequency in hertz. |
Sets the highest allowed force.
MouseJoint:
| f | number | The max allowed force. |
Sets the target point.
MouseJoint:
| x | number | The x component of the target. |
| y | number | The y component of the target. |
Polygon is a convex polygon with up to 8 sides.
Get the local coordinates of the polygon's vertices.
This function has a variable number of return values. It can be used in a nested fashion with love.graphics.polygon.
This function may have up to 16 return values, since it returns two values for each vertex in the polygon. In other words, it can return the coordinates of up to 8 points.
x1, y1, x2, y2, ... = PolygonShape:
| x1 | number | The x component of the first vertex. |
| y1 | number | The y component of the first vertex. |
| x2 | number | The x component of the second vertex. |
| y2 | number | The y component of the second vertex. |
| ... | number | Additional x and y values. |
Restricts relative motion between Bodies to one shared axis.
Gets the world-space axis vector of the Prismatic Joint.
x, y = PrismaticJoint:
| x | number | The x-axis coordinate of the world-space axis vector. |
| y | number | The y-axis coordinate of the world-space axis vector. |
Get the current joint angle speed.
s = PrismaticJoint:
| s | number | Joint angle speed in meters/second. |
PrismaticJoint:
Get the current joint translation.
t = PrismaticJoint:
| t | number | Joint translation, usually in meters. |
Gets the joint limits.
lower, upper = PrismaticJoint:
| lower | number | The lower limit, usually in meters. |
| upper | number | The upper limit, usually in meters. |
Gets the lower limit.
lower = PrismaticJoint:
| lower | number | The lower limit, usually in meters. |
PrismaticJoint:
Gets the maximum motor force.
f = PrismaticJoint:
| f | number | The maximum motor force, usually in N. |
Get the current motor force.
f = PrismaticJoint:
| f | number | The current motor force, usually in N. |
Gets the motor speed.
s = PrismaticJoint:
| s | number | The motor speed, usually in meters per second. |
Gets the upper limit.
upper = PrismaticJoint:
| upper | number | The upper limit, usually in meters. |
PrismaticJoint:
Checks whether the limits are enabled.
enabled = PrismaticJoint:
| enabled | boolean | True if enabled, false otherwise. |
Checks whether the motor is enabled.
enabled = PrismaticJoint:
| enabled | boolean | True if enabled, false if disabled. |
Sets the limits.
PrismaticJoint:
| lower | number | The lower limit, usually in meters. |
| upper | number | The upper limit, usually in meters. |
PrismaticJoint:
Enables or disables the limits of the joint.
PrismaticJoint:
| enable | boolean | True to enable, false to disable. |
Sets the lower limit.
PrismaticJoint:
| lower | number | The lower limit, usually in meters. |
PrismaticJoint:
Set the maximum motor force.
PrismaticJoint:
| f | number | The maximum motor force, usually in N. |
PrismaticJoint:
Starts or stops the joint motor.
PrismaticJoint:
| enable | boolean | True to enable, false to disable. |
Sets the motor speed.
PrismaticJoint:
| s | number | The motor speed, usually in meters per second. |
Sets the upper limit.
PrismaticJoint:
| upper | number | The upper limit, usually in meters. |
Allows you to simulate bodies connected through pulleys.
Get the total length of the rope.
length = PulleyJoint:
| length | number | The length of the rope in the joint. |
Get the ground anchor positions in world coordinates.
a1x, a1y, a2x, a2y = PulleyJoint:
| a1x | number | The x coordinate of the first anchor. |
| a1y | number | The y coordinate of the first anchor. |
| a2x | number | The x coordinate of the second anchor. |
| a2y | number | The y coordinate of the second anchor. |
Get the current length of the rope segment attached to the first body.
length = PulleyJoint:
| length | number | The length of the rope segment. |
Get the current length of the rope segment attached to the second body.
length = PulleyJoint:
| length | number | The length of the rope segment. |
Get the maximum lengths of the rope segments.
len1, len2 = PulleyJoint:
| len1 | number | The maximum length of the first rope segment. |
| len2 | number | The maximum length of the second rope segment. |
Get the pulley ratio.
ratio = PulleyJoint:
| ratio | number | The pulley ratio of the joint. |
Set the total length of the rope.
Setting a new length for the rope updates the maximum length values of the joint.
PulleyJoint:
| length | number | The new length of the rope in the joint. |
Set the maximum lengths of the rope segments.
The physics module also imposes maximum values for the rope segments. If the parameters exceed these values, the maximum values are set instead of the requested values.
PulleyJoint:
| max1 | number | The new maximum length of the first segment. |
| max2 | number | The new maximum length of the second segment. |
Set the pulley ratio.
PulleyJoint:
| ratio | number | The new pulley ratio of the joint. |
Allow two Bodies to revolve around a shared point.
RevoluteJoint:
Enables or disables the joint limits.
RevoluteJoint:
| enable | boolean | True to enable, false to disable. |
Starts or stops the joint motor.
RevoluteJoint:
| enable | boolean | True to enable, false to disable. |
Get the current joint angle.
angle = RevoluteJoint:
| angle | number | The joint angle in radians. |
Get the current joint angle speed.
s = RevoluteJoint:
| s | number | Joint angle speed in radians/second. |
Gets the joint limits.
lower, upper = RevoluteJoint:
| lower | number | The lower limit, in radians. |
| upper | number | The upper limit, in radians. |
Gets the lower limit.
lower = RevoluteJoint:
| lower | number | The lower limit, in radians. |
RevoluteJoint:
Gets the maximum motor force.
f = RevoluteJoint:
| f | number | The maximum motor force, in Nm. |
Gets the motor speed.
s = RevoluteJoint:
| s | number | The motor speed, radians per second. |
Get the current motor force.
f = RevoluteJoint:
| f | number | The current motor force, in Nm. |
Gets the upper limit.
upper = RevoluteJoint:
| upper | number | The upper limit, in radians. |
RevoluteJoint:
Checks whether limits are enabled.
enabled = RevoluteJoint:
| enabled | boolean | True if enabled, false otherwise. |
Checks whether the motor is enabled.
enabled = RevoluteJoint:
| enabled | boolean | True if enabled, false if disabled. |
Sets the limits.
RevoluteJoint:
| lower | number | The lower limit, in radians. |
| upper | number | The upper limit, in radians. |
Sets the lower limit.
RevoluteJoint:
| lower | number | The lower limit, in radians. |
RevoluteJoint:
Set the maximum motor force.
RevoluteJoint:
| f | number | The maximum motor force, in Nm. |
Sets the motor speed.
RevoluteJoint:
| s | number | The motor speed, radians per second. |
Sets the upper limit.
RevoluteJoint:
| upper | number | The upper limit, in radians. |
The RopeJoint enforces a maximum distance between two points on two bodies. It has no other effect.
Gets the maximum length of a RopeJoint.
maxLength = RopeJoint:
| maxLength | number | The maximum length of the RopeJoint. |
Shapes are solid 2d geometrical objects used in love.physics.
Shapes are attached to a Body via a Fixture. The Shape object is copied when this happens. Shape position is relative to Body position.
Gets the points of the bounding box for the transformed shape.
topLeftX, topLeftY, bottomRightX, bottomRightY = Shape:
| topLeftX | number | The x position of the top-left point. |
| topLeftY | number | The y position of the top-left point. |
| bottomRightX | number | The x position of the bottom-right point. |
| bottomRightY | number | The y position of the bottom-right point. |
| tx | number | The translation of the shape on the x-axis. |
| ty | number | The translation of the shape on the y-axis. |
| tr | number | The shape rotation. |
| childIndex (1) | number | The index of the child to compute the bounding box of. |
Computes the mass properties for the shape with the specified density.
x, y, mass, inertia = Shape:
| x | number | The x postition of the center of mass. |
| y | number | The y postition of the center of mass. |
| mass | number | The mass of the shape. |
| inertia | number | The rotational inertia. |
| density | number | The shape density. |
Gets the number of children the shape has.
count = Shape:
| count | number | The number of children. |
Gets the radius of the shape.
radius = Shape:
| radius | number | The radius of the shape. |
Gets a string representing the Shape. This function can be useful for conditional debug drawing.
type = Shape:
| type | ShapeType | The type of the Shape. |
Casts a ray against the shape and returns the surface normal vector and the line position where the ray hit. If the ray missed the shape, nil will be returned. The Shape can be transformed to get it into the desired position.
The ray starts on the first point of the input line and goes towards the second point of the line. The fourth argument is the maximum distance the ray is going to travel as a scale factor of the input line length.
The childIndex parameter is used to specify which child of a parent shape, such as a ChainShape, will be ray casted. For ChainShapes, the index of 1 is the first edge on the chain. Ray casting a parent shape will only test the child specified so if you want to test every shape of the parent, you must loop through all of its children.
The world position of the impact can be calculated by multiplying the line vector with the third return value and adding it to the line starting point.
hitx, hity = x1 + (x2 - x1) * fraction, y1 + (y2 - y1) * fraction
xn, yn, fraction = Shape:
| xn | number | The x component of the normal vector of the edge where the ray hit the shape. |
| yn | number | The y component of the normal vector of the edge where the ray hit the shape. |
| fraction | number | The position on the input line where the intersection happened as a factor of the line length. |
| x1 | number | The x position of the input line starting point. |
| y1 | number | The y position of the input line starting point. |
| x2 | number | The x position of the input line end point. |
| y2 | number | The y position of the input line end point. |
| maxFraction | number | Ray length parameter. |
| tx | number | The translation of the shape on the x-axis. |
| ty | number | The translation of the shape on the y-axis. |
| tr | number | The shape rotation. |
| childIndex (1) | number | The index of the child the ray gets cast against. |
Checks whether a point lies inside the shape. This is particularly useful for mouse interaction with the shapes. By looping through all shapes and testing the mouse position with this function, we can find which shapes the mouse touches.
hit = Shape:
| hit | boolean | True if inside, false if outside |
| x | number | The x component of the point. |
| y | number | The y component of the point. |
A WeldJoint essentially glues two bodies together.
Gets the damping ratio of the joint.
ratio = WeldJoint:
| ratio | number | The damping ratio. |
Gets the frequency.
freq = WeldJoint:
| freq | number | The frequency in hertz. |
The new damping ratio.
WeldJoint:
| ratio | number | The new damping ratio. |
Sets a new frequency.
WeldJoint:
| freq | number | The new frequency in hertz. |
Restricts a point on the second body to a line on the first body.
Gets the world-space axis vector of the Wheel Joint.
x, y = WheelJoint:
| x | number | The x-axis coordinate of the world-space axis vector. |
| y | number | The y-axis coordinate of the world-space axis vector. |
Gets the current joint translation speed.
speed = WheelJoint:
| speed | number | The translation speed of the joint in meters per second. |
WheelJoint:
Gets the current joint translation.
position = WheelJoint:
| position | number | The translation of the joint in meters. |
Gets the maximum motor torque.
maxTorque = WheelJoint:
| maxTorque | number | The maximum torque of the joint motor in newton meters. |
Gets the speed of the motor.
speed = WheelJoint:
| speed | number | The speed of the joint motor in radians per second. |
Gets the current torque on the motor.
torque = WheelJoint:
| torque | number | The torque on the motor in newton meters. |
| invdt | number | How long the force applies. Usually the inverse time step or 1/dt. |
WheelJoint:
Gets the damping ratio.
ratio = WheelJoint:
| ratio | number | The damping ratio. |
Gets the spring frequency.
freq = WheelJoint:
| freq | number | The frequency in hertz. |
Sets a new maximum motor torque.
WheelJoint:
| maxTorque | number | The new maximum torque for the joint motor in newton meters. |
Starts and stops the joint motor.
WheelJoint:
| enable | boolean | True turns the motor on and false turns it off. |
Sets a new speed for the motor.
WheelJoint:
| speed | number | The new speed for the joint motor in radians per second. |
WheelJoint:
Sets a new damping ratio.
WheelJoint:
| ratio | number | The new damping ratio. |
Sets a new spring frequency.
WheelJoint:
| freq | number | The new frequency in hertz. |
A world is an object that contains all bodies and joints.
Destroys the world, taking all bodies, joints, fixtures and their shapes with it.
An error will occur if you attempt to use any of the destroyed objects after calling this function.
World:
Get the number of bodies in the world.
n = World:
| n | number | The number of bodies in the world. |
Gets a table with all bodies.
bodies = World:
| bodies | table | A sequence with all bodies. |
Gets functions for the callbacks during the world update.
beginContact, endContact, preSolve, postSolve = World:
| beginContact | function | Gets called when two fixtures begin to overlap. |
| endContact | function | Gets called when two fixtures cease to overlap. |
| preSolve | function | Gets called before a collision gets resolved. |
| postSolve | function | Gets called after the collision has been resolved. |
Gets the number of contacts in the world.
n = World:
| n | number | The number of contacts in the world. |
Gets the function for collision filtering.
contactFilter = World:
| contactFilter | function | The function that handles the contact filtering. |
Gets a table with all contacts.
contacts = World:
| contacts | table | A sequence with all contacts. |
Get the gravity of the world.
x, y = World:
| x | number | The x component of gravity. |
| y | number | The y component of gravity. |
Get the number of joints in the world.
n = World:
| n | number | The number of joints in the world. |
Gets a table with all joints.
joints = World:
| joints | table | A sequence with all joints. |
Gets whether the World is destroyed. Destroyed worlds cannot be used.
destroyed = World:
| destroyed | boolean | Whether the World is destroyed. |
Gets if the world is updating its state.
This will return true inside the callbacks from World:setCallbacks.
locked = World:
| locked | boolean | Will be true if the world is in the process of updating its state. |
Gets the sleep behaviour of the world.
allowSleep = World:
| allowSleep | boolean | True if the bodies are allowed to sleep or false if not. |
Calls a function for each fixture inside the specified area.
World:
| topLeftX | number | The x position of the top-left point. |
| topLeftY | number | The y position of the top-left point. |
| bottomRightX | number | The x position of the bottom-right point. |
| bottomRightY | number | The y position of the bottom-right point. |
| callback | function | This function gets passed one argument, the fixture, and should return a boolean. The search will continue if it is true or stop if it is false. |
Casts a ray and calls a function for each fixtures it intersects.
World:
| x1 | number | The x position of the starting point of the ray. |
| y1 | number | The y position of the starting point of the ray. |
| x2 | number | The x position of the end point of the ray. |
| y2 | number | The y position of the end point of the ray. |
| callback | function | This function gets six arguments and should return a number. |
Sets functions for the collision callbacks during the world update.
Four Lua functions can be given as arguments. The value nil removes a function.
When called, each function will be passed three arguments. The first two arguments are the colliding fixtures and the third argument is the Contact between them. The PostSolve callback additionally gets the normal and tangent impulse for each contact point.
World:
| beginContact | function | Gets called when two fixtures begin to overlap. |
| endContact | function | Gets called when two fixtures cease to overlap. |
| preSolve | function | Gets called before a collision gets resolved. |
| postSolve | function | Gets called after the collision has been resolved. |
Sets a function for collision filtering.
If the group and category filtering doesn't generate a collision decision, this function gets called with the two fixtures as arguments. The function should return a boolean value where true means the fixtures will collide and false means they will pass through each other.
World:
| filter | function | The function handling the contact filtering. |
Set the gravity of the world.
World:
| x | number | The x component of gravity. |
| y | number | The y component of gravity. |
Set the sleep behaviour of the world.
A sleeping body is much more efficient to simulate than when awake.
If sleeping is allowed, any body that has come to rest will sleep.
World:
| allowSleep | boolean | True if the bodies are allowed to sleep or false if not. |
Translates the World's origin. Useful in large worlds where floating point precision issues become noticeable at far distances from the origin.
World:
| x | number | The x component of the new origin with respect to the old origin. |
| y | number | The y component of the new origin with respect to the old origin. |
Update the state of the world.
World:
| dt | number | The time (in seconds) to advance the physics simulation. |
Creates new SoundData from a file. It's also possible to create SoundData with a custom sample rate, channel and bit depth.
The sound data will be decoded to the memory in a raw format. It is recommended to create only short sounds like effects, as a 3 minute song uses 30 MB of memory this way.
soundData = love.sound.
| soundData | SoundData | A new SoundData object. |
| file | string / File / FileData | The file path/File/FileData of the file to load. |
soundData = love.sound.
| soundData | SoundData | A new SoundData object. |
| samples | number | Total number of samples. |
| samplingRate (44100) | number | Number of samples per second |
| bitRate (16) | number | Bits per sample (8 or 16). |
| channelCount (2) | number | Either 1 for mono or 2 for stereo. |
Contains raw audio samples. You can not play SoundData back directly. You must wrap a Source object around it.
Gets the number of bits per sample.
bits = SoundData:
| bits | number | Either 8 or 16. |
Gets the number of channels in the stream.
channels = SoundData:
| channels | number | 1 for mono, 2 for stereo. |
Gets the duration of the sound data.
duration = SoundData:
| duration | number | The duration of the sound data in seconds. |
Gets the sample at the specified position.
sample = SoundData:
| sample | number | The normalized sample (range -1.0 to 1.0). |
| i | number | An integer value specifying the position of the sample (0 points to the first sample). |
Gets the number of samples per channel of the SoundData.
count = SoundData:
| count | number | Total number of samples. |
Gets the sample rate of the SoundData.
rate = SoundData:
| rate | number | Number of samples per second. |
Sets the sample at the specified position.
SoundData:
| i | number | The position of the sample (0 means first sample). |
| sample | number | A normalized sample (range -1.0 to 1.0). |
Gets text from the clipboard.
text = love.system.
| text | string | The text currently held in the system's clipboard. |
Gets the current operating system. In general, LÖVE abstracts away the need to know the current operating system, but there are a few cases where it can be useful (especially in combination with os.execute.)
osString = love.system.
| osString | string | The current operating system. "OS X", "Windows", "Linux", "Android" or "iOS". |
Gets information about the system's power supply.
state, percent, seconds = love.system.
| state | PowerState | The basic state of the power supply. |
| percent | number | Percentage of battery life left, between 0 and 100. nil if the value can't be determined or there's no battery. |
| seconds | number | Seconds of battery life left. nil if the value can't be determined or there's no battery. |
Gets the number of CPU cores in the system.
The number includes the threads reported if technologies such as Intel's Hyper-threading are enabled. For example, on a 4-core CPU with Hyper-threading, this function will return 8.
cores = love.system.
| cores | number | Gets the number of CPU cores in the system. |
Opens a URL with the user's web or file browser.
success = love.system.
| success | boolean | Whether the URL was opened successfully. |
| url | string | The URL to open. Must be formatted as a proper URL. To open a file or folder, "file://" must be prepended to the path. |
Puts text in the clipboard.
love.system.
| text | string | The new text to hold in the system's clipboard. |
Causes the device to vibrate, if possible. Currently this will only work on Android and iOS devices that have a built-in vibration motor.
love.system.
| seconds (0.5) | number | The duration to vibrate for. If called on an iOS device, it will always vibrate for 0.5 seconds due to limitations in the iOS system APIs. |
unknown
Cannot determine power status.
battery
Not plugged in, running on a battery.
nobattery
Plugged in, no battery available.
charging
Plugged in, charging battery.
charged
Plugged in, battery is fully charged.
Creates or retrieves a named thread channel.
channel = love.thread.
| channel | Channel | A named channel object which can be further manipulated. |
| name | string | The name of the channel you want to create or retrieve. |
Create a new unnamed thread channel.
One use for them is to pass new unnamed channels to other threads via Channel:push
channel = love.thread.
| channel | Channel | A unnamed channel object which can be further manipulated. |
Creates a new Thread from a file.
thread = love.thread.
| thread | Thread | A new Thread that has yet to be started. |
| file | string / File / FileData | The file path/File/FileData of the Lua File to use as source. |
thread = love.thread.
| thread | Thread | A new Thread that has yet to be started. |
| codestring | string | A string containing the Lua code to use as the source. It needs to either be at least 1024 characters long, or contain at least one newline. |
A Thread is a chunk of code that can run in parallel with other threads. Data can be sent between different threads with Channel objects.
Retrieves the error string from the thread if it produced an error.
message = Thread:
| message | string | The error message. |
Starts the thread.
Threads can be restarted after they have completed their execution.
Thread:
Thread:
| arg1 | Variant | A string, number, boolean, LÖVE object, or simple table. |
| arg2 | Variant | A string, number, boolean, LÖVE object, or simple table. |
| ... | Variant | You can continue passing values to the thread. |
Wait for a thread to finish. This call will block until the thread finishes.
Thread:
Gets whether the thread is currently running.
Threads which are not running can be (re)started with Thread:start.
running = Thread:
| running | boolean | True if the thread is running, false otherwise. |
A channel is a way to send and receive data to and from different threads.
Retrieves the value of a Channel message and removes it from the message queue.
It waits until a message is in the queue then returns the message value.
value = Channel:
| value | Variant | The contents of the message. |
Retrieves the number of messages in the thread Channel queue.
count = Channel:
| count | number | The number of messages in the queue. |
Retrieves the value of a Channel message, but leaves it in the queue.
It returns nil if there's no message in the queue.
value = Channel:
| value | Variant | The contents of the message. |
Executes the specified function atomically with respect to this Channel.
Calling multiple methods in a row on the same Channel is often useful. However if multiple Threads are calling this Channel's methods at the same time, the different calls on each Thread might end up interleaved (e.g. one or more of the second thread's calls may happen in between the first thread's calls.)
This method avoids that issue by making sure the Thread calling the method has exclusive access to the Channel until the specified function has returned.
ret1, ... = Channel:
| ret1 | any | The first return value of the given function (if any.) |
| ... | any | Any other return values. |
| func | function | The function to call, the form of function(channel, arg1, arg2, ...) end. The Channel is passed as the first argument to the function when it is called. |
| arg1 | any | Additional arguments that the given function will receive when it is called. |
| ... | any | Additional arguments that the given function will receive when it is called. |
Retrieves the value of a Channel message and removes it from the message queue.
It returns nil if there are no messages in the queue.
value = Channel:
| value | Variant | The contents of the message. |
Send a message to the thread Channel.
See Variant for the list of supported types.
Channel:
| value | Variant | The contents of the message. |
Send a message to the thread Channel and wait for a thread to accept it.
See Variant for the list of supported types.
Channel:
| value | Variant | The contents of the message. |
Gets the average delta time (seconds per frame) over the last second.
delta = love.timer.
| delta | number | The average delta time over the last second. |
Gets the time between the last two frames.
dt = love.timer.
| dt | number | The time passed (in seconds). |
Gets the current frames per second.
fps = love.timer.
| fps | number | The current FPS. |
Gets the value of a timer with an unspecified starting time. This function should only be used to calculate differences between points in time, as the starting time of the timer is unknown.
time = love.timer.
| time | number | The time in seconds. |
Sleeps the program for the specified amount of time.
love.timer.
| s | number | Seconds to sleep for. |
Measures the time between two frames. Calling this changes the return value of love.timer.getDelta.
love.timer.
Gets the current position of the specified touch-press, in pixels.
x, y = love.touch.
| x | number | The position along the x-axis of the touch-press inside the window, in pixels. |
| y | number | The position along the y-axis of the touch-press inside the window, in pixels. |
| id | light userdata | The identifier of the touch-press. Use love.touch.getTouches, love.touchpressed, or love.touchmoved to obtain touch id values. |
Gets the current pressure of the specified touch-press.
pressure = love.touch.
| pressure | number | The pressure of the touch-press. Most touch screens aren't pressure sensitive, in which case the pressure will be 1. |
| id | light userdata | The identifier of the touch-press. Use love.touch.getTouches, love.touchpressed, or love.touchmoved to obtain touch id values. |
Gets a list of all active touch-presses.
touches = love.touch.
| touches | table | A list of active touch-press id values, which can be used with love.touch.getPosition. |
Converts a number from pixels to density-independent units.
The pixel density inside the window might be greater (or smaller) than the "size" of the window. For example on a retina screen in Mac OS X with the highdpi window flag enabled, the window may take up the same physical size as an 800x600 window, but the area inside the window uses 1600x1200 pixels. love.window.fromPixels(1600) would return 800 in that case.
This function converts coordinates from pixels to the size users are expecting them to display at onscreen. love.window.toPixels does the opposite. The highdpi window flag must be enabled to use the full pixel density of a Retina screen on Mac OS X and iOS. The flag currently does nothing on Windows and Linux, and on Android it is effectively always enabled.
Most LÖVE functions return values and expect arguments in terms of pixels rather than density-independent units.
value = love.window.
| value | number | The converted number, in density-independent units. |
| pixelvalue | number | A number in pixels to convert to density-independent units. |
x, y = love.window.
| x | number | The converted x-axis value of the coordinate, in density-independent units. |
| y | number | The converted y-axis value of the coordinate, in density-independent units. |
| px | number | The x-axis value of a coordinate in pixels. |
| py | number | The y-axis value of a coordinate in pixels. |
Gets the name of a display.
name = love.window.
| name | string | The name of the specified display. |
| displayindex | number | The index of the display to get the name of. |
Gets whether the window is fullscreen.
fullscreen, fstype = love.window.
| fullscreen | boolean | True if the window is fullscreen, false otherwise. |
| fstype | FullscreenType | The type of fullscreen mode used. |
love.window.
Gets a list of supported fullscreen modes.
modes = love.window.
| modes | table | A table of width/height pairs. (Note that this may not be in order.) |
| display (1) | number | The index of the display, if multiple monitors are available. |
Gets the window icon.
imagedata = love.window.
| imagedata | ImageData | The window icon imagedata, or nil of no icon has been set with love.window.setIcon. |
Gets the current display mode.
width, height, flags = love.window.
| width | number | Window width. |
| height | number | Window height. |
| flags | table | Table containing the window properties. |
| flags.fullscreen | boolean | Fullscreen (true), or windowed (false). |
| flags.fullscreentype | FullscreenType | The type of fullscreen mode used. |
| flags.vsync | boolean | True if the graphics framerate is synchronized with the monitor's refresh rate, false otherwise. |
| flags.msaa | number | The number of antialiasing samples used (0 if MSAA is disabled). |
| flags.resizable | boolean | True if the window is resizable in windowed mode, false otherwise. |
| flags.borderless | boolean | True if the window is borderless in windowed mode, false otherwise. |
| flags.centered | boolean | True if the window is centered in windowed mode, false otherwise. |
| flags.display | number | The index of the display the window is currently in, if multiple monitors are available. |
| flags.minwidth | number | The minimum width of the window, if it's resizable. |
| flags.minheight | number | The minimum height of the window, if it's resizable. |
| flags.highdpi | boolean | True if high-dpi mode should be used on Retina displays in OS X and iOS. Does nothing on non-Retina displays. Added in 0.9.1. |
| flags.refreshrate | number | The refresh rate of the screen's current display mode, in Hz. May be 0 if the value can't be determined. |
| flags.x | number | The x-coordinate of the window's position in its current display. |
| flags.y | number | The y-coordinate of the window's position in its current display. |
Gets the DPI scale factor associated with the window.
The pixel density inside the window might be greater (or smaller) than the "size" of the window. For example on a retina screen in Mac OS X with the highdpi window flag enabled, the window may take up the same physical size as an 800x600 window, but the area inside the window uses 1600x1200 pixels. love.window.getPixelScale() would return 2.0 in that case.
The love.window.fromPixels and love.window.toPixels functions can also be used to convert between units.
The highdpi window flag must be enabled to use the full pixel density of a Retina screen on Mac OS X and iOS. The flag currently does nothing on Windows and Linux, and on Android it is effectively always enabled.
scale = love.window.
| scale | number | The pixel scale factor associated with the window. |
Gets the position of the window on the screen.
The window position is in the coordinate space of the display it is currently in.
x, y, display = love.window.
| x | number | The x-coordinate of the window's position. |
| y | number | The y-coordinate of the window's position. |
| display | number | The index of the display that the window is in. |
Gets the window title.
title = love.window.
| title | string | The current window title. |
Checks if the game window has keyboard focus.
focus = love.window.
| focus | boolean | True if the window has the focus or false if not. |
Checks if the game window has mouse focus.
focus = love.window.
| focus | boolean | True if the window has mouse focus or false if not. |
love.window.
Gets whether the display is allowed to sleep while the program is running.
Display sleep is disabled by default. Some types of input (e.g. joystick button presses) might not prevent the display from sleeping, if display sleep is allowed.
enabled = love.window.
| enabled | boolean | True if system display sleep is enabled / allowed, false otherwise. |
Gets whether the Window is currently maximized.
The window can be maximized if it is not fullscreen and is resizable, and either the user has pressed the window's Maximize button or love.window.maximize has been called.
maximized = love.window.
| maximized | boolean | True if the window is currently maximized in windowed mode, false otherwise. |
Checks if the window is open.
open = love.window.
| open | boolean | True if the window is open, false otherwise. |
Checks if the game window is visible.
The window is considered visible if it's not minimized and the program isn't hidden.
visible = love.window.
| visible | boolean | True if the window is visible or false if not. |
Makes the window as large as possible.
This function has no effect if the window isn't resizable, since it essentially programmatically presses the window's "maximize" button.
love.window.
Causes the window to request the attention of the user if it is not in the foreground.
In Windows the taskbar icon will flash, and in OS X the dock icon will bounce.
love.window.
| continuous (false) | boolean | Whether to continuously request attention until the window becomes active, or to do it only once. |
love.window.
Sets whether the display is allowed to sleep while the program is running.
Display sleep is disabled by default. Some types of input (e.g. joystick button presses) might not prevent the display from sleeping, if display sleep is allowed.
love.window.
| enable | boolean | True to enable system display sleep, false to disable it. |
Enters or exits fullscreen. The display to use when entering fullscreen is chosen based on which display the window is currently in, if multiple monitors are connected.
If fullscreen mode is entered and the window size doesn't match one of the monitor's display modes (in normal fullscreen mode) or the window size doesn't match the desktop size (in 'desktop' fullscreen mode), the window will be resized appropriately. The window will revert back to its original size again when fullscreen mode is exited using this function.
success = love.window.
| success | boolean | True if successful, false otherwise. |
| fullscreen | boolean | Whether to enter or exit fullscreen mode. |
success = love.window.
| success | boolean | True if successful, false otherwise. |
| fullscreen | boolean | Whether to enter or exit fullscreen mode. |
| fstype | FullscreenType | The type of fullscreen mode to use. |
Sets the window icon until the game is quit. Not all operating systems support very large icon images.
success = love.window.
| success | boolean | Whether the icon has been set successfully. |
| imagedata | ImageData | The window icon image. |
Sets the display mode and properties of the window.
If width or height is 0, setMode will use the width and height of the desktop.
Changing the display mode may have side effects: for example, canvases will be cleared and values sent to shaders with Shader:send will be erased. Make sure to save the contents of canvases beforehand or re-draw to them afterward if you need to.
success = love.window.
| success | boolean | True if successful, false otherwise. |
| width | number | Display width. |
| height | number | Display height. |
| flags | table | The flags table with the options: |
| flags.fullscreen (false) | boolean | Fullscreen (true), or windowed (false). |
| flags.fullscreentype ("desktop") | FullscreenType | The type of fullscreen to use. This defaults to "normal" in 0.9.2 and older. |
| flags.vsync (true) | boolean | True if LÖVE should wait for vsync, false otherwise. |
| flags.msaa (0) | number | The number of antialiasing samples. |
| flags.resizable (false) | boolean | True if the window should be resizable in windowed mode, false otherwise. |
| flags.borderless (false) | boolean | True if the window should be borderless in windowed mode, false otherwise. |
| flags.centered (true) | boolean | True if the window should be centered in windowed mode, false otherwise. |
| flags.display (1) | number | The index of the display to show the window in, if multiple monitors are available. |
| flags.minwidth (1) | number | The minimum width of the window, if it's resizable. Cannot be less than 1. |
| flags.minheight (1) | number | The minimum height of the window, if it's resizable. Cannot be less than 1. |
| flags.highdpi (false) | boolean | True if high-dpi mode should be used on Retina displays in OS X. Does nothing on non-Retina displays. |
| flags.x (nil) | number | The x-coordinate of the window's position in the specified display. |
| flags.y (nil) | number | The y-coordinate of the window's position in the specified display. |
Sets the position of the window on the screen.
The window position is in the coordinate space of the specified display.
love.window.
| x | number | The x-coordinate of the window's position. |
| y | number | The y-coordinate of the window's position. |
| display | number | The index of the display that the new window position is relative to. |
Sets the window title.
love.window.
| title | string | The new window title. |
Displays a message box dialog above the love window. The message box contains a title, optional text, and buttons.
success = love.window.
| success | boolean | Whether the message box was successfully displayed. |
| title | string | The title of the message box. |
| message | string | The text inside the message box. |
| type ("info") | MessageBoxType | The type of the message box. |
| attachtowindow (true) | boolean | Whether the message box should be attached to the love window or free-floating. |
pressedbutton = love.window.
| pressedbutton | number | The index of the button pressed by the user. May be 0 if the message box dialog was closed without pressing a button. |
| title | string | The title of the message box. |
| message | string | The text inside the message box. |
| buttonlist | table | A table containing a list of button names to show. The table can also contain the fields enterbutton and escapebutton, which should be the index of the default button to use when the user presses 'enter' or 'escape', respectively. |
| type ("info") | MessageBoxType | The type of the message box. |
| attachtowindow (true) | boolean | Whether the message box should be attached to the love window or free-floating. |
Converts a number from density-independent units to pixels.
The pixel density inside the window might be greater (or smaller) than the "size" of the window. For example on a retina screen in Mac OS X with the highdpi window flag enabled, the window may take up the same physical size as an 800x600 window, but the area inside the window uses 1600x1200 pixels. love.window.toPixels(800) would return 1600 in that case.
This is used to convert coordinates from the size users are expecting them to display at onscreen to pixels. love.window.fromPixels does the opposite. The highdpi window flag must be enabled to use the full pixel density of a Retina screen on Mac OS X and iOS. The flag currently does nothing on Windows and Linux, and on Android it is effectively always enabled.
Most LÖVE functions return values and expect arguments in terms of pixels rather than density-independent units.
pixelvalue = love.window.
| pixelvalue | number | The converted number, in pixels. |
| value | number | A number in density-independent units to convert to pixels. |
px, py = love.window.
| px | number | The converted x-axis value of the coordinate, in pixels. |
| py | number | The converted y-axis value of the coordinate, in pixels. |
| x | number | The x-axis value of a coordinate in density-independent units to convert to pixels. |
| y | number | The y-axis value of a coordinate in density-independent units to convert to pixels. |
desktop
Sometimes known as borderless fullscreen windowed mode. A borderless screen-sized window is created which sits on top of all desktop UI elements. The window is automatically resized to match the dimensions of the desktop, and its size cannot be changed.
exclusive
Standard exclusive-fullscreen mode. Changes the display mode (actual resolution) of the monitor.