W3cubDocs

/LÖVE

CompressedFormat

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

Compressed image data formats. Here and here are a couple overviews of many of the formats.

Unlike traditional PNG or jpeg, these formats stay compressed in RAM and in the graphics card's VRAM. This is good for saving memory space as well as improving performance, since the graphics card will be able to keep more of the image's pixels in its fast-access cache when drawing it.

In LÖVE versions prior to 0.10.0, these constants are all lower-case.

Constants

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 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 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 Available since 0.9.2: 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 Available since 0.9.2: The signed variant of the BC6H format. Stores RGB data in the range of [-65504, +65504].
BC7 Available since 0.9.2: The BC7 format (also known as BPTC.) Stores RGB or RGBA data at 8 bits per pixel.

ETC1 Available since 0.10.0: The ETC1 format. RGB data at 4 bits per pixel. Suitable for fully opaque images on older Android devices.
ETC2rgb Available since 0.10.0: The RGB variant of the ETC2 format. RGB data at 4 bits per pixel. Suitable for fully opaque images on newer mobile devices.
ETC2rgba Available since 0.10.0: 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 Available since 0.10.0: The RGBA variant of the ETC2 format where pixels are either fully transparent or fully opaque. RGBA data at 4 bits per pixel.
EACr Available since 0.10.0: The single-channel variant of the EAC format. Stores just the red channel, at 4 bits per pixel.
EACrs Available since 0.10.0: 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 Available since 0.10.0: The two-channel variant of the EAC format. Stores red and green channels at 8 bits per pixel.
EACrgs Available since 0.10.0: The signed two-channel variant of the EAC format.
PVR1rgb2 Available since 0.10.0: 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 Available since 0.10.0: The 4 bit per pixel RGB variant of the PVRTC1 format. Stores RGB data at 4 bits per pixel.
PVR1rgba2 Available since 0.10.0: The 2 bit per pixel RGBA variant of the PVRTC1 format.
PVR1rgba4 Available since 0.10.0: The 4 bit per pixel RGBA variant of the PVRTC1 format.
ASTC4x4 Available since 0.10.0: The 4x4 pixels per block variant of the ASTC format. RGBA data at 8 bits per pixel.
ASTC5x4 Available since 0.10.0: The 5x4 pixels per block variant of the ASTC format. RGBA data at 6.4 bits per pixel.
ASTC5x5 Available since 0.10.0: The 5x5 pixels per block variant of the ASTC format. RGBA data at 5.12 bits per pixel.
ASTC6x5 Available since 0.10.0: The 6x5 pixels per block variant of the ASTC format. RGBA data at 4.27 bits per pixel.
ASTC6x6 Available since 0.10.0: The 6x6 pixels per block variant of the ASTC format. RGBA data at 3.56 bits per pixel.
ASTC8x5 Available since 0.10.0: The 8x5 pixels per block variant of the ASTC format. RGBA data at 3.2 bits per pixel.
ASTC8x6 Available since 0.10.0: The 8x6 pixels per block variant of the ASTC format. RGBA data at 2.67 bits per pixel.
ASTC8x8 Available since 0.10.0: The 8x8 pixels per block variant of the ASTC format. RGBA data at 2 bits per pixel.
ASTC10x5 Available since 0.10.0: The 10x5 pixels per block variant of the ASTC format. RGBA data at 2.56 bits per pixel.
ASTC10x6 Available since 0.10.0: The 10x6 pixels per block variant of the ASTC format. RGBA data at 2.13 bits per pixel.
ASTC10x8 Available since 0.10.0: The 10x8 pixels per block variant of the ASTC format. RGBA data at 1.6 bits per pixel.
ASTC10x10 Available since 0.10.0: The 10x10 pixels per block variant of the ASTC format. RGBA data at 1.28 bits per pixel.
ASTC12x10 Available since 0.10.0: The 12x10 pixels per block variant of the ASTC format. RGBA data at 1.07 bits per pixel.
ASTC12x12 Available since 0.10.0: The 12x12 pixels per block variant of the ASTC format. RGBA data at 0.89 bits per pixel.

Notes

Not all formats are supported in love.graphics Images on all systems, although the DXT formats have close to 100% support on desktop operating systems.

The BC4 and BC5 formats are supported on systems with DirectX 10 / OpenGL 3-capable desktop hardware and drivers. The BC6H and BC7 formats are only supported on desktop systems with DirectX 11 / OpenGL 4-capable hardware and very recent drivers. Mac OS X does not support BC6H or BC7 at all currently.

ETC1 is supported by Android devices, as well as newer (OpenGL ES 3-capable) iOS devices.

The PVR1 formats are supported by iOS devices, as well as Android devices with PowerVR GPUs.

The ETC2 and EAC formats are supported by newer (OpenGL ES 3-capable) iOS and Android devices.

ASTC is only supported by very new mobile devices (e.g. the iPhone 6), and the latest Skylake (and newer) integrated Intel GPUs. It has a variety of variants to allow for picking the most compressed possible one that doesn't have any noticeable compression artifacts, for a given texture.

Use love.graphics.getCompressedImageFormats to check for support:

local supportedformats = love.graphics.getCompressedImageFormats()
 
-- Note: use "DXT5" instead of "dxt5" in 0.10.0 and newer.
if not supportedformats["dxt5"] then
    -- Can't load CompressedImageData with the DXT5 format into images!
    -- On some Linux systems with Mesa drivers, the user will need to install a "libtxc-dxtn" package because the DXT (aka S3TC) formats are patented.
    -- Support for DXT formats on all other desktop drivers is pretty much guaranteed.
end
 
-- Note: use "BC5" instead of "bc5" in 0.10.0 and newer.
if not supportedformats["bc5"] then
    -- Can't load CompressedImageData with the BC5 format into images!
    -- The user likely doesn't have a video card capable of using that format.
end

CompressedFormat

Constants

Notes

See Also