Inheritance diagram for Image:

Public Member Functions
	__construct ($handle)

	__destruct ()

	destroy ()

	getHandle ()

	isValid ()

	releaseHandle ()

	saveToFile ($uri)

	asString ($format)

	output ($format)

	getWidth ()

	getHeight ()

	allocateColor ($R, $G=null, $B=null)

	isTransparent ()

	getTransparentColor ()

	setTransparentColor ($color)

	getTransparentColorRGB ()

	getRGBAt ($x, $y)

	setRGBAt ($x, $y, $color)

	getColorRGB ($colorIndex)

	getColorAt ($x, $y)

	setColorAt ($x, $y, $color)

	getClosestColor ($R, $G=null, $B=null)

	getExactColor ($R, $G=null, $B=null)

	copyTransparencyFrom ($sourceImage, $fill=true)

	fill ($x, $y, $color)

	getMask ()

	resize ($width=null, $height=null, $fit='inside', $scale='any')

	resizeDown ($width=null, $height=null, $fit='inside')

	resizeUp ($width=null, $height=null, $fit='inside')

	rotate ($angle, $bgColor=null, $ignoreTransparent=true)

	merge ($overlay, $left=0, $top=0, $pct=100)

	resizeCanvas ($width, $height, $pos_x, $pos_y, $bg_color=null, $scale='any', $merge=false)

	roundCorners ($radius, $color=null, $smoothness=2, $corners=255)

	applyMask ($mask, $left=0, $top=0)

	applyFilter ($filter, $arg1=null, $arg2=null, $arg3=null, $arg4=null)

	applyConvolution ($matrix, $div, $offset)

	crop ($left=0, $top=0, $width='100%', $height='100%')

	autoCrop ($margin=0, $rgb_threshold=0, $pixel_cutoff=1, $base_color=null)

	asNegative ()

	asGrayscale ()

	mirror ()

	unsharp ($amount, $radius, $threshold)

	flip ()

	correctGamma ($inputGamma, $outputGamma)

	addNoise ($amount, $type)

	__call ($name, $args)

	__toString ()

	copy ()

	copyTo ($dest, $left=0, $top=0)

	getCanvas ()

	isTrueColor ()

	asTrueColor ()

	asPalette ($nColors=255, $dither=null, $matchPalette=true)

	getChannels ()

	copyNoAlpha ()

	__sleep ()

	__wakeup ()

Protected Member Functions
	writeHeader ($name, $data)

	getOperation ($name)

Protected Attributes
	$handle = null

	$handleReleased = false

	$canvas = null

	$sdata = null

Constructor & Destructor Documentation

◆ __construct()

__construct ( $handle )

The base class constructor

Parameters

resource $handle Image handle (GD2 resource)

Reimplemented in TrueColorImage.

◆ __destruct()

__destruct ( )

Cleanup

Destroys the handle via \WideImage\Image::destroy() when called by the GC.

Member Function Documentation

◆ __call()

__call	(	$name,
		$args
	)

Used internally to execute operations

Parameters

string	$name
array	$args

Returns: \WideImage\Image

◆ __sleep()

__sleep ( )

Returns an array of serializable protected variables. Called automatically upon serialize().

Returns: array

◆ __toString()

__toString ( )

Returns an image in GIF or PNG format

Returns: string

◆ __wakeup()

__wakeup ( )

Restores an image from serialization. Called automatically upon unserialize().

◆ addNoise()

addNoise	(	$amount,
		$type
	)

Adds noise to the image

Author: Tomasz Kapusta

Parameters

int	$amount	Number of noise pixels to add
string	$type	Type of noise 'salt&pepper', 'color' or 'mono'

Returns: \WideImage\Image Image with noise added

◆ allocateColor()

allocateColor	(	$R,
		$G = `null`,
		$B = `null`
	)

Allocate a color by RGB values.

Parameters

mixed	$R	Red-component value or an RGB array (with red, green, blue keys)
int	$G	If $R is int, this is the green component
int	$B	If $R is int, this is the blue component

Returns: int Image color index

◆ applyConvolution()

applyConvolution	(	$matrix,
		$div,
		$offset
	)

Applies convolution matrix with imageconvolution()

Parameters

array	$matrix
float	$div
float	$offset

Returns: \WideImage\Image

◆ applyFilter()

applyFilter	(	$filter,
		$arg1 = `null`,
		$arg2 = `null`,
		$arg3 = `null`,
		$arg4 = `null`
	)

Applies a filter

Parameters

int	$filter	One of the IMG_FILTER_* constants
int	$arg1
int	$arg2
int	$arg3
int	$arg4

Returns: \WideImage\Image

◆ applyMask()

applyMask	(	$mask,
		$left = `0`,
		$top = `0`
	)

Returns an image with applied mask

A mask is a grayscale image, where the shade determines the alpha channel. Black is fully transparent and white is fully opaque.

Parameters

\WideImage\Image	$mask	The mask image, greyscale
mixed	$left	Left coordinate, smart coordinate
mixed	$top	Top coordinate, smart coordinate

Returns: \WideImage\Image The resulting image

◆ asGrayscale()

asGrayscale ( )

Returns a grayscale copy of the image

Returns: \WideImage\Image grayscale copy

◆ asNegative()

asNegative ( )

Returns a negative of the image

This operation differs from calling \WideImage\Image::applyFilter(IMG_FILTER_NEGATIVE), because it's 8-bit and transparency safe. This means it will return an 8-bit image, if the source image is 8-bit. If that 8-bit image has a palette transparency, the resulting image will keep transparency.

Returns: \WideImage\Image negative of the image

◆ asPalette()

asPalette	(	$nColors = `255`,
		$dither = `null`,
		$matchPalette = `true`
	)

abstract

Returns a palette copy (8bit) of the image

Parameters

int	$nColors	Number of colors in the resulting image, more than 0, less or equal to 255
bool	$dither	Use dithering or not
bool	$matchPalette	Set to true to use imagecolormatch() to match the resulting palette more closely to the original image

Returns: \WideImage\Image

Reimplemented in PaletteImage, and TrueColorImage.

◆ asString()

asString ( $format )

Returns binary string with image data in format specified by $format

Additional parameters may be passed to the function. See \WideImage\Image::saveToFile() for more details.

Parameters

string $format The format of the image

Returns: string The binary image data in specified format

◆ asTrueColor()

asTrueColor ( )

abstract

Returns a true-color copy of the image

Returns: \WideImage\TrueColorImage

Reimplemented in PaletteImage, and TrueColorImage.

◆ autoCrop()

autoCrop	(	$margin = `0`,
		$rgb_threshold = `0`,
		$pixel_cutoff = `1`,
		$base_color = `null`
	)

Performs an auto-crop on the image

The image is auto-cropped from each of four sides. All sides are scanned for pixels that differ from $base_color for more than $rgb_threshold in absolute RGB difference. If more than $pixel_cutoff differentiating pixels are found, that line is considered to be the crop line for the side. If the line isn't different enough, the algorithm procedes to the next line towards the other edge of the image.

When the crop rectangle is found, it's enlarged by the $margin value on each of the four sides.

Parameters

int	$margin	Margin for the crop rectangle, can be negative.
int	$rgb_threshold	RGB difference which still counts as "same color".
int	$pixel_cutoff	How many pixels need to be different to mark a cut line.
int	$base_color	The base color index. If none specified (or null given), left-top pixel is used.

Returns: \WideImage\Image The cropped image

◆ copy()

copy ( )

Returns a copy of the image object

Returns: \WideImage\Image The copy

◆ copyNoAlpha()

copyNoAlpha ( )

abstract

Returns an image without an alpha channel

Returns: \WideImage\Image

Reimplemented in PaletteImage, and TrueColorImage.

◆ copyTo()

copyTo	(	$dest,
		$left = `0`,
		$top = `0`
	)

Copies this image onto another image

Parameters

\WideImage\Image	$dest
int	$left
int	$top

◆ copyTransparencyFrom()

copyTransparencyFrom	(	$sourceImage,
		$fill = `true`
	)

Copies transparency information from $sourceImage. Optionally fills the image with the transparent color at (0, 0).

Parameters

object	$sourceImage
bool	$fill	True if you want to fill the image with transparent color

◆ correctGamma()

correctGamma	(	$inputGamma,
		$outputGamma
	)

Corrects gamma on the image

Parameters

float	$inputGamma
float	$outputGamma

Returns: \WideImage\Image Image with corrected gamma

◆ crop()

crop	(	$left = `0`,
		$top = `0`,
		$width = `'100%'`,
		$height = `'100%'`
	)

Returns a cropped rectangular portion of the image

If the rectangle specifies area that is out of bounds, it's limited to the current image bounds.

Examples: $cropped = $img->crop(10, 10, 150, 200); // crops a 150x200 rect at (10, 10) $cropped = $img->crop(-100, -50, 100, 50); // crops a 100x50 rect at the right-bottom of the image $cropped = $img->crop('25', '25', '50', '50'); // crops a 50x50% rect from the center of the image

This operation supports alignment notation in left/top coordinates. Example: $cropped = $img->crop("right", "bottom", 100, 200); // crops a 100x200 rect from right bottom $cropped = $img->crop("center", "middle", 50, 30); // crops a 50x30 from the center of the image

Parameters

mixed	$left	Left-coordinate of the crop rect, smart coordinate
mixed	$top	Top-coordinate of the crop rect, smart coordinate
mixed	$width	Width of the crop rect, smart coordinate
mixed	$height	Height of the crop rect, smart coordinate

Returns: \WideImage\Image The cropped image

◆ destroy()

destroy ( )

This method destroy the image handle, and releases the image resource.

After this is called, the object doesn't hold a valid image any more. No operation should be called after that.

◆ fill()

fill	(	$x,
		$y,
		$color
	)

Fill the image at ($x, $y) with color index $color

Parameters

int	$x
int	$y
int	$color

◆ flip()

flip ( )

Returns a flipped (mirrored over horizontal line) copy of the image

Returns: \WideImage\Image Flipped copy

◆ getCanvas()

getCanvas ( )

Returns the canvas object

The Canvas object can be used to draw text and shapes on the image

Examples: $img = WideImage::load('pic.jpg); $canvas = $img->getCanvas(); $canvas->useFont('arial.ttf', 15, $img->allocateColor(200, 220, 255)); $canvas->writeText(10, 50, "Hello world!");

$canvas->filledRectangle(10, 10, 80, 40, $img->allocateColor(255, 127, 255)); $canvas->line(60, 80, 30, 100, $img->allocateColor(255, 0, 0)); $img->saveToFile('new.png');

Returns: \WideImage\Canvas The Canvas object

◆ getChannels()

getChannels ( )

abstract

Retrieve an image with selected channels

Examples: $channels = $img->getChannels('red', 'blue'); $channels = $img->getChannels('alpha', 'green'); $channels = $img->getChannels(array('green', 'blue'));

Returns: \WideImage\Image

Reimplemented in PaletteImage, and TrueColorImage.

◆ getClosestColor()

getClosestColor	(	$R,
		$G = `null`,
		$B = `null`
	)

Returns closest color index that matches the given RGB value. Uses PHP's imagecolorclosest()

Parameters

mixed	$R	Red or RGBA array
int	$G	Green component (or null if $R is an RGB array)
int	$B	Blue component (or null if $R is an RGB array)

Returns: int Color index

◆ getColorAt()

getColorAt	(	$x,
		$y
	)

Returns an index of the color at $x, $y

Parameters

int	$x
int	$y

Returns: int Color index for a pixel at $x, $y

◆ getColorRGB()

getColorRGB ( $colorIndex )

Returns a color's RGB

Parameters

int $colorIndex Color index

Returns: mixed RGBA array for a color with index $colorIndex

◆ getExactColor()

getExactColor	(	$R,
		$G = `null`,
		$B = `null`
	)

Returns the color index that exactly matches the given RGB value. Uses PHP's imagecolorexact()

Parameters

mixed	$R	Red or RGBA array
int	$G	Green component (or null if $R is an RGB array)
int	$B	Blue component (or null if $R is an RGB array)

Returns: int Color index

◆ getHandle()

getHandle ( )

Returns the GD image resource

Returns: resource GD image resource

◆ getHeight()

getHeight ( )

Returns: int Image height

◆ getMask()

getMask ( )

Returns the image's mask

Mask is a greyscale image where the shade defines the alpha channel (black = transparent, white = opaque).

For opaque images (JPEG), the result will be white. For images with single-color transparency (GIF, 8-bit PNG), the areas with the transparent color will be black. For images with alpha channel transparenct, the result will be alpha channel.

Returns: \WideImage\Image An image mask

◆ getOperation()

getOperation ( $name )

protected

Used internally to create Operation objects

Parameters

string $name

Returns: object

◆ getRGBAt()

getRGBAt	(	$x,
		$y
	)

Returns a RGBA array for pixel at $x, $y

Parameters

int	$x
int	$y

Returns: array RGB array

◆ getTransparentColor()

getTransparentColor ( )

Returns: int Transparent color index

◆ getTransparentColorRGB()

getTransparentColorRGB ( )

Returns a RGB array of the transparent color or null if none.

Returns: mixed Transparent color RGBA array

◆ getWidth()

getWidth ( )

Returns: int Image width

◆ isTransparent()

isTransparent ( )

Returns: bool True if the image is transparent, false otherwise

◆ isTrueColor()

isTrueColor ( )

abstract

Returns true if the image is true-color, false otherwise

Returns: bool

Reimplemented in PaletteImage, and TrueColorImage.

◆ isValid()

isValid ( )

Returns: bool True, if the image object holds a valid GD image, false otherwise

◆ merge()

merge	(	$overlay,
		$left = `0`,
		$top = `0`,
		$pct = `100`
	)

This method lays the overlay (watermark) on the image.

Hint: if the overlay is a truecolor image with alpha channel, you should leave $pct at 100.

This operation supports alignment notation in coordinates: $watermark = WideImage::load('logo.gif'); $base = WideImage::load('picture.jpg'); $result = $base->merge($watermark, "right - 10", "bottom - 10", 50); // applies a logo aligned to bottom-right corner with a 10 pixel margin

Parameters

\WideImage\Image	$overlay	The overlay image
mixed	$left	Left position of the overlay, smart coordinate
mixed	$top	Top position of the overlay, smart coordinate
int	$pct	The opacity of the overlay

Returns: \WideImage\Image The merged image

◆ mirror()

mirror ( )

Returns a mirrored copy of the image

Returns: \WideImage\Image Mirrored copy

◆ output()

output ( $format )

Outputs the image to browser

Sets headers Content-length and Content-type, and echoes the image in the specified format. All other headers (such as Content-disposition) must be added manually.

Example: WideImage::load('image1.png')->resize(100, 100)->output('gif');

Parameters

string $format Image format

◆ releaseHandle()

releaseHandle ( )

Releases the handle

◆ resize()

resize	(	$width = `null`,
		$height = `null`,
		$fit = `'inside'`,
		$scale = `'any'`
	)

Resize the image to given dimensions.

$width and $height are both smart coordinates. This means that you can pass any of these values in:

positive or negative integer (100, -20, ...)
positive or negative percent string (30%, -15%, ...)
complex coordinate (50% - 20, 15 + 30%, ...)
null: if one dimension is null, it's calculated proportionally from the other.

$fit parameter can be set to one of these three values:

'inside': resize proportionally and fit the resulting image tightly in the $width x $height box
'outside': resize proportionally and fit the resulting image tighly outside the box
'fill': resize the image to fill the $width x $height box exactly

$scale parameter can be:

'down': only resize the image if it's larger than the $width x $height box
'up': only resize the image if it's smaller than the $width x $height box
'any': resize the image

Example (resize to half-size): $smaller = $image->resize('50');

$smaller = $image->resize('100', '100', 'inside', 'down'); is the same as $smaller = $image->resizeDown(100, 100, 'inside');

Parameters

mixed	$width	The new width (smart coordinate), or null.
mixed	$height	The new height (smart coordinate), or null.
string	$fit	'inside', 'outside', 'fill'
string	$scale	'down', 'up', 'any'

Returns: \WideImage\Image The resized image

◆ resizeCanvas()

resizeCanvas	(	$width,
		$height,
		$pos_x,
		$pos_y,
		$bg_color = `null`,
		$scale = `'any'`,
		$merge = `false`
	)

Resizes the canvas of the image, but doesn't scale the content of the image

This operation creates an empty canvas with dimensions $width x $height, filled with background color $bg_color and draws the original image onto it at position [$pos_x, $pos_y].

Arguments $width, $height, $pos_x and $pos_y are all smart coordinates. $width and $height are relative to the current image size, $pos_x and $pos_y are relative to the newly calculated canvas size. This can be confusing, but it makes sense. See the example below.

The example below loads a 100x150 image and then resizes its canvas to 200% x 100%+20 (which evaluates to 200x170). The image is placed at position [10, center+20], which evaluates to [10, 30]. $image = WideImage::load('someimage.jpg'); // 100x150 $white = $image->allocateColor(255, 255, 255); $image->resizeCanvas('200', '100% + 20', 10, 'center+20', $white);

The parameter $merge defines whether the original image should be merged onto the new canvas. This means it blends transparent color and alpha colors into the background color. If set to false, the original image is just copied over, preserving the transparency/alpha information.

You can set the $scale parameter to limit when to resize the canvas. For example, if you want to resize the canvas only if the image is smaller than the new size, but leave the image intact if it's larger, set it to 'up'. Likewise, if you want to shrink the canvas, but don't want to change images that are already smaller, set it to 'down'.

Parameters

mixed	$width	Width of the new canvas (smart coordinate, relative to current image width)
mixed	$height	Height of the new canvas (smart coordinate, relative to current image height)
mixed	$pos_x	x-position of the image (smart coordinate, relative to the new width)
mixed	$pos_y	y-position of the image (smart coordinate, relative to the new height)
int	$bg_color	Background color (created with allocateColor or allocateColorAlpha), defaults to null (tries to use a transparent color)
string	$scale	Possible values: 'up' (enlarge only), 'down' (downsize only), 'any' (resize precisely to $width x $height). Defaults to 'any'.
bool	$merge	Merge the original image (flatten alpha channel and transparency) or copy it over (preserve). Defaults to false.

Returns: \WideImage\Image The resulting image with resized canvas

◆ resizeDown()

resizeDown	(	$width = `null`,
		$height = `null`,
		$fit = `'inside'`
	)

Same as \WideImage\Image::resize(), but the image is only applied if it is larger then the given dimensions. Otherwise, the resulting image retains the source's dimensions.

Parameters

int	$width	New width, smart coordinate
int	$height	New height, smart coordinate
string	$fit	'inside', 'outside', 'fill'

Returns: \WideImage\Image resized image

◆ resizeUp()

resizeUp	(	$width = `null`,
		$height = `null`,
		$fit = `'inside'`
	)

Same as \WideImage\Image::resize(), but the image is only applied if it is smaller then the given dimensions. Otherwise, the resulting image retains the source's dimensions.

Parameters

int	$width	New width, smart coordinate
int	$height	New height, smart coordinate
string	$fit	'inside', 'outside', 'fill'

Returns: \WideImage\Image resized image

◆ rotate()

rotate	(	$angle,
		$bgColor = `null`,
		$ignoreTransparent = `true`
	)

Rotate the image for angle $angle clockwise.

Preserves transparency. Has issues when saving to a BMP.

Parameters

int	$angle	Angle in degrees, clock-wise
int	$bgColor	color of the new background
bool	$ignoreTransparent

Returns: \WideImage\Image The rotated image

◆ roundCorners()

roundCorners	(	$radius,
		$color = `null`,
		$smoothness = `2`,
		$corners = `255`
	)

Returns an image with round corners

You can either set the corners' color or set them transparent.

Note on $smoothness: 1 means jagged edges, 2 is much better, more than 4 doesn't noticeably improve the quality. Rendering becomes increasingly slower if you increase smoothness.

Example: $nice = $ugly->roundCorners(20, $ugly->allocateColor(255, 0, 0), 2);

Use $corners parameter to specify which corners to draw rounded. Possible values are WideImage::SIDE_TOP_LEFT, WideImage::SIDE_TOP, WideImage::SIDE_TOP_RIGHT, WideImage::SIDE_RIGHT, WideImage::SIDE_BOTTOM_RIGHT, WideImage::SIDE_BOTTOM, WideImage::SIDE_BOTTOM_LEFT, WideImage::SIDE_LEFT, and WideImage::SIDE_ALL. You can specify any combination of corners with a + operation, see example below.

Example: $white = $image->allocateColor(255, 255, 255); $diagonal_corners = $image->roundCorners(15, $white, 2, WideImage::SIDE_TOP_LEFT + WideImage::SIDE_BOTTOM_RIGHT); $right_corners = $image->roundCorners(15, $white, 2, WideImage::SIDE_RIGHT);

Parameters

int	$radius	Radius of the corners
int	$color	The color of corners. If null, corners are rendered transparent (slower than using a solid color).
int	$smoothness	Specify the level of smoothness. Suggested values from 1 to 4.
int	$corners	Specify which corners to draw (defaults to WideImage::SIDE_ALL = all corners)

Returns: \WideImage\Image The resulting image with round corners

◆ saveToFile()

saveToFile ( $uri )

Saves an image to a file

The file type is recognized from the $uri. If you save to a GIF8, truecolor images are automatically converted to palette.

This method supports additional parameters: quality (for jpeg images) and compression quality and filters (for png images). See http://www.php.net/imagejpeg and http://www.php.net/imagepng for details.

Examples: // save to a GIF $image->saveToFile('image.gif');

// save to a PNG with compression=7 and no filters $image->saveToFile('image.png', 7, PNG_NO_FILTER);

// save to a JPEG with quality=80 $image->saveToFile('image.jpg', 80);

// save to a JPEG with default quality=100 $image->saveToFile('image.jpg');

Parameters

string $uri File location

◆ setColorAt()

setColorAt	(	$x,
		$y,
		$color
	)

Set the color index $color to a pixel at $x, $y

Parameters

int	$x
int	$y
int	$color	Color index

◆ setRGBAt()

setRGBAt	(	$x,
		$y,
		$color
	)

Writes a pixel at the designated coordinates

Takes an associative array of colours and uses getExactColor() to retrieve the exact index color to write to the image with.

Parameters

int	$x
int	$y
array	$color

◆ setTransparentColor()

setTransparentColor ( $color )

Sets the current transparent color index. Only makes sense for palette images (8-bit).

Parameters

int $color Transparent color index

◆ unsharp()

unsharp	(	$amount,
		$radius,
		$threshold
	)

Applies the unsharp filter

Parameters

float	$amount
float	$radius
float	$threshold

Returns: \WideImage\Image Unsharpened copy of the image

◆ writeHeader()

writeHeader	(	$name,
		$data
	)

protected

Output a header to browser.

Parameters

$name	Name of the header
$data	Data

Field Documentation

◆ $canvas

$canvas = null

protected

◆ $handle

$handle = null

protected

◆ $handleReleased

$handleReleased = false

protected

◆ $sdata

$sdata = null

protected

The documentation for this class was generated from the following file:

C:/xoops2511b2/htdocs/class/libraries/vendor/smottt/wideimage/lib/WideImage/Image.php

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ __construct()

◆ __destruct()

Member Function Documentation

◆ __call()

◆ __sleep()

◆ __toString()

◆ __wakeup()

◆ addNoise()

◆ allocateColor()

◆ applyConvolution()

◆ applyFilter()

◆ applyMask()

◆ asGrayscale()

◆ asNegative()

◆ asPalette()

◆ asString()

◆ asTrueColor()

◆ autoCrop()

◆ copy()

◆ copyNoAlpha()

◆ copyTo()

◆ copyTransparencyFrom()

◆ correctGamma()

◆ crop()

◆ destroy()

◆ fill()

◆ flip()

◆ getCanvas()

◆ getChannels()

◆ getClosestColor()

◆ getColorAt()

◆ getColorRGB()

◆ getExactColor()

◆ getHandle()

◆ getHeight()

◆ getMask()

◆ getOperation()

◆ getRGBAt()

◆ getTransparentColor()

◆ getTransparentColorRGB()

◆ getWidth()

◆ isTransparent()

◆ isTrueColor()

◆ isValid()

◆ merge()

◆ mirror()

◆ output()

◆ releaseHandle()

◆ resize()

◆ resizeCanvas()

◆ resizeDown()

◆ resizeUp()

◆ rotate()

◆ roundCorners()

◆ saveToFile()

◆ setColorAt()

◆ setRGBAt()

◆ setTransparentColor()

◆ unsharp()

◆ writeHeader()

Field Documentation

◆ $canvas

◆ $handle

◆ $handleReleased

◆ $sdata