| d246d8 | 2000-06-01 | Martin Nilsson | | <h2>Image cache attributes</h2>
All examples are made for the <cimg> tag.
<attr name='format' value='gif|jpeg|png|avs|gmp|bd|hrz|ilbm|psx|pnm|ps|pvr|tga|tiff|wbf|xbm|xpm' default='gif'>
The format to encode the image to. The formats available are:
<table>
<tr><td>gif</td><td>Graphics Interchange Format (might be missing in your roxen)</td></tr>
<tr><td>jpeg</td><td>Joint Photography Expert Group image compression</td></tr>
<tr><td>png</td><td>Portable Networks Graphics</td></tr>
<tr><td>avs</td><td></td></tr>
<tr><td>bmp</td><td>Windows BitMaP file</td></tr>
<tr><td>gd</td><td></td></tr>
<tr><td>hrz</td><td>HRZ is (was?) used for amatuer radio slow-scan TV.</td></tr>
<tr><td>ilbm</td><td></td></tr>
<tr><td>pcx</td><td>Zsoft PCX file format (PC / DOS)</td></tr>
<tr><td>pnm</td><td>Portable AnyMap</td></tr>
<tr><td>ps</td><td>Adobe PostScript file</td></tr>
<tr><td>pvr</td><td>Pover VR (dreamcast image)</td></tr>
<tr><td>tga</td><td>TrueVision Targa (PC / DOS)</td></tr>
<tr><td>tiff</td><td>Tag Image File Format</td></tr>
<tr><td>wbf</td><td>WAP Bitmap File</td></tr>
<tr><td>xbm</td><td>XWindows Bitmap File</td></tr>
<tr><td>xpm</td><td>XWindows Pixmap File</td></tr>
</table>
<ex>
<### format='png'/>
</ex>
<ex>
<### format='gif'/>
</ex>
</attr>
<attr name='quant' value='number' default='format dependant'>
The number of colors to quantizize the image to.
<p>
Default for gif is 32(+1 transparent), for most other formats
(except black and white) is it unlimited.</p>
<ex>
<### quant='2'/>
</ex>
</attr>
<h3>Color/alpha attributes</h3>
<attr name='dither' value='none|random|floyd-steinberg' default='none'>
Choose the dithering method.
<table>
<tr><td>none</td><td>No dithering is performed at all.</td></tr>
<tr><td>random</td><td>Random scatter dither. Not visually pleasing, but it is useful for very high resolution printing.</td></tr>
<tr><td>floyd-steinberg</td><td>Error diffusion dithering. Usually the best dithering method.</td></tr>
</table>
<ex>
<### dither='random' quant='10'/>
</ex>
<ex>
<### dither='floyd-steinberg' quant='10'/>
</ex>
</attr>
<attr name='true-alpha'>
If present, render a real alpha channel instead of on/off alpha. If
the file format only supports on/off alpha, the alpha channel is
dithered using a floyd-steinberg dither.
<ex>
<### opaque-value='20'/>
</ex>
<ex>
<### opaque-value='20' true-alpha='1'/>
</ex>
</attr>
<attr name='background-color' value='color' default='taken from the page'>
The color to render the image against.
<ex>
<### background-color='red' opaque-value='50'/>
</ex>
</attr>
<attr name='opaque-value' value='percentage' default='100'>
The transparency value to use, 100 is fully opaque, and 0 is fully
transparent.
</attr>
<attr name='cs-rgb-hsv' value='0|1' default='0'>
Perform rgb to hsv colorspace conversion.
<ex>
<### cs-rgb-hsv='1'/>
</ex>
</attr>
<attr name='gamma' value='number' default='1.0'>
Perform gamma adjustment.
<ex>
<### gamma='0.5'/>
</ex>
<ex>
<### gamma='1.5'/>
</ex>
</attr>
<attr name='cs-grey' value='0|1' default='0'>
Perform rgb to greyscale colorspace conversion.
<ex>
<### cs-grey='1'/>
</ex>
</attr>
<attr name='cs-invert' value='0|1' default='0'>
Invert all colors
<ex>
<### cs-invert='1'/>
</ex>
</attr>
<attr name='cs-hsv-rgb' value='0|1' default='0'>
Perform hsv to rgb colorspace conversion.
<ex>
<### cs-hsv-rgb='1'/>
</ex>
</attr>
<h3>Transform attributes</h3>
<attr name='rotate-cw' value='degree' default='0'>
Rotate the image clock-wise.
<ex>
<### rotate-cw='20'/>
</ex>
</attr>
<attr name='rotate-ccw' value='degree' default='0'>
Rotate the image counter clock-wise.
</attr>
<attr name='rotate-unit' value='rad|deg|ndeg|part' default='deg'>
Select the unit to use while rotating.
<table>
<tr><td>rad</td><td>Radians</td></tr>
<tr><td>deg</td><td>Degrees</td></tr>
<tr><td>ndeg</td><td>'New' degrees (400 for each full rotation)</td></tr>
<tr><td>part</td><td>0 - 1.0 (1.0 == full rotation)</td></tr>
</table>
</attr>
<attr name='mirror-x' value='0|1' default='0'>
Mirror the image around the X-axis.
</attr>
<attr name='mirror-y' value='0|1' default='0'>
Mirror the image around the Y-axis.
</attr>
<attr name='scale' value='fact' default='1.0'>
Scale fact times. (0.5 -> half size, 2.0 -> double size)
<ex>
<### scale='0.5'/>
</ex>
</attr>
<attr name='scale' value='x,y'>
Scale to the exact size x,y. If either of X or Y is zero, the image
is scaled to the specified width or hight, and the value that is zero
is scaled in proportion to the other value.
<ex>
<### scale='20,50'/>
</ex>
</attr>
<attr name='max-width' value='xsize'>
If width is larger than 'xsize', scale width to 'xsize' while
keeping aspect.
</attr>
<attr name='max-height' value='ysize'>
If width is larger than 'ysize', scale width to 'ysize' while
keeping aspect.
</attr>
<attr name='x-offset' value='pixels' default='0'>
Cut n pixels from the beginning of the X scale.
<ex>
<### x-offset='100'/>
</ex>
</attr>
<attr name='y-offset' value='pixels' default='0'>
Cut n pixels from the beginning of the Y scale.
</attr>
<attr name='x-size' value='pixels' default='whole image'>
Keep n pixels from the beginning of the X scale.
<ex>
<### x-size='100'/>
</ex>
</attr>
<attr name='y-size' value='pixels' default='whole image'>
Keep n pixels from the beginning of the Y scale.
</attr>
<attr name=crop value='x0,y0-x1,y1' default='whole image'>
Crop the image by specifying the pixel coordinates.
<ex>
<### crop='50,28-150,92'/>
</ex>
</attr>
<h3>Format specific attributes</h3>
<attr name='jpeg-quality' value='percentage' default='75'>
Set the quality on the output jpeg image.
<ex>
<### format='jpeg' jpeg-quality='30'/>
</ex>
<ex>
<### format='jpeg' jpeg-quality='1'/>
</ex>
</attr>
<attr name='jpeg-optimize' value='0|1' default='1'>
If 0, do not generate optimal tables. Somewhat faster, but produces
bigger files.
</attr>
<attr name='jpeg-progressive=' value='0|1' default='0'>
Generate progressive jpeg images.
</attr>
<attr name='jpeg-smooth' value='0-100' default='0'>
Smooth the image while compressing it. This produces smaller files,
but might undo the effects of dithering.
</attr>
<attr name='bmp-bpp' value='1,4,8,24' default='24'>
Force this number of bits per pixel for bmp images.
</attr>
<attr name='bmp-windows' value='0|1' default='1'>
Windows or OS/2 mode, default is 1. (windows mode)
</attr>
<attr name='bmp-rle' value='0|1' default='0'>
RLE 'compress' the BMP image.
</attr>
<attr name='gd-alpha_index' value='color' default='0'>
Color in the colormap to make transparent for GD-images with alpha
channel.
</attr>
<attr name='pcx-raw' value='1|0' default='0'>
If 1, do not RLE encode the PCX image.
</attr>
<attr name='pcx-dpy' value='0-10000000.0' default='75.0'>
Resolution, in pixels per inch.
</attr>
<attr name='pcx-xdpy' value='0-10000000.0' default='75.0'>
Resolution, in pixels per inch.
</attr>
<attr name='pcx-ydpy' value='0-10000000.0' default='75.
Resolution, in pixels per inch.
</attr>
<attr name='pcx-xoffset' value='0-imagexsize-2' default='0'>
Offset from start of image data to image content for PCX images.
Unused by most programs.
</attr>
<attr name='pcx-yoffset' value='0-imageysize-2' default='0'>
Offset from start of image data to image content for PCX images.
Unused by most programs.
</attr>
<attr name='tga-raw' value='1|0' default='0'>
If 1, do not RLE encode the Targa image.
</attr>
<attr name='ps-dpi' value='0-10000000.0' default='75.0'>
Dots per inch for the resulting postscript file.
</attr>>
|