Difference between revisions of "love.graphics.getMaxImageSize"

(Created page)
 
m (Modified description to match new behaviour)
Line 2: Line 2:
 
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.
  
Attempting to create an Image or a Canvas with a width *or* height greater than this number will give an error.
+
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 likely be 2048 or greater.
+
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 ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
Line 15: Line 15:
 
{{param|number|size|The max supported width or height of Images and Canvases.}}
 
{{param|number|size|The max supported width or height of Images and Canvases.}}
 
== Notes ==
 
== Notes ==
There is an [http://feedback.wildfiregames.com/report/opengl/feature/GL_MAX_TEXTURE_SIZE online database] which has collected info about the max image size for various systems. A good rule of thumb is to never create Images or Canvases with widths or heights greater than 2048.
+
There is an [http://feedback.wildfiregames.com/report/opengl/feature/GL_MAX_TEXTURE_SIZE online database] which has collected info about the max image size for various systems.
 
== See Also ==
 
== See Also ==
 
* [[parent::love.graphics]]
 
* [[parent::love.graphics]]

Revision as of 21:56, 16 August 2013

Available since LÖVE 0.9.0
This function is not supported in earlier versions.

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