Header Header

gximage.h File Reference

Detailed Description

Image handling interface

The GX is the base system for the majority of the ARH Inc. products. It is a collection of loadable modules and library functions and gives an ease to program interface to the hardware devices.

This file contains the descriptions of classes and functions of the image handling module.

Go to the source code of this file.

Classes

struct  gxIMAGE
 Structure which stores data of an image. More...
class  gxImageData
 Class for the IMAGE data and some low-level functions. More...
class  gxImageHandler
 Class for the IMAGE functions. More...
class  gxImage
 Class for the IMAGE functions. More...

Enumerations

enum  GX_PIXELFORMATS {
  GX_UNDEF = 0x0000,
  GX_GRAY = 0x0001,
  GX_RGB555 = 0x0002,
  GX_BGR555 = 0x0003,
  GX_RGB565 = 0x0004,
  GX_BGR565 = 0x0005,
  GX_RGB = 0x0006,
  GX_BGR = 0x0007,
  GX_RGBA = 0x0008,
  GX_BGRA = 0x0009,
  GX_YUV422 = 0x000A,
  GX_GRAY12 = 0x000B,
  GX_RGB12 = 0x000C,
  GX_BGR12 = 0x000D,
  GX_GBRG = 0x000E,
  GX_BGGR = 0x000F,
  GX_RGGB = 0x0010,
  GX_GRBG = 0x0011,
  GX_FORMAT_FIRST = GX_GRAY,
  GX_FORMAT_LAST = GX_GRBG
}
 Enumerations for pixel format. More...
enum  GX_IMGFILEFORMATS {
  GX_BMP = 1,
  GX_JPEG = 2,
  GX_JPEG2K_JPC = 3,
  GX_JPEG2K_JP2 = 4,
  GX_JPEG2K = GX_JPEG2K_JP2,
  GX_RAW = 5,
  GX_PNG = 6,
  GX_WSQ = 7
}
 Enumerations for image file format. More...
enum  GX_MIRRORFLAGS {
  GX_MIRROR_NOMIRROR = 0,
  GX_MIRROR_HORIZONTAL = 1,
  GX_MIRROR_VERTICAL = 2
}
 Enumerations for mirror operations. More...
enum  GX_ZOOMMODES {
  GX_ZOOM_NEAREST = 0,
  GX_ZOOM_LINEAR = 1
}
 Enumerations for zoom modes. More...
enum  GX_QUICKCONVERT {
  GX_CONVERT_NORMAL = 0,
  GX_CONVERT_QUICK = 1
}
 Enumerations for quick convert. More...
enum  GX_QUICKDISPLAY {
  GX_DISPLAY_NORMAL = 0,
  GX_DISPLAY_QUICK = 1
}
 Enumerations for quick display. More...
enum  GX_IMAGECOMMENTS {
  GX_IMGCOMM_GENERAL = 0,
  GX_IMGCOMM_JPEG_APP0,
  GX_IMGCOMM_JPEG_APP1,
  GX_IMGCOMM_JPEG_APP2,
  GX_IMGCOMM_JPEG_APP3,
  GX_IMGCOMM_JPEG_APP4,
  GX_IMGCOMM_JPEG_APP5,
  GX_IMGCOMM_JPEG_APP6,
  GX_IMGCOMM_JPEG_APP7,
  GX_IMGCOMM_JPEG_APP8,
  GX_IMGCOMM_JPEG_APP9,
  GX_IMGCOMM_JPEG_APP10,
  GX_IMGCOMM_JPEG_APP11,
  GX_IMGCOMM_JPEG_APP12,
  GX_IMGCOMM_JPEG_APP13,
  GX_IMGCOMM_JPEG_APP14,
  GX_IMGCOMM_JPEG_APP15,
  GX_IMGCOMM_INVALIDFORMAT
}
 Enumerations for image comments. More...
enum  GX_IMAGEPROPERTIES1 {
  GX_IMGPROP_BMP_FORCE24BPP = GX_CALL_GROUP_GX_BMP,
  GX_IMGPROP_BMP_ENABLERLE,
  GX_IMGPROP_JPEG_SCALE_NUM = GX_CALL_GROUP_GX_JPEG,
  GX_IMGPROP_JPEG_SCALE_DENOM,
  GX_IMGPROP_JPEG_DCT_METHOD,
  GX_IMGPROP_JPEG_DO_FANCY_UPSAMPLING,
  GX_IMGPROP_JPEG_DO_BLOCK_SMOOTHING,
  GX_IMGPROP_JPEG_QUALITY,
  GX_IMGPROP_JPEG_PROGRESSIVE,
  GX_IMGPROP_JPEG_OPTIMIZE_CODING,
  GX_IMGPROP_JPEG_RESTART_INTERVAL,
  GX_IMGPROP_JPEG_RESTART_IN_ROWS,
  GX_IMGPROP_JPEG_SMOOTHING_FACTOR,
  GX_IMGPROP_JPEG2K_IMGAREATLX = GX_CALL_GROUP_GX_JPEG2K,
  GX_IMGPROP_JPEG2K_IMGAREATLY,
  GX_IMGPROP_JPEG2K_TILEGRDTLX,
  GX_IMGPROP_JPEG2K_TILEGRDTLY,
  GX_IMGPROP_JPEG2K_TILEWIDTH,
  GX_IMGPROP_JPEG2K_TILEHEIGHT,
  GX_IMGPROP_JPEG2K_PRCWIDTH,
  GX_IMGPROP_JPEG2K_PRCHEIGHT,
  GX_IMGPROP_JPEG2K_CBLKWIDTH,
  GX_IMGPROP_JPEG2K_CBLKHEIGHT,
  GX_IMGPROP_JPEG2K_MODE,
  GX_IMGPROP_JPEG2K_RATE,
  GX_IMGPROP_JPEG2K_ILYRRATES,
  GX_IMGPROP_JPEG2K_PRG,
  GX_IMGPROP_JPEG2K_NOMCT,
  GX_IMGPROP_JPEG2K_NUMRLVLS,
  GX_IMGPROP_JPEG2K_SOP,
  GX_IMGPROP_JPEG2K_EPH,
  GX_IMGPROP_JPEG2K_LAZY,
  GX_IMGPROP_JPEG2K_TERMALL,
  GX_IMGPROP_JPEG2K_SEGSYM,
  GX_IMGPROP_JPEG2K_VCAUSAL,
  GX_IMGPROP_JPEG2K_PTERM,
  GX_IMGPROP_JPEG2K_RESETPROB,
  GX_IMGPROP_JPEG2K_NUMGBITS,
  GX_IMGPROP_WSQ_BITRATE = GX_CALL_GROUP_GX_WSQ
}
 Enumerations for image properties. More...

Functions

gxi32 gx_getpixelsize (gxHANDLE handle, gxi32 *size, gxi32 format)
 Returns the size of a pixel in bytes.
gxi32 gx_convertpixels (gxHANDLE handle, void *target, gxi32 tformat, gxi32 tsline, const void *source, gxi32 sformat, gxi32 ssline, gxi32 xsize, gxi32 ysize)
 Converts pixels to a specified format and size.
gxi32 gx_fastreconvert (gxHANDLE handle, void *pixels, gxi32 tformat, gxi32 sformat, gxi32 sline, gxi32 xsize, gxi32 ysize)
 Fast converts pixels to a specified format and size.
gxi32 gx_zoompixels (gxHANDLE handle, void *target, gxi32 tsline, gxi32 txsize, gxi32 tysize, const void *source, gxi32 ssline, gxi32 sxsize, gxi32 sysize, gxi32 format, gxi32 sx1_8=0, gxi32 sy1_8=0, gxi32 sx2_8=0, gxi32 sy2_8=0)
 Zooms pixels to a specified size.
gxi32 gx_rotatepixels (gxHANDLE handle, void *target, gxi32 tsline, gxi32 txsize, gxi32 tysize, const void *source, gxi32 ssline, gxi32 sxsize, gxi32 sysize, gxi32 format, gxi32 degree)
 Rotates pixels to a specified degree.
gxi32 gx_mirrorpixels (gxHANDLE handle, void *target, gxi32 tsline, gxi32 txsize, gxi32 tysize, const void *source, gxi32 ssline, gxi32 sxsize, gxi32 sysize, gxi32 format, gxi32 flags)
 Mirrors pixels to a specified mode.
gxi32 gx_mirrorpixels (gxHANDLE handle, void *pixels, gxi32 sline, gxi32 xsize, gxi32 ysize, gxi32 format, gxi32 flags)
 Mirrors pixels to a specified mode.
gxi32 gx_initimage (gxHANDLE handle, gxIMAGE *pimage)
 Initialization of an image located on the heap or stack.
gxi32 gx_allocimage (gxHANDLE handle, gxIMAGE **pimage)
 This function allocates a blank image.
gxi32 gx_freeimage (gxHANDLE handle, gxIMAGE *pimage)
 Frees an image structure including the allocated pixel data.
gxi32 gx_refimage (gxHANDLE handle, gxIMAGE *pimage)
 Increases the image reference counter.
gxi32 gx_unrefimage (gxHANDLE handle, gxIMAGE *pimage)
 Decreases the image reference counter.
gxi32 gx_createimage (gxHANDLE handle, gxIMAGE *pimage, gxi32 format, gxi32 xsize, gxi32 ysize, gxi32 sline)
 Makes an image with proper size and format running on an initialized image structure.
gxi32 gx_convertimage (gxHANDLE handle, gxIMAGE *pdest, gxIMAGE *psrc, gxi32 format, gxi32 xsize, gxi32 ysize, gxi32 sline)
 Converts an image to a specific format and size.
gxi32 gx_zoomimage (gxHANDLE handle, gxIMAGE *pdest, gxi32 xsize, gxi32 ysize, gxi32 sline, gxIMAGE *psrc, gxi32 sx1_8=0, gxi32 sy1_8=0, gxi32 sx2_8=0, gxi32 sy2_8=0)
 Zooms an image to a specified size.
gxi32 gx_rotateimage (gxHANDLE handle, gxIMAGE *pdest, gxIMAGE *psrc, gxi32 degree)
 Rotates an image to a specified degree.
gxi32 gx_mirrorimage (gxHANDLE handle, gxIMAGE *pdest, gxIMAGE *psrc, gxi32 flags)
 Mirrors an image to a specified mode.
gxi32 gx_mirrorimage (gxHANDLE handle, gxIMAGE *pimage, gxi32 flags)
 Mirrors an image to a specified mode.
gxi32 gx_loadimage (gxHANDLE handle, gxIMAGE *pimage, const wchar_t *filename, gxi32 pixelformat=GX_UNDEF)
 Loads an image from a mass storage device and converts it to a specific pixel format (Unicode version).
gxi32 gx_loadimagea (gxHANDLE handle, gxIMAGE *pimage, const char *filename, gxi32 pixelformat=GX_UNDEF)
 Loads an image from a mass storage device and converts it to a specific pixel format (ASCII version).
gxi32 gx_loadimage (gxHANDLE handle, gxIMAGE *pimage, const char *filename, gxi32 pixelformat=GX_UNDEF)
 Loads an image from a mass storage device and converts it to a specific pixel format (ASCII version).
gxi32 gx_saveimage (gxHANDLE handle, gxIMAGE *pimage, const wchar_t *filename, gxi32 fileformat)
 Saves an image to a mass storage device in the specific file format (Unicode version).
gxi32 gx_saveimagea (gxHANDLE handle, gxIMAGE *pimage, const char *filename, gxi32 fileformat)
 Saves an image to a mass storage device in the specific file format (ASCII version).
gxi32 gx_saveimage (gxHANDLE handle, gxIMAGE *pimage, const char *filename, gxi32 fileformat)
 Saves an image to a mass storage device in the specific file format (ASCII version).
gxi32 gx_loadfrommem (gxHANDLE handle, gxIMAGE *pimage, const void *buffer, gxi32 buflen, gxi32 pixelformat=GX_UNDEF)
 Loads an image from the memory and converts it to a specific pixel format.
gxi32 gx_savetomem (gxHANDLE handle, gxIMAGE *pimage, void **buffer, gxi32 *buflen, gxi32 fileformat)
 Saves an image in a specific file format to a specific memory area.
gxi32 gx_isvalidimage (gxHANDLE handle, const gxIMAGE *pimage)
 Checks if image structure is valid.
gxi32 gx_copyimage (gxHANDLE handle, gxIMAGE *target, gxIMAGE *source)
 Copies an image to another.
gxi32 gx_testimagefileformat (gxHANDLE handle, const wchar_t *filename, gxi32 *fileformat)
 Tests if a file is an image file.
gxi32 gx_testimagefileformata (gxHANDLE handle, const char *filename, gxi32 *fileformat)
 Tests if a file is an image file.
gxi32 gx_testimagefileformat (gxHANDLE handle, const char *filename, gxi32 *fileformat)
 Tests if a file is an image file.
gxi32 gx_testimagefileformatmem (gxHANDLE handle, const void *buffer, gxi32 buflen, gxi32 *fileformat)
 Tests if a memory area contains an image file.
gxi32 gx_testimagefileformatid (gxHANDLE handle, const wchar_t *filename, wchar_t *formatid, gxi32 slen)
 Tests if a file is an image file.
gxi32 gx_testimagefileformatidmem (gxHANDLE handle, const void *buffer, gxi32 buflen, wchar_t *formatid, gxi32 slen)
 Tests if a memory area contains an image file.
gxi32 gx_testimagefileformat (gxHANDLE handle, const void *buffer, gxi32 buflen, gxi32 *fileformat)
 Tests if a memory area contains an image file.
gxi32 gx_imagetovariant (gxHANDLE handle, gxIMAGE *source, gxi32 varid, gxVARIANT *target)
 Embedds an image into a variant.
gxi32 gx_imagefromvariant (gxHANDLE handle, gxIMAGE **target, gxVARIANT source)
 Loads an embedded image from a variant.
void * gx_getpixelptr (gxHANDLE handle, gxIMAGE *pimage, gxi32 x, gxi32 y)
 Returns the pointer of the pixel.
gxi32 gx_getpixelsize (gxi32 *size, gxi32 format)
 Gets size of a pixel in bytes.
gxi32 gx_convertpixels (void *target, gxi32 tformat, gxi32 tsline, const void *source, gxi32 sformat, gxi32 ssline, gxi32 xsize, gxi32 ysize)
 Converts pixels to a specified format and size.
gxi32 gx_fastreconvert (void *pixels, gxi32 tformat, gxi32 sformat, gxi32 sline, gxi32 xsize, gxi32 ysize)
 Fast converts pixels to a specified format and size.
gxi32 gx_zoompixels (void *target, gxi32 tsline, gxi32 txsize, gxi32 tysize, const void *source, gxi32 ssline, gxi32 sxsize, gxi32 sysize, gxi32 format, gxi32 sx1_8=0, gxi32 sy1_8=0, gxi32 sx2_8=0, gxi32 sy2_8=0)
 Zooms pixels to a specified size.
gxi32 gx_rotatepixels (void *target, gxi32 tsline, gxi32 txsize, gxi32 tysize, const void *source, gxi32 ssline, gxi32 sxsize, gxi32 sysize, gxi32 format, gxi32 degree)
 Rotates pixels to a specified degree.
gxi32 gx_mirrorpixels (void *target, gxi32 tsline, gxi32 txsize, gxi32 tysize, const void *source, gxi32 ssline, gxi32 sxsize, gxi32 sysize, gxi32 format, gxi32 flags)
 Mirrors pixels to a specified mode.
gxi32 gx_mirrorpixels (void *pixels, gxi32 sline, gxi32 xsize, gxi32 ysize, gxi32 format, gxi32 flags)
 Mirrors pixels to a specified mode.
gxi32 gx_initimage (gxIMAGE *pimage)
 Initialization of an image located on a heap or a stack.
gxi32 gx_allocimage (gxIMAGE **pimage)
 This function allocates a blank image.
gxi32 gx_freeimage (gxIMAGE *pimage)
 Frees an image structure including the allocated pixel data.
gxi32 gx_refimage (gxIMAGE *pimage)
 Increases the image reference counter.
gxi32 gx_unrefimage (gxIMAGE *pimage)
 Decreases the image reference counter.
gxi32 gx_createimage (gxIMAGE *pimage, gxi32 format, gxi32 xsize, gxi32 ysize, gxi32 sline)
 Makes an image with proper size and format running on an initialized image structure.
gxi32 gx_convertimage (gxIMAGE *pdest, gxIMAGE *psrc, gxi32 format, gxi32 xsize, gxi32 ysize, gxi32 sline)
 Converts an image to a specific format and size.
gxi32 gx_zoomimage (gxIMAGE *pdest, gxi32 xsize, gxi32 ysize, gxi32 sline, gxIMAGE *psrc, gxi32 sx1_8=0, gxi32 sy1_8=0, gxi32 sx2_8=0, gxi32 sy2_8=0)
 Zooms an image to a specified size.
gxi32 gx_rotateimage (gxIMAGE *pdest, gxIMAGE *psrc, gxi32 degree)
 Rotates an image to a specified degree.
gxi32 gx_mirrorimage (gxIMAGE *pdest, gxIMAGE *psrc, gxi32 flags)
 Mirrors an image to a specified mode.
gxi32 gx_mirrorimage (gxIMAGE *pimage, gxi32 flags)
 Mirrors an image to a specified mode.
gxi32 gx_loadimage (gxIMAGE *pimage, const wchar_t *filename, gxi32 pixelformat=GX_UNDEF)
 Loads an image from a mass storage device and converts it to a specific pixel format (Unicode version).
gxi32 gx_loadimage (gxIMAGE *pimage, const char *filename, gxi32 pixelformat=GX_UNDEF)
 Loads an image from a mass storage device and converts it to a specific pixel format (ASCII version).
gxi32 gx_saveimage (gxIMAGE *pimage, const wchar_t *filename, gxi32 fileformat)
 Saves an image to a mass storage device in the specific file format (Unicode version).
gxi32 gx_saveimage (gxIMAGE *pimage, const char *filename, gxi32 fileformat)
 Saves an image to a mass storage device in the specific file format (ASCII version).
gxi32 gx_loadfrommem (gxIMAGE *pimage, const void *buffer, gxi32 buflen, gxi32 pixelformat=GX_UNDEF)
 Loads an image from the memory and converts it to a specific pixel format.
gxi32 gx_savetomem (gxIMAGE *pimage, void **buffer, gxi32 *buflen, gxi32 fileformat)
 Saves an image in a specific file format to a specific memory area.
gxi32 gx_isvalidimage (const gxIMAGE *pimage)
 Checks if image structure is valid.
gxi32 gx_copyimage (gxIMAGE *target, gxIMAGE *source)
 Copies an image to another.
gxi32 gx_imagetovariant (gxIMAGE *source, gxi32 varid, gxVARIANT *target)
 Embedds an image into a variant.
gxi32 gx_imagefromvariant (gxIMAGE **target, gxVARIANT source)
 Loads an embedded image from a variant.
gxi32 gx_loadimagefromfile (gxIMAGE *pimage, const wchar_t *filename, gxi32 pixelformat=GX_UNDEF, gxVARIANT properties=0, gxVARIANT comments=0)
 Loads an image with comments from a mass storage device and converts it to a specific pixel format (Unicode version).
gxi32 gx_loadimagefromfile (gxIMAGE *pimage, const char *filename, gxi32 pixelformat=GX_UNDEF, gxVARIANT properties=0, gxVARIANT comments=0)
 Loads an image with comments from a mass storage device and converts it to a specific pixel format (ASCII version).
gxi32 gx_saveimagetofile (gxIMAGE *pimage, const wchar_t *filename, gxi32 fileformat, gxVARIANT properties=0, gxVARIANT comments=0)
 Saves an image with comments to a mass storage device in the specific file format (Unicode version).
gxi32 gx_saveimagetofile (gxIMAGE *pimage, const char *filename, gxi32 fileformat, gxVARIANT properties=0, gxVARIANT comments=0)
 Saves an image with comments to a mass storage device in the specific file format (ASCII version).
gxi32 gx_saveimagetofile2 (gxHANDLE handle, gxIMAGE *pimage, const wchar_t *filename, const wchar_t *fileformat, gxVARIANT properties=0, gxVARIANT comments=0)
 Saves an image with comments to a mass storage device in the specific file format (Unicode version).
gxi32 gx_loadimagefrommem (gxIMAGE *pimage, const void *buffer, gxi32 buflen, gxi32 pixelformat=GX_UNDEF, gxVARIANT properties=0, gxVARIANT comments=0)
 Loads an image with comments from the memory and converts it to a specific pixel format.
gxi32 gx_saveimagetomem (gxIMAGE *pimage, void **buffer, gxi32 *buflen, gxi32 fileformat, gxVARIANT properties=0, gxVARIANT comments=0)
 Saves an image with comments in a specific file format to a specific memory area.
gxi32 gx_saveimagetomem2 (gxHANDLE handle, gxIMAGE *pimage, void **buffer, gxi32 *buflen, wchar_t *fileformat, gxVARIANT properties=0, gxVARIANT comments=0)
 Saves an image with comments in a specific file format to a specific memory area.
gxi32 gx_testimagefileformat (const wchar_t *filename, gxi32 *fileformat)
 Tests if a file is an image file.
gxi32 gx_testimagefileformat (const char *filename, gxi32 *fileformat)
 Tests if a file is an image file.
gxi32 gx_testimagefileformat (const void *buffer, gxi32 buflen, gxi32 *fileformat)
 Tests if a memory area contains an image file.
void * gx_getpixelptr (gxIMAGE *pimage, gxi32 x, gxi32 y)
 Returns the pointer of the pixel.

Enumeration Type Documentation

enum GX_PIXELFORMATS

Enumerations for pixel format.

Enumerator:
GX_UNDEF  Undefined format (for gx_loadimage() functions).
GX_GRAY  8 bit: 8 bit (grayscale)
GX_RGB555  16 bit: 1-5-5-5 bit (0,R,G,B)
GX_BGR555  16 bit: 1-5-5-5 bit (0,B,G,R)
GX_RGB565  16 bit: 5-6-5 bit (R,G,B)
GX_BGR565  16 bit: 5-6-5 bit (B,G,R)
GX_RGB  24 bit: 8-8-8 bit (R,G,B)
GX_BGR  24 bit: 8-8-8 bit (B,G,R)
GX_RGBA  32 bit: 8-8-8-8 bit (R,G,B,0)
GX_BGRA  32 bit: 8-8-8-8 bit (B,G,R,0)
GX_YUV422  32 bit/2 pixel: 8-8-8-8 bit (U,Y1,V,Y2)
GX_GRAY12  16 bit: 4-12 bit (0,grayscale)
GX_RGB12  48 bit: 4-12-4-12-4-12 bit (0,R,0,G,0,B)
GX_BGR12  48 bit: 4-12-4-12-4-12 bit (0,B,0,G,0,R)
GX_GBRG  32 bit/4 pixel: 8-8-8-8 bit Bayern-pattern (G,B,R,G)
GX_BGGR  32 bit/4 pixel: 8-8-8-8 bit Bayern-pattern (B,G,G,R)
GX_RGGB  32 bit/4 pixel: 8-8-8-8 bit Bayern-pattern (R,G,G,B)
GX_GRBG  32 bit/4 pixel: 8-8-8-8 bit Bayern-pattern (G,R,B,G)
GX_FORMAT_FIRST  First available pixel format.
GX_FORMAT_LAST  Last available pixel format.

enum GX_IMGFILEFORMATS

Enumerations for image file format.

Enumerator:
GX_BMP  BMP format.
GX_JPEG  JPEG format (ISO/IEC 10918-1).
GX_JPEG2K_JPC  JPEG-2000 Code stream syntax (ISO/IEC 15444-1).
GX_JPEG2K_JP2  JPEG-2000 JP2 format syntax (ISO/IEC 15444-1).
GX_JPEG2K  JPEG-2000 JP2 format syntax (ISO/IEC 15444-1).
GX_RAW  RAW format (uncompressed pixel data without header).
GX_PNG  PNG format (Portable Network Graphics).
GX_WSQ  WSQ format (Wavelet Scalar Quantization).

enum GX_MIRRORFLAGS

Enumerations for mirror operations.

Enumerator:
GX_MIRROR_NOMIRROR  No mirroring.
GX_MIRROR_HORIZONTAL  Horizontal mirroring.
GX_MIRROR_VERTICAL  Vertical mirroring.

enum GX_ZOOMMODES

Enumerations for zoom modes.

Enumerator:
GX_ZOOM_NEAREST  Nearest algorithm (faster than linear).
GX_ZOOM_LINEAR  Linear algorithm (better than nearest).

enum GX_QUICKCONVERT

Enumerations for quick convert.

Enumerator:
GX_CONVERT_NORMAL  Normal algorithm.
GX_CONVERT_QUICK  Quick algorithm.

enum GX_QUICKDISPLAY

Enumerations for quick display.

Enumerator:
GX_DISPLAY_NORMAL  Normal algorithm.
GX_DISPLAY_QUICK  Quick algorithm.

enum GX_IMAGECOMMENTS

Enumerations for image comments.

Enumerator:
GX_IMGCOMM_GENERAL  Type of the general image comment.

GX_IMGCOMM_JPEG_APP0  APP0 comment for jpeg applications.

GX_IMGCOMM_JPEG_APP1  APP1 comment for jpeg applications.

GX_IMGCOMM_JPEG_APP2  APP2 comment for jpeg applications.

GX_IMGCOMM_JPEG_APP3  APP3 comment for jpeg applications.

GX_IMGCOMM_JPEG_APP4  APP4 comment for jpeg applications.

GX_IMGCOMM_JPEG_APP5  APP5 comment for jpeg applications.

GX_IMGCOMM_JPEG_APP6  APP6 comment for jpeg applications.

GX_IMGCOMM_JPEG_APP7  APP7 comment for jpeg applications.

GX_IMGCOMM_JPEG_APP8  APP8 comment for jpeg applications.

GX_IMGCOMM_JPEG_APP9  APP9 comment for jpeg applications.

GX_IMGCOMM_JPEG_APP10  APP10 comment for jpeg applications.

GX_IMGCOMM_JPEG_APP11  APP11 comment for jpeg applications.

GX_IMGCOMM_JPEG_APP12  APP12 comment for jpeg applications.

GX_IMGCOMM_JPEG_APP13  APP13 comment for jpeg applications.

GX_IMGCOMM_JPEG_APP14  APP14 comment for jpeg applications.

GX_IMGCOMM_JPEG_APP15  APP15 comment for jpeg applications.

GX_IMGCOMM_INVALIDFORMAT  Invalid format signal at image loading.

enum GX_IMAGEPROPERTIES1

Enumerations for image properties.

Enumerator:
GX_IMGPROP_BMP_FORCE24BPP  Identifier for bmp/force24bpp property.

The BMP writer forces the 24 bit per pixel mode. It can be:

  • 0 : the indexed mode is used instead (default)
  • 1 : the writer uses 24 bit per pixel (RGB/BGR) mode (faster than indexed)
GX_IMGPROP_BMP_ENABLERLE  Identifier for bmp/enablerle property.

The BMP writer can use the RLE compression. It can be:

  • 0 : disables the RLE compression (faster, default)
  • 1 : enables the RLE compression
GX_IMGPROP_JPEG_SCALE_NUM  Identifier for jpeg/decompress/scale_num property.

GX_IMGPROP_JPEG_SCALE_DENOM  Identifier for jpeg/decompress/scale_denom property.

GX_IMGPROP_JPEG_DCT_METHOD  Identifier for jpeg/decompress/dct_method property.

GX_IMGPROP_JPEG_DO_FANCY_UPSAMPLING  Identifier for jpeg/decompress/do_fancy_unsampling property.

GX_IMGPROP_JPEG_DO_BLOCK_SMOOTHING  Identifier for jpeg/decompress/do_block_smoothing property.

GX_IMGPROP_JPEG_QUALITY  Identifier for jpeg/compress/quality property.

GX_IMGPROP_JPEG_PROGRESSIVE  Identifier for jpeg/compress/progressive property.

GX_IMGPROP_JPEG_OPTIMIZE_CODING  Identifier for jpeg/compress/optimize_coding property.

GX_IMGPROP_JPEG_RESTART_INTERVAL  Identifier for jpeg/compress/restart_interval property.

GX_IMGPROP_JPEG_RESTART_IN_ROWS  Identifier for jpeg/compress/restart_in_rows property.

GX_IMGPROP_JPEG_SMOOTHING_FACTOR  Identifier for jpeg/compress/smoothing_factor property.

GX_IMGPROP_JPEG2K_IMGAREATLX  Identifier for jpeg2k/imgareatlx property.

GX_IMGPROP_JPEG2K_IMGAREATLY  Identifier for jpeg2k/imgareatly property.

GX_IMGPROP_JPEG2K_TILEGRDTLX  Identifier for jpeg2k/tilegrdtlx property.

GX_IMGPROP_JPEG2K_TILEGRDTLY  Identifier for jpeg2k/tilegrdtly property.

GX_IMGPROP_JPEG2K_TILEWIDTH  Identifier for jpeg2k/tilewidth property.

GX_IMGPROP_JPEG2K_TILEHEIGHT  Identifier for jpeg2k/tileheight property.

GX_IMGPROP_JPEG2K_PRCWIDTH  Identifier for jpeg2k/prcwidth property.

GX_IMGPROP_JPEG2K_PRCHEIGHT  Identifier for jpeg2k/prcheight property.

GX_IMGPROP_JPEG2K_CBLKWIDTH  Identifier for jpeg2k/cblkwidth property.

GX_IMGPROP_JPEG2K_CBLKHEIGHT  Identifier for jpeg2k/cblkheight property.

GX_IMGPROP_JPEG2K_MODE  Identifier for jpeg2k/mode property.

GX_IMGPROP_JPEG2K_RATE  Identifier for jpeg2k/rate property.

GX_IMGPROP_JPEG2K_ILYRRATES  Identifier for jpeg2k/ilyrrates property.

GX_IMGPROP_JPEG2K_PRG  Identifier for jpeg2k/prg property.

GX_IMGPROP_JPEG2K_NOMCT  Identifier for jpeg2k/nomct property.

GX_IMGPROP_JPEG2K_NUMRLVLS  Identifier for jpeg2k/numrlvls property.

GX_IMGPROP_JPEG2K_SOP  Identifier for jpeg2k/sop property.

GX_IMGPROP_JPEG2K_EPH  Identifier for jpeg2k/eph property.

GX_IMGPROP_JPEG2K_LAZY  Identifier for jpeg2k/lazy property.

GX_IMGPROP_JPEG2K_TERMALL  Identifier for jpeg2k/termall property.

GX_IMGPROP_JPEG2K_SEGSYM  Identifier for jpeg2k/segsym property.

GX_IMGPROP_JPEG2K_VCAUSAL  Identifier for jpeg2k/vcausal property.

GX_IMGPROP_JPEG2K_PTERM  Identifier for jpeg2k/pterm property.

GX_IMGPROP_JPEG2K_RESETPROB  Identifier for jpeg2k/resetprob property.

GX_IMGPROP_JPEG2K_NUMGBITS  Identifier for jpeg2k/numgbits property.

GX_IMGPROP_WSQ_BITRATE  Identifier for WSQ bitrate property.

Function Documentation

gxi32 gx_getpixelsize ( gxHANDLE  handle,
gxi32 *  size,
gxi32  format 
) [inline]

Returns the size of a pixel in bytes.

See also:
GX_PARM_GETPIXELSIZE
Parameters:
handle Handle of the module.
size Size of the pixel format.
format Pixel format (see GX_PIXELFORMATS).
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

Referenced by gxImage::GetPixelSize(), and gx_getpixelsize().

gxi32 gx_convertpixels ( gxHANDLE  handle,
void *  target,
gxi32  tformat,
gxi32  tsline,
const void *  source,
gxi32  sformat,
gxi32  ssline,
gxi32  xsize,
gxi32  ysize 
) [inline]

Converts pixels to a specified format and size.

See also:
GX_PARM_CONVERTPIXELS
Parameters:
handle Handle of the module.
target Pointer to a pixel data to where the function stores the data.
tformat Pixel format of the target area (see GX_PIXELFORMATS).
tsline Size of a row of the target area in bytes.
source Pointer to a pixel data.
sformat Pixel format of the source area (see GX_PIXELFORMATS).
ssline Size of a row of the source area in bytes.
xsize Horizontal size of the pixel area.
ysize Vertical size of the pixel area.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

Referenced by gx_convertpixels().

gxi32 gx_fastreconvert ( gxHANDLE  handle,
void *  pixels,
gxi32  tformat,
gxi32  sformat,
gxi32  sline,
gxi32  xsize,
gxi32  ysize 
) [inline]

Fast converts pixels to a specified format and size.

The function is the same as gx_convertpixels(), only it works on the same memory area.

The fast reconvert function can be used for converting:
  • RGB555,BGR555,RGB565,BGR565 <-> RGB555,BGR555,RGB565,BGR565
  • RGB,BGR <-> RGB,BGR
  • RGBA,BGRA <-> RGBA,BGRA
  • RGB12,BGR12 <-> RGB12,BGR12
Parameters:
handle Handle of the module.
pixels Pointer to a pixel data.
tformat Pixel format of the destination image (see GX_PIXELFORMATS).
sformat Pixel format of the source image (see GX_PIXELFORMATS).
sline Size of a row of the pixel area in bytes.
xsize Horizontal size of the pixel area.
ysize Vertical size of the pixel area.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

Referenced by gx_fastreconvert().

gxi32 gx_zoompixels ( gxHANDLE  handle,
void *  target,
gxi32  tsline,
gxi32  txsize,
gxi32  tysize,
const void *  source,
gxi32  ssline,
gxi32  sxsize,
gxi32  sysize,
gxi32  format,
gxi32  sx1_8 = 0,
gxi32  sy1_8 = 0,
gxi32  sx2_8 = 0,
gxi32  sy2_8 = 0 
) [inline]

Zooms pixels to a specified size.

Parameters:
handle Handle of the module.
target Pointer to an allocated area where the zoom function places the converted image.
tsline Size of a row of the destination area.
txsize Horizontal size of the destination area.
tysize Vertical size of the destination area.
source Pointer to pixels of source area.
ssline Size of a row of the source area.
sxsize Horizontal size of the source area.
sysize Vertical size of the source area.
format Pixel format (see GX_PIXELFORMATS).
sx1_8 Left coordinate of zoom area (shifted left with 8 bit = 256)
sy1_8 Top coordinate of zoom area (shifted left with 8 bit = 256)
sx2_8 Right coordinate of zoom area (shifted left with 8 bit = 256)
sy2_8 Bottom coordinate of zoom area (shifted left with 8 bit = 256)
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

Referenced by gx_zoompixels().

gxi32 gx_rotatepixels ( gxHANDLE  handle,
void *  target,
gxi32  tsline,
gxi32  txsize,
gxi32  tysize,
const void *  source,
gxi32  ssline,
gxi32  sxsize,
gxi32  sysize,
gxi32  format,
gxi32  degree 
) [inline]

Rotates pixels to a specified degree.

Parameters:
handle Handle of the module.
target Pointer to an allocated area where the rotate function places the rotated image.
tsline Size of a row of the destination area.
txsize Horizontal size of the destination area.
tysize Vertical size of the destination area.
source Pointer to pixels of source area.
ssline Size of a row of the source area.
sxsize Horizontal size of the source area.
sysize Vertical size of the source area.
format Pixel format (see GX_PIXELFORMATS).
degree Degree (Must be 0, 90, 180, 270).
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

Referenced by gx_rotatepixels().

gxi32 gx_mirrorpixels ( gxHANDLE  handle,
void *  target,
gxi32  tsline,
gxi32  txsize,
gxi32  tysize,
const void *  source,
gxi32  ssline,
gxi32  sxsize,
gxi32  sysize,
gxi32  format,
gxi32  flags 
) [inline]

Mirrors pixels to a specified mode.

Parameters:
handle Handle of the module.
target Pointer to an allocated area where the mirror function places the mirrored image.
tsline Size of a row of the destination area.
txsize Horizontal size of the destination area.
tysize Vertical size of the destination area.
source Pointer to pixels of source area.
ssline Size of a row of the source area.
sxsize Horizontal size of the source area.
sysize Vertical size of the source area.
format Pixel format (see GX_PIXELFORMATS).
flags Mirror flags. It can be GX_MIRROR_HORIZONTAL or/and GX_MIRROR_VERTICAL. (see GX_MIRRORFLAGS)
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

Referenced by gx_mirrorpixels().

gxi32 gx_mirrorpixels ( gxHANDLE  handle,
void *  pixels,
gxi32  sline,
gxi32  xsize,
gxi32  ysize,
gxi32  format,
gxi32  flags 
) [inline]

Mirrors pixels to a specified mode.

Parameters:
handle Handle of the module.
pixels Pointer to pixels of the pixel area.
sline Size of a row of the pixel area.
xsize Horizontal size of the pixel area.
ysize Vertical size of the pixel area.
format Pixel format (see GX_PIXELFORMATS).
flags Mirror flags. It can be GX_MIRROR_HORIZONTAL or/and GX_MIRROR_VERTICAL. (see GX_MIRRORFLAGS)
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_mirrorpixels().

void* gx_getpixelptr ( gxHANDLE  handle,
gxIMAGE *  pimage,
gxi32  x,
gxi32  y 
) [inline]

Returns the pointer of the pixel.

Parameters:
handle Handle of the module.
pimage Pointer to the image.
x Horizontal position of the pixel.
y Vertical position of the pixel.
Returns:
The pointer of the pixel or NULL if an error occurred or the pixel is not found.

References gx_call().

Referenced by gxImage::GetPixelPtr(), and gx_getpixelptr().

gxi32 gx_getpixelsize ( gxi32 *  size,
gxi32  format 
) [inline]

Gets size of a pixel in bytes.

Parameters:
size Size of the pixel format.
format Pixel format (see GX_PIXELFORMATS).
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_direct(), and gx_getpixelsize().

gxi32 gx_convertpixels ( void *  target,
gxi32  tformat,
gxi32  tsline,
const void *  source,
gxi32  sformat,
gxi32  ssline,
gxi32  xsize,
gxi32  ysize 
) [inline]

Converts pixels to a specified format and size.

Parameters:
target Pointer to a pixel data to where the function stores the data.
tformat Pixel format of the target area (see GX_PIXELFORMATS).
tsline Size of a row of the target area in bytes.
source Pointer to a pixel data.
sformat Pixel format of the source area (see GX_PIXELFORMATS).
ssline Size of a row of the source area in bytes.
xsize Horizontal size of the pixel area.
ysize Vertical size of the pixel area.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_convertpixels(), and gx_direct().

gxi32 gx_fastreconvert ( void *  pixels,
gxi32  tformat,
gxi32  sformat,
gxi32  sline,
gxi32  xsize,
gxi32  ysize 
) [inline]

Fast converts pixels to a specified format and size.

The function is the same as gx_convertpixels(), only it works same memory area.

The fast reconvert function can be used for converting:
  • RGB555,BGR555,RGB565,BGR565 <-> RGB555,BGR555,RGB565,BGR565
  • RGB,BGR <-> RGB,BGR
  • RGBA,BGRA <-> RGBA,BGRA
  • RGB12,BGR12 <-> RGB12,BGR12
Parameters:
pixels Pointer to a pixel data.
tformat Pixel format of the destination image (see GX_PIXELFORMATS).
sformat Pixel format of the source image (see GX_PIXELFORMATS).
sline Size of a row of the pixel area in bytes.
xsize Horizontal size of the pixel area.
ysize Vertical size of the pixel area.
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_direct(), and gx_fastreconvert().

gxi32 gx_zoompixels ( void *  target,
gxi32  tsline,
gxi32  txsize,
gxi32  tysize,
const void *  source,
gxi32  ssline,
gxi32  sxsize,
gxi32  sysize,
gxi32  format,
gxi32  sx1_8 = 0,
gxi32  sy1_8 = 0,
gxi32  sx2_8 = 0,
gxi32  sy2_8 = 0 
) [inline]

Zooms pixels to a specified size.

Parameters:
target Pointer to an allocated area where the zoom function places the converted image.
tsline Size of a row of the destination area.
txsize Horizontal size of the destination area.
tysize Vertical size of the destination area.
source Pointer to pixels of source area.
ssline Size of a row of the source area.
sxsize Horizontal size of the source area.
sysize Vertical size of the source area.
format Pixel format (see GX_PIXELFORMATS).
sx1_8 Left coordinate of zoom area (shifted left with 8 bit = 256)
sy1_8 Top coordinate of zoom area (shifted left with 8 bit = 256)
sx2_8 Right coordinate of zoom area (shifted left with 8 bit = 256)
sy2_8 Bottom coordinate of zoom area (shifted left with 8 bit = 256)
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_direct(), and gx_zoompixels().

gxi32 gx_rotatepixels ( void *  target,
gxi32  tsline,
gxi32  txsize,
gxi32  tysize,
const void *  source,
gxi32  ssline,
gxi32  sxsize,
gxi32  sysize,
gxi32  format,
gxi32  degree 
) [inline]

Rotates pixels to a specified degree.

Parameters:
target Pointer to an allocated area where the rotate function places the rotated image.
tsline Size of a row of the destination area.
txsize Horizontal size of the destination area.
tysize Vertical size of the destination area.
source Pointer to pixels of source area.
ssline Size of a row of the source area.
sxsize Horizontal size of the source area.
sysize Vertical size of the source area.
format Pixel format (see GX_PIXELFORMATS).
degree Degree (Must be 0, 90, 180, 270).
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_direct(), and gx_rotatepixels().

gxi32 gx_mirrorpixels ( void *  target,
gxi32  tsline,
gxi32  txsize,
gxi32  tysize,
const void *  source,
gxi32  ssline,
gxi32  sxsize,
gxi32  sysize,
gxi32  format,
gxi32  flags 
) [inline]

Mirrors pixels to a specified mode.

Parameters:
target Pointer to an allocated area where the mirror function places the mirrored image.
tsline Size of a row of the destination area.
txsize Horizontal size of the destination area.
tysize Vertical size of the destination area.
source Pointer to pixels of source area.
ssline Size of a row of the source area.
sxsize Horizontal size of the source area.
sysize Vertical size of the source area.
format Pixel format (see GX_PIXELFORMATS).
flags Mirror flags. It can be GX_MIRROR_HORIZONTAL or/and GX_MIRROR_VERTICAL. (see GX_MIRRORFLAGS)
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_direct(), and gx_mirrorpixels().

gxi32 gx_mirrorpixels ( void *  pixels,
gxi32  sline,
gxi32  xsize,
gxi32  ysize,
gxi32  format,
gxi32  flags 
) [inline]

Mirrors pixels to a specified mode.

Parameters:
pixels Pointer to pixels of the pixel area.
sline Size of a row of the pixel area.
xsize Horizontal size of the pixel area.
ysize Vertical size of the pixel area.
format Pixel format (see GX_PIXELFORMATS).
flags Mirror flags. It can be GX_MIRROR_HORIZONTAL or/and GX_MIRROR_VERTICAL. (see GX_MIRRORFLAGS)
Returns:
On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_mirrorpixels().

void* gx_getpixelptr ( gxIMAGE *  pimage,
gxi32  x,
gxi32  y 
) [inline]

Returns the pointer of the pixel.

Parameters:
pimage Pointer to the image.
x Horizontal position of the pixel.
y Vertical position of the pixel.
Returns:
The pointer of the pixel or NULL if an error occurred or the pixel is not found.

References gx_direct(), and gx_getpixelptr().

Generated  for GX
(c) ARH Inc.