love.graphics.newCubeImage
| Available since LÖVE 0.11.0 |
| This function is not supported in earlier versions. |
|
This function can be slow if it is called repeatedly, such as from love.update or love.draw. If you need to use a specific resource often, create it once and store it somewhere it can be reused! |
Cubemap images have 6 faces (sides) which represent a cube. They can't be rendered directly, they can only be used in Shader code (and sent to the shader via Shader:send).
To use a cubemap image in a Shader, it must be declared as a CubeImage or samplerCube type (instead of Image or sampler2D). The Texel(CubeImage image, vec3 direction) shader function must be used to get pixel colors from the cubemap. The vec3 argument is a normalized direction from the center of the cube, rather than explicit texture coordinates.
Each face in a cubemap image must have square dimensions.
For variants of this function which accept a single image containing multiple cubemap faces, they must be laid out in one of the following forms in the image:
+y
+z +x -z
-y
-x
or:
+y
-x +z +x -z
-y
or:
+x
-x
+y
-y
+z
-z
or:
+x -x +y -y +z -z
Contents
Function
Creates a cubemap Image given a single image file containing multiple cube faces.
Synopsis
image = love.graphics.newCubeImage( filename, settings )
Arguments
string filename- The filepath to a cubemap image file (or a File, FileData, or ImageData).}
table settings (nil)- Optional table of settings to configure the cubemap image, containing the following fields:
boolean mipmaps (false)- True to make the image use mipmaps, false to disable them. Mipmaps will be automatically generated if the image isn't a compressed texture format.
boolean linear (false)- True to treat the image's pixels as linear instead of sRGB, when gamma correct rendering is enabled. Most images are authored as sRGB.
Returns
Image image- An cubemap Image object.
Function
Creates a cubemap Image given a different image file for each cube face.
Synopsis
image = love.graphics.newCubeImage( faces, settings )
Arguments
table faces- A table containing 6 filepaths to images (or File, FileData, ImageData, or CompressedImageData objects), in an array. Each face image must have the same dimensions. A table of tables can also be given, where each sub-table contains all mipmap levels for the cube face index of that sub-table.
table settings (nil)- Optional table of settings to configure the cubemap image, containing the following fields:
boolean mipmaps (false)- True to make the image use mipmaps, false to disable them. Mipmaps will be automatically generated if the image isn't a compressed texture format.
boolean linear (false)- True to treat the image's pixels as linear instead of sRGB, when gamma correct rendering is enabled. Most images are authored as sRGB.
Returns
Image image- An cubemap Image object.
See Also
Other Languages
Dansk –
Deutsch –
English –
Español –
Français –
Indonesia –
Italiano –
Lietuviškai –
Magyar –
Nederlands –
Polski –
Português –
Română –
Slovenský –
Suomi –
Svenska –
Türkçe –
Česky –
Ελληνικά –
Български –
Русский –
Српски –
Українська –
עברית –
ไทย –
日本語 –
正體中文 –
简体中文 –
Tiếng Việt –
한국어
More info
