PHP 8.4.0 RC4 available for testing

imageavif

(PHP 8 >= 8.1.0)

imageavifOutput image to browser or file

Description

imageavif(
    GdImage $image,
    resource|string|null $file = null,
    int $quality = -1,
    int $speed = -1
): bool

Outputs or saves a AVIF Raster image from the given image.

Parameters

image

A GdImage object, returned by one of the image creation functions, such as imagecreatetruecolor().

file

The path or an open stream resource (which is automatically closed after this function returns) to save the file to. If not set or null, the raw image stream will be output directly.

quality

quality is optional, and ranges from 0 (worst quality, smaller file) to 100 (best quality, larger file). If -1 is provided, the default value 30 is used.

speed

speed is optional, and ranges from 0 (slow, smaller file) to 10 (fast, larger file). If -1 is provided, the default value 6 is used.

Return Values

Returns true on success or false on failure.

Caution

However, if libgd fails to output the image, this function returns true.

Errors/Exceptions

Throws a ValueError if quality or speed is invalid.

Changelog

Version Description
8.4.0 Now throws a ValueError if quality or speed is invalid.

See Also

  • imagepng() - Output a PNG image to either the browser or a file
  • imagewbmp() - Output image to browser or file
  • imagejpeg() - Output image to browser or file
  • imagetypes() - Return the image types supported by this PHP build
add a note

User Contributed Notes 1 note

up
0
avi at orons dot pro
2 years ago
Usage example:
$image = imagecreatefromjpeg('test.jpg'); //read a jpg file
imageavif($image, 'test.avif'); //save an avif file
To Top