Difference between revisions of "love.graphics.getMaxImageSize"

m (Modified description to match new behaviour)
m (Added deprecation notice)
Line 1: Line 1:
 
{{newin|[[0.9.0]]|090|type=function}}
 
{{newin|[[0.9.0]]|090|type=function}}
 +
{{deprecatedin|[[0.9.1]]|091|type=function|text=This function will be removed in a future version. Use [[love.graphics.getSystemLimit]] instead}}
 
Gets the max supported width or height of [[Image]]s and [[Canvas]]es.
 
Gets the max supported width or height of [[Image]]s and [[Canvas]]es.
  

Revision as of 23:17, 28 July 2014

Available since LÖVE 0.9.0
This function is not supported in earlier versions.
Deprecated in LÖVE 0.9.1
This function will be removed in a future version. Use love.graphics.getSystemLimit instead.

Gets the max supported width or height of Images and Canvases.

Attempting to create an Image with a width *or* height greater than this number will create a checkerboard-patterned image instead. Doing the same for a canvas will result in an error.

The returned number depends on the system running the code. It is safe to assume it will never be less than 1024 and will almost always be 2048 or greater.

Function

Synopsis

size = love.graphics.getMaxImageSize( )

Arguments

None.

Returns

number size
The max supported width or height of Images and Canvases.

Notes

There is an online database which has collected info about the max image size for various systems.

See Also


Other Languages