Backgroundfill

Extends ImageFilter

Image Filter class fill background with color;

since

3.4

package

Joomla CMS

Methods

__construct

Class constructor.

__construct( handle) : 
inherited
since

1.7.3

throws

InvalidArgumentException

RuntimeException

Arguments

handle

resourceThe image resource on which to apply the filter.

Response

mixed

execute

Method to apply a background color to an image resource.

execute(mixed||string|int options = []) : 
since

3.4

throws

InvalidArgumentException

Arguments

options

array<string|int, mixed>An array of options for the filter. color Background matte color

Response

void

sanitizeColor

Method to sanitize color values and/or convert to an array

sanitizeColor( input) : mixed||string|int
since

3.4

note

'#FF0000FF' returns an array with alpha of 0 (opaque)

Arguments

input

mixedAssociative array of colors and alpha, or hex RGBA string when alpha FF is opaque. Defaults to black and opaque alpha.

Response

array<string|int, mixed>Associative array of red, green, blue and alpha

Properties

handle

The image resource handle.

inherited
since

2.5.0

Type(s)

resource