++ed by:

37 PAUSE users
19 non-PAUSE users.

Tony Cook
i_img_dim =category Data Types =synopsis i_img_dim x, y; =order 90

A signed integer type that represents an image dimension or ordinate.

May be larger than int on some platforms.

i_color =category Data Types =synopsis i_color black; =synopsis black.rgba.r = black.rgba.g = black.rgba.b = black.rgba.a = 0;

Type for 8-bit/sample color.

Samples as per;

  i_color c;

i_color is a union of:

  • gray - contains a single element gray_color, eg. c.gray.gray_color

  • rgb - contains three elements r, g, b, eg. c.rgb.r

  • rgba - contains four elements r, g, b, a, eg. c.rgba.a

  • cmyk - contains four elements c, m, y, k, eg. c.cmyk.y. Note that Imager never uses CMYK colors except when reading/writing files.

  • channels - an array of four channels, eg c.channels[2].

i_fcolor =category Data Types

This is the double/sample color type.

Its layout exactly corresponds to i_color.

i_img =category Data Types =synopsis i_img *img; =order 10

This is Imager's image type.

It contains the following members:

  • channels - the number of channels in the image

  • xsize, ysize - the width and height of the image in pixels

  • bytes - the number of bytes used to store the image data. Undefined where virtual is non-zero.

  • ch_mask - a mask of writable channels. eg. if this is 6 then only channels 1 and 2 are writable. There may be bits set for which there are no channels in the image.

  • bits - the number of bits stored per sample. Should be one of i_8_bits, i_16_bits, i_double_bits.

  • type - either i_direct_type for direct color images, or i_palette_type for paletted images.

  • virtual - if zero then this image is-self contained. If non-zero then this image could be an interface to some other implementation.

  • idata - the image data. This should not be directly accessed. A new image implementation can use this to store its image data. i_img_destroy() will myfree() this pointer if it's non-null.

  • tags - a structure storing the image's tags. This should only be accessed via the i_tags_*() functions.

  • ext_data - a pointer for use internal to an image implementation. This should be freed by the image's destroy handler.

  • im_data - data internal to Imager. This is initialized by i_img_init().

  • i_f_ppix, i_f_ppixf, i_f_plin, i_f_plinf, i_f_gpix, i_f_gpixf, i_f_glin, i_f_glinf, i_f_gsamp, i_f_gampf - implementations for each of the required image functions. An image implementation should initialize these between calling i_img_alloc() and i_img_init().

  • i_f_gpal, i_f_ppal, i_f_addcolors, i_f_getcolors, i_f_colorcount, i_f_maxcolors, i_f_findcolor, i_f_setcolors - implementations for each paletted image function.

  • i_f_destroy - custom image destruction function. This should be used to release memory if necessary.

  • i_f_gsamp_bits - implements i_gsamp_bits() for this image.

  • i_f_psamp_bits - implements i_psamp_bits() for this image.

  • i_f_psamp - implements psamp() for this image.

  • i_f_psampf - implements psamp() for this image.

  • im_data - image specific data internal to Imager.

  • context - the Imager API context this image belongs to.

i_fill_t =category Data Types =synopsis i_fill_t *fill;

This is the "abstract" base type for Imager's fill types.

Unless you're implementing a new fill type you'll typically treat this as an opaque type.

i_mutex_t =category mutex =synopsis i_mutex_t mutex;

Opaque type for Imager's mutex API.

i_DF =category Data Types =synopsis printf("left %" i_DF "\n", i_DFc(x)); =order 95

This is a constant string that can be used with functions like printf() to format i_img_dim values after they're been cast with i_DFc().

Does not include the leading %.

i_DFc =category Data Types =order 95

Cast an i_img_dim value to a type for use with the i_DF format string.

i_DFp =category Data Types =synopsis printf("point (" i_DFp ")\n", i_DFcp(x, y)); =order 95

Format a pair of i_img_dim values. This format string does include the leading %.

i_DFcp =category Data Types =order 95

Casts two i_img_dim values for use with the i_DF (or i_DFp) format.

1 POD Error

The following errors were encountered while parsing the POD:

Around line 31:

'=item' outside of any '=over'

=over without closing =back