gxImage Class Reference

Inheritance diagram for gxImage:

List of all members.

---

Detailed Description

Class for the IMAGE functions.

Public Member Functions
	gxImage () throw (gxError)
	Class initialization with default properties.
	gxImage (const gxHANDLE &h) throw (gxError)
	Class initialization with a source image handle.
	gxImage (const gxHANDLE *h) throw (gxError)
	Class initialization with a source image handle.
	gxImage (const wchar_t *propname, const wchar_t *modname=(const wchar_t *) 0) throw (gxError)
	Class initialization with the place of the properties and name of the module (Unicode version).
	gxImage (const char *propname, const char *modname=(const char *) 0) throw (gxError)
	Class initialization with the place of the properties and name of the module (ASCII version).
	gxImage (gxIMAGE &src) throw (gxError)
	Class initialization with another image structure.
	gxImage (gxIMAGE &src, const wchar_t *propname, const wchar_t *modname=(const wchar_t *) 0) throw (gxError)
	Class initialization with another image structure, the place of the properties and name of the module (Unicode version).
	gxImage (gxIMAGE &src, const char *propname, const char *modname=(const char *) 0) throw (gxError)
	Class initialization with another image structure, the place of the properties and name of the module (ASCII version).
	gxImage (gxImage &src, const wchar_t *propname, const wchar_t *modname=(const wchar_t *) 0) throw (gxError)
	Class initialization with another image class, the place of the properties and name of the module (Unicode version).
	gxImage (gxImage &src, const char *propname, const char *modname=(const char *) 0) throw (gxError)
	Class initialization with another image class, the place of the properties and name of the module (ASCII version).
	gxImage (gxInStr propname) throw (gxError)
	Class initialization with the place of the properties (Unicode version).
	gxImage (gxInStr propname, gxInStr modname) throw (gxError)
	Class initialization with the place of the properties and name of the module (Unicode version).
	gxImage (gxInAStr propname) throw (gxError)
	Class initialization with the place of the properties (ASCII version).
	gxImage (gxInAStr propname, gxInAStr modname) throw (gxError)
	Class initialization with the place of the properties and name of the module (ASCII version).
	gxImage (gxImageHandler &ih) throw (gxError)
	Class initialization with previously initialized image handler.
	gxImage (gxImage &src) throw (gxError)
	Class initialization with previously initialized image.
	~gxImage () throw (gxError)
	Class termination.
void	Dispose (void) throw (gxError)
	It disposes the class.
gxImage &	operator= (gxIMAGE &src) throw (gxError)
	Copies an image to the class.
gxImage &	operator= (gxImage &src) throw (gxError)
	Copies an image to the class.
	operator gxIMAGE & () throw (gxError)
	Returns a reference to the gxIMAGE structure.
	operator gxIMAGE * () throw (gxError)
	Returns a pointer to the gxIMAGE structure.
	operator const gxIMAGE * () const throw (gxError)
	Returns a pointer to the gxIMAGE structure.
bool	Attach (gxIMAGE *src) throw (gxError)
	Attaches to an allocated image.
bool	Detach (void) throw (gxError)
	Detaches the image.
bool	GetPixelSize (gxi32 *size) const throw (gxError)
	Gets the size of a pixel in bytes.
void *	GetPixelPtr (gxi32 x, gxi32 y) throw (gxError)
	Returns the pointer of the pixel.
gxi32	GetPixelSize (void) const throw (gxError)
	Returns the size of a current format pixel in bytes.
bool	Create (gxi32 format, gxi32 xsize, gxi32 ysize, gxi32 sline=0) throw (gxError)
	Makes an image with proper size and format.
bool	Convert (gxIMAGE *src, gxi32 format, gxi32 xsize, gxi32 ysize, gxi32 sline=0) throw (gxError)
	Converts an image to a specific format and size.
bool	Convert (gxImageData &src, gxi32 format, gxi32 xsize, gxi32 ysize, gxi32 sline=0) throw (gxError)
	Converts an image to a specific format and size.
bool	Convert (gxImage &src, gxi32 format, gxi32 xsize, gxi32 ysize, gxi32 sline=0) throw (gxError)
	Converts an image to a specific format and size.
bool	Convert (gxi32 format, gxi32 xsize, gxi32 ysize, gxi32 sline=0) throw (gxError)
	Converts an image to a specific format and size.
bool	Convert (gxi32 format) throw (gxError)
	Converts an image to a specific format.
bool	Copy (gxIMAGE *src) throw (gxError)
	Copies an image to the class.
bool	Copy (gxIMAGE &src) throw (gxError)
	Copies an image to the class.
bool	Copy (gxImage *src) throw (gxError)
	Copies an image to the class.
bool	Copy (gxImageData &src) throw (gxError)
	Copies an image to the class.
bool	Copy (gxImage &src) throw (gxError)
	Copies an image to the class.
bool	Zoom (gxIMAGE *src, gxi32 xsize, gxi32 ysize, gxi32 sline, gxi32 sx1_8=0, gxi32 sy1_8=0, gxi32 sx2_8=0, gxi32 sy2_8=0) throw (gxError)
	Zooms an image to a specified size.
bool	Zoom (gxImageData &src, gxi32 xsize, gxi32 ysize, gxi32 sline, gxi32 sx1_8=0, gxi32 sy1_8=0, gxi32 sx2_8=0, gxi32 sy2_8=0) throw (gxError)
	Zooms an image to a specified size.
bool	Zoom (gxImage &src, gxi32 xsize, gxi32 ysize, gxi32 sline, gxi32 sx1_8=0, gxi32 sy1_8=0, gxi32 sx2_8=0, gxi32 sy2_8=0) throw (gxError)
	Zooms an image to a specified size.
bool	Rotate (gxIMAGE *src, gxi32 degree) throw (gxError)
	Rotates an image to a specified degree.
bool	Rotate (gxImageData &src, gxi32 degree) throw (gxError)
	Rotates an image to a specified degree.
bool	Rotate (gxImage &src, gxi32 degree) throw (gxError)
	Rotates an image to a specified degree.
bool	Mirror (gxIMAGE *src, gxi32 flags) throw (gxError)
	Mirrors an image to a specified mode.
bool	Mirror (gxImageData &src, gxi32 flags)
	Mirrors an image to a specified mode.
bool	Mirror (gxImage &src, gxi32 flags)
	Mirrors an image to a specified mode.
bool	Mirror (gxi32 flags)
	Mirrors an image to a specified mode.
bool	Load (const wchar_t *filename, gxi32 pixelformat=GX_UNDEF, gxVARIANT properties=0, gxVARIANT comments=0) throw (gxError)
	Loads an image from a mass storage device and converts it to a specific pixel format (Unicode version).
bool	Load (const char *filename, gxi32 pixelformat=GX_UNDEF, gxVARIANT properties=0, gxVARIANT comments=0) throw (gxError)
	Loads an image from a mass storage device and converts it to a specific pixel format (ASCII version).
bool	Load (gxInStr filename, gxi32 pixelformat, gxVariant &properties, gxVariant &comments) throw (gxError)
	Loads an image with comments from a mass storage device and converts it to a specific pixel format (Unicode version).
bool	Load (gxInStr filename, gxi32 pixelformat) throw (gxError)
	Loads an image from a mass storage device and converts it to a specific pixel format (Unicode version).
bool	Load (gxInStr filename) throw (gxError)
	Loads an image from a mass storage device (Unicode version).
bool	Load (gxInAStr filename, gxi32 pixelformat, gxVariant &properties, gxVariant &comments) throw (gxError)
	Loads an image with comments from a mass storage device and converts it to a specific pixel format (ASCII version).
bool	Load (gxInAStr filename, gxi32 pixelformat=GX_UNDEF) throw (gxError)
	Loads an image from a mass storage device and converts it to a specific pixel format (ASCII version).
bool	Save (const wchar_t *filename, gxi32 fileformat) throw (gxError)
	Saves an image to a mass storage device in the specific file format (Unicode version).
bool	Save (const char *filename, gxi32 fileformat) throw (gxError)
	Saves an image to a mass storage device in the specific file format (ASCII version).
bool	Save (const wchar_t *filename, gxi32 fileformat, gxVariant &properties, gxVariant &comments) throw (gxError)
	Saves an image with comments to a mass storage device in the specific file format (Unicode version).
bool	Save (const char *filename, gxi32 fileformat, gxVariant &properties, gxVariant &comments) throw (gxError)
	Saves an image with comments to a mass storage device in the specific file format (ASCII version).
bool	Save (gxInStr filename, gxi32 fileformat, gxVariant &properties, gxVariant &comments) throw (gxError)
	Saves an image to a mass storage device in the specific file format (Unicode version).
bool	Save (gxInStr filename, gxi32 fileformat) throw (gxError)
	Saves an image to a mass storage device in the specific file format (Unicode version).
bool	Save (gxInAStr filename, gxi32 fileformat, gxVariant &properties, gxVariant &comments) throw (gxError)
	Saves an image with comments to a mass storage device in the specific file format (ASCII version).
bool	Save (gxInAStr filename, gxi32 fileformat) throw (gxError)
	Saves an image to a mass storage device in the specific file format (ASCII version).
bool	LoadFromMem (const void *buffer, gxi32 buflen, gxi32 pixelformat, gxVariant &properties, gxVariant &comments) throw (gxError)
	Loads an image with comments from the memory and converts it to a specific pixel format.
bool	SaveToMem (void **buffer, gxi32 *buflen, gxi32 fileformat, gxVariant &properties, gxVariant &comments) throw (gxError)
	Saves an image with comments in a specific file format to a specific memory area.
bool	LoadFromMem (const void *buffer, gxi32 buflen, gxi32 pixelformat=GX_UNDEF) throw (gxError)
	Loads an image from the memory and converts it to a specific pixel format.
bool	SaveToMem (void **buffer, gxi32 *buflen, gxi32 fileformat) throw (gxError)
	Saves an image in a specific file format to a specific memory area.
bool	IsValid (void) const
	Checks if the image structure and the handle are valid.
bool	FromVariant (gxVariant &variant) throw (gxError)
	Loads an embedded image from a variant.
gxVariant *	ToVariant (gxi32 varid) throw (gxError)
	Embedds an image into a variant.
gxi32	TestImageFileFormat (const wchar_t *filename) throw (gxError)
	Tests if a file is an image file.
gxi32	TestImageFileFormat (const char *filename) throw (gxError)
	Tests if a file is an image file.
gxi32	TestImageFileFormat (const void *buffer, gxi32 buflen) throw (gxError)
	Tests if a memory area contains an image file.
gxi32	TestImageFileFormat (gxInStr filename) throw (gxError)
	Tests if a file is an image file.
gxi32	TestImageFileFormat (gxInAStr filename) throw (gxError)
	Tests if a file is an image file.
bool	Open (const wchar_t *modulename, const wchar_t *groupname=(const wchar_t *) 0) throw (gxError)
	Opens a GX system compatible module (Unicode version).
bool	Open (const char *modulename, const char *groupname=(const char *) 0) throw (gxError)
	Opens a GX system compatible module (ASCII version).
bool	Open (gxInStr modulename, gxInStr groupname) throw (gxError)
	Opens a GX system compatible module (Unicode version).
bool	Open (gxInStr modulename) throw (gxError)
	Opens a GX system compatible module with the default properties (Unicode version).
bool	Open (gxInAStr modulename, gxInAStr groupname) throw (gxError)
	Opens a GX system compatible module (ASCII version).
bool	Open (gxInAStr modulename) throw (gxError)
	Opens a GX system compatible module with the default properties (ASCII version).
bool	Close (void) throw (gxError)
	Closes a previously opened module.
bool	GetInfo (const gxMODULEINFO **moduleinfo) throw (gxError)
	Gives information about an opened module.
bool	Call (int callcode, void *params)
	Calls a process of the module with its parameters.
bool	GetProperty (const wchar_t *name, wchar_t *string, int maxlen) throw (gxError)
	Gets a property of the specified module (Unicode version).
std::wstring	GetProperty (const wchar_t *name) throw (gxError)
	Gets a property of the specified module (Unicode version).
bool	GetProperty (const char *name, char *string, int maxlen) throw (gxError)
	Gets a property of the specified module (ASCII version).
std::string	GetProperty (const char *name) throw (gxError)
	Gets a property of the specified module (ASCII version).
gxOutStr	GetProperty (gxInStr name) throw (gxError)
	Gets a property of the specified module (Unicode version).
gxOutAStr	GetProperty (gxInAStr name) throw (gxError)
	Gets a property of the specified module (ASCII version).
bool	GetProperty (const wchar_t *name, int *ivalue) throw (gxError)
	Gets an integer property of the specified module (Unicode version).
bool	GetProperty (const char *name, int *ivalue) throw (gxError)
	Gets an integer property of the specified module (ASCII version).
bool	GetProperty (const wchar_t *name, double *fvalue) throw (gxError)
	Gets a floating-point property of the specified module (Unicode version).
bool	GetProperty (const char *name, double *fvalue) throw (gxError)
	Gets a floating-point property of the specified module (ASCII version).
int	GetPropertyInt (const wchar_t *name) throw (gxError)
	Gets an integer property of the specified module (Unicode version).
int	GetPropertyInt (gxInStr name) throw (gxError)
	Gets an integer property of the specified module (Unicode version).
int	GetPropertyInt (const char *name) throw (gxError)
	Gets an integer property of the specified module (ASCII version).
int	GetPropertyInt (gxInAStr name) throw (gxError)
	Gets an integer property of the specified module (ASCII version).
double	GetPropertyFloat (const wchar_t *name) throw (gxError)
	Gets a floating-point property of the specified module (Unicode version).
double	GetPropertyFloat (gxInStr name) throw (gxError)
	Gets a floating-point property of the specified module (Unicode version).
double	GetPropertyFloat (const char *name) throw (gxError)
	Gets a floating-point property of the specified module (ASCII version).
double	GetPropertyFloat (gxInAStr name) throw (gxError)
	Gets a floating-point property of the specified module (ASCII version).
bool	GetPropertyVersion (const wchar_t *name, unsigned int *version) throw (gxError)
	Gets a version property of the specified module (Unicode version).
unsigned int	GetPropertyVersion (const wchar_t *name) throw (gxError)
	Gets a version property of the specified module (Unicode version).
unsigned int	GetPropertyVersion (gxInStr name) throw (gxError)
	Gets a version property of the specified module (Unicode version).
bool	GetPropertyVersion (const char *name, unsigned int *version) throw (gxError)
	Gets a version property of the specified module (ASCII version).
unsigned int	GetPropertyVersion (const char *name) throw (gxError)
	Gets a version property of the specified module (ASCII version).
unsigned int	GetPropertyVersion (gxInAStr name) throw (gxError)
	Gets a version property of the specified module (ASCII version).
bool	SetProperty (const wchar_t *name, const wchar_t *string) throw (gxError)
	Sets a property of the specified module (Unicode version).
bool	SetProperty (const char *name, const char *string) throw (gxError)
	Sets a property of the specified module (ASCII version).
bool	SetProperty (gxInStr name, gxInStr str) throw (gxError)
	Sets a property of the specified module (Unicode version).
bool	SetProperty (gxInAStr name, gxInAStr str) throw (gxError)
	Sets a property of the specified module (ASCII version).
bool	SetProperty (const wchar_t *name, int ivalue) throw (gxError)
	Sets an integer property of the specified module (Unicode version).
bool	SetProperty (const char *name, int ivalue) throw (gxError)
	Sets an integer property of the specified module (ASCII version).
bool	SetProperty (gxInStr name, int ivalue) throw (gxError)
	Sets an integer property of the specified module (Unicode version).
bool	SetProperty (gxInAStr name, int ivalue) throw (gxError)
	Sets an integer property of the specified module (ASCII version).
bool	SetProperty (const wchar_t *name, double fvalue) throw (gxError)
	Sets a floating-point property of the specified module (Unicode version).
bool	SetProperty (const char *name, double fvalue) throw (gxError)
	Sets a floating-point property of the specified module (ASCII version).
bool	SetProperty (gxInStr name, double fvalue) throw (gxError)
	Sets a floating-point property of the specified module (Unicode version).
bool	SetProperty (gxInAStr name, double fvalue) throw (gxError)
	Sets a floating-point property of the specified module (ASCII version).
bool	SaveProperties (const wchar_t *name, int level=0) throw (gxError)
	Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (Unicode version).
bool	SaveProperties (const char *name, int level=0) throw (gxError)
	Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (ASCII version).
bool	SaveProperties (gxInStr name, int level) throw (gxError)
	Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (Unicode version).
bool	SaveProperties (gxInStr name) throw (gxError)
	Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (Unicode version).
bool	SaveProperties (gxInAStr name, int level=0) throw (gxError)
	Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (ASCII version).
bool	MPStartTransaction (void)
	It starts the property transaction.
bool	MPCommit (void)
	It ends the property transaction and updates your changes to module.
gxi32	ref (void) const throw (gxError)
	It returns the reference pointer.
void *	image (void) const throw (gxError)
	It returns the pointer to the image pixels.
gxi32	simage (void) const throw (gxError)
	It returns the size of the image in bytes.
gxi32	format (void) const throw (gxError)
	It returns the pixel format of the image.
gxi32	xsize (void) const throw (gxError)
	It returns the horizontal size of the image in pixels.
gxi32	ysize (void) const throw (gxError)
	It returns the vertical size of the image in pixels.
gxi32	sline (void) const throw (gxError)
	It returns the size of a row in bytes.
gxi32	xres (void) const throw (gxError)
	It returns the horizontal resolution of the image.
void	xres (gxi32 _xres) throw (gxError)
	The function sets the horizontal resolution of the image.
gxi32	yres (void) const throw (gxError)
	It returns the vertical resolution of the image.
void	yres (gxi32 _yres) throw (gxError)
	The function sets the vertical resolution of the image.
gxi32	GetRef (void) const throw (gxError)
	It returns the reference pointer.
void *	GetPixels (void) const throw (gxError)
	It returns the pointer to the image pixels.
gxi32	GetSImage (void) const throw (gxError)
	It returns size of the image in bytes.
gxi32	GetPixelFormat (void) const throw (gxError)
	It returns the pixel format of the image.
gxi32	GetXSize (void) const throw (gxError)
	It returns the horizontal size of the image in pixels.
gxi32	GetYSize (void) const throw (gxError)
	It returns the vertical size of the image in pixels.
gxi32	GetSLine (void) const throw (gxError)
	It returns the size of a row in bytes.
gxi32	GetXRes (void) const throw (gxError)
	It returns the horizontal resolution of the image.
gxi32	GetYRes (void) const throw (gxError)
	It returns the vertical resolution of the image.
bool	SetXRes (gxi32 _xres) throw (gxError)
	The function sets the horizontal resolution of the image.
bool	SetYRes (gxi32 _yres) throw (gxError)
	The function sets the vertical resolution of the image.
	operator gxIMAGE * () const
	Returns a pointer to the gxIMAGE structure.
	operator gxIMAGE & () const throw (gxError)
	Returns a reference to the gxIMAGE structure.
Public Attributes
gxu32	handle
	Handle of the module.

---

Constructor & Destructor Documentation

gxImage

(

)

throw (gxError) [inline]

Class initialization with default properties.

References gx_allocimage(), and gxHandle::IsValid().

gxImage

(

const gxHANDLE &

h

)

throw (gxError) [inline]

Class initialization with a source image handle.

Parameters:

h

Source image handle. The reference of this image handle will be increased.

References gx_allocimage(), and gxHandle::IsValid().

gxImage

(

const gxHANDLE *

h

)

throw (gxError) [inline]

Class initialization with a source image handle.

Parameters:

h

Source image handle. The reference of this image handle will be increased.

References gx_allocimage(), and gxHandle::IsValid().

gxImage	(	const wchar_t *	propname,
		const wchar_t *	modname = (const wchar_t *)0
	)			throw (gxError) [inline]

Class initialization with the place of the properties and name of the module (Unicode version).

Parameters:

	propname	Place of the properties in the property tree (Name of a property group).
	modname	Name of the module.

References gx_allocimage(), and gxHandle::IsValid().

gxImage	(	const char *	propname,
		const char *	modname = (const char *)0
	)			throw (gxError) [inline]

Class initialization with the place of the properties and name of the module (ASCII version).

Parameters:

	propname	Place of properties in property tree (Name of a property group).
	modname	Name of the module.

References gx_allocimage(), and gxHandle::IsValid().

gxImage

(

gxIMAGE &

src

)

throw (gxError) [inline]

Class initialization with another image structure.

Parameters:

src

Source image.

References gx_allocimage(), and gxHandle::IsValid().

gxImage	(	gxIMAGE &	src,
		const wchar_t *	propname,
		const wchar_t *	modname = (const wchar_t *)0
	)			throw (gxError) [inline]

Class initialization with another image structure, the place of the properties and name of the module (Unicode version).

Parameters:

	src	Source image.
	propname	Place of the properties in the property tree (Name of a property group).
	modname	Name of the module.

References gx_allocimage(), and gxHandle::IsValid().

gxImage	(	gxIMAGE &	src,
		const char *	propname,
		const char *	modname = (const char *)0
	)			throw (gxError) [inline]

Class initialization with another image structure, the place of the properties and name of the module (ASCII version).

Parameters:

	src	Source image.
	propname	Place of the properties in the property tree (Name of a property group).
	modname	Name of the module.

References gx_allocimage(), and gxHandle::IsValid().

gxImage	(	gxImage &	src,
		const wchar_t *	propname,
		const wchar_t *	modname = (const wchar_t *)0
	)			throw (gxError) [inline]

Class initialization with another image class, the place of the properties and name of the module (Unicode version).

Parameters:

	src	Source image.
	propname	Place of the properties in the property tree (Name of a property group).
	modname	Name of the module.

References gx_allocimage(), and gxHandle::IsValid().

gxImage	(	gxImage &	src,
		const char *	propname,
		const char *	modname = (const char *)0
	)			throw (gxError) [inline]

Class initialization with another image class, the place of the properties and name of the module (ASCII version).

Parameters:

	src	Source image.
	propname	Place of the properties in the property tree (Name of a property group).
	modname	Name of the module.

References gx_allocimage(), and gxHandle::IsValid().

gxImage

(

gxInStr

propname

)

throw (gxError) [inline]

Class initialization with the place of the properties (Unicode version).

Parameters:

propname

Place of the properties in the property tree (Name of a property group).

References gx_allocimage(), and gxHandle::IsValid().

gxImage	(	gxInStr	propname,
		gxInStr	modname
	)			throw (gxError) [inline]

Class initialization with the place of the properties and name of the module (Unicode version).

Parameters:

	propname	Place of properties in property tree (Name of a property group).
	modname	Name of the module.

References gx_allocimage(), and gxHandle::IsValid().

gxImage

(

gxInAStr

propname

)

throw (gxError) [inline]

Class initialization with the place of the properties (ASCII version).

Parameters:

propname

Place of the properties in the property tree (Name of a property group).

References gx_allocimage(), and gxHandle::IsValid().

gxImage	(	gxInAStr	propname,
		gxInAStr	modname
	)			throw (gxError) [inline]

Class initialization with the place of the properties and name of the module (ASCII version).

Parameters:

	propname	Place of properties in property tree (Name of a property group).
	modname	Name of the module.

References gx_allocimage(), and gxHandle::IsValid().

gxImage

(

gxImageHandler &

ih

)

throw (gxError) [inline]

Class initialization with previously initialized image handler.

Parameters:

ih

Previously intialized image handler.

References gx_allocimage(), and gxHandle::IsValid().

gxImage

(

gxImage &

src

)

throw (gxError) [inline]

Class initialization with previously initialized image.

Parameters:

src

Previously intialized image.

References gx_allocimage(), and gxHandle::IsValid().

~gxImage

(

)

throw (gxError) [inline]

Class termination.

---

Member Function Documentation

void Dispose

(

void

)

throw (gxError) [inline]

It disposes the class.

call the base class

Reimplemented from gxImageData.

References gxHandle::Dispose().

gxImage& operator=

(

gxIMAGE &

src

)

throw (gxError) [inline]

Copies an image to the class.

Parameters:

src

Source image structure.

Returns:

Returns a reference to the image class.

gxImage& operator=

(

gxImage &

src

)

throw (gxError) [inline]

Copies an image to the class.

Parameters:

src

Source image class.

Returns:

Returns a reference to the image class.

operator gxIMAGE &

(

)

throw (gxError) [inline]

Returns a reference to the gxIMAGE structure.

Returns:

Reference to the gxIMAGE structure.

operator gxIMAGE *

(

)

throw (gxError) [inline]

Returns a pointer to the gxIMAGE structure.

Returns:

Pointer to the gxIMAGE structure.

operator const gxIMAGE *

(

)

const throw (gxError) [inline]

Returns a pointer to the gxIMAGE structure.

Returns:

Pointer to the gxIMAGE structure.

bool Attach

(

gxIMAGE *

src

)

throw (gxError) [inline]

Attaches to an allocated image.

Parameters:

src

An allocated gxIMAGE structure.

Returns:

An exception is thrown or false is returned in case of error.

References GX_EINVAL, gx_refimage(), gx_seterror(), and gx_unrefimage().

bool Detach

(

void

)

throw (gxError) [inline]

Detaches the image.

Returns:

An exception is thrown or false is returned in case of error.

References gx_allocimage(), and gx_unrefimage().

bool GetPixelSize

(

gxi32 *

size

)

const throw (gxError) [inline]

Gets the size of a pixel in bytes.

Parameters:

size

Size of the pixel format.

Returns:

An exception is thrown or false is returned in case of error.

References gx_getpixelsize().

void* GetPixelPtr	(	gxi32	x,
		gxi32	y
	)			throw (gxError) [inline]

Returns the pointer of the pixel.

Parameters:

	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_getpixelptr().

gxi32 GetPixelSize

(

void

)

const throw (gxError) [inline]

Returns the size of a current format pixel in bytes.

Returns:

Size of the pixel in bytes.

References gx_getpixelsize().

bool Create	(	gxi32	format,
		gxi32	xsize,
		gxi32	ysize,
		gxi32	sline = 0
	)			throw (gxError) [inline]

Makes an image with proper size and format.

Parameters:

	format	Pixel format (see GX_PIXELFORMATS).
	xsize	Horizontal size of image in pixels.
	ysize	Vertical size of image in pixels.
	sline	Length of a row in bytes (min.: xsize * size of a pixel in bytes). If zero the system computes the correct value.

Returns:

An exception is thrown or false is returned in case of error.

References gx_createimage().

bool Convert	(	gxIMAGE *	src,
		gxi32	format,
		gxi32	xsize,
		gxi32	ysize,
		gxi32	sline = 0
	)			throw (gxError) [inline]

Converts an image to a specific format and size.

Parameters:

	src	Pointer to the source image.
	format	Pixel format of the destination image (see GX_PIXELFORMATS).
	xsize	Horizontal size of the destination image in pixels.
	ysize	Vertical size of the destination image in pixels.
	sline	Length of a row in bytes (min.: xsize * size of a pixel in bytes). If zero the system computes the correct value.

Returns:

An exception is thrown or false is returned in case of error.

References gx_convertimage().

bool Convert	(	gxImageData &	src,
		gxi32	format,
		gxi32	xsize,
		gxi32	ysize,
		gxi32	sline = 0
	)			throw (gxError) [inline]

Converts an image to a specific format and size.

Parameters:

	src	Reference to the source image data.
	format	Pixel format of the destination image (see GX_PIXELFORMATS).
	xsize	Horizontal size of the destination image in pixels.
	ysize	Vertical size of the destination image in pixels.
	sline	Length of a row in bytes (min.: xsize * size of a pixel in bytes). If zero the system computes the correct value.

Returns:

An exception is thrown or false is returned in case of error.

References gx_convertimage().

bool Convert	(	gxImage &	src,
		gxi32	format,
		gxi32	xsize,
		gxi32	ysize,
		gxi32	sline = 0
	)			throw (gxError) [inline]

Converts an image to a specific format and size.

Parameters:

	src	Pointer to the source image.
	format	Pixel format of the destination image (see GX_PIXELFORMATS).
	xsize	Horizontal size of the destination image in pixels.
	ysize	Vertical size of the destination image in pixels.
	sline	Length of a row in bytes (min.: xsize * size of a pixel in bytes). If zero the system computes the correct value.

Returns:

An exception is thrown or false is returned in case of error.

References gx_convertimage().

bool Convert	(	gxi32	format,
		gxi32	xsize,
		gxi32	ysize,
		gxi32	sline = 0
	)			throw (gxError) [inline]

Converts an image to a specific format and size.

Parameters:

	format	Pixel format of the destination image (see GX_PIXELFORMATS).
	xsize	Horizontal size of the destination image in pixels.
	ysize	Vertical size of the destination image in pixels.
	sline	Length of a row in bytes (min.: xsize * size of a pixel in bytes). If zero the system computes the correct value.

Returns:

An exception is thrown or false is returned in case of error.

References gx_convertimage().

bool Convert

(

gxi32

format

)

throw (gxError) [inline]

Converts an image to a specific format.

Parameters:

format

Pixel format of the destination image (see GX_PIXELFORMATS).

Returns:

An exception is thrown or false is returned in case of error.

References gx_convertimage().

bool Copy

(

gxIMAGE *

src

)

throw (gxError) [inline]

Copies an image to the class.

Parameters:

src

Pointer of the source image.

Returns:

An exception is thrown or false is returned in case of error.

References gx_copyimage().

bool Copy

(

gxIMAGE &

src

)

throw (gxError) [inline]

Copies an image to the class.

Parameters:

src

Pointer of the source image.

Returns:

An exception is thrown or false is returned in case of error.

References gx_copyimage().

bool Copy

(

gxImage *

src

)

throw (gxError) [inline]

Copies an image to the class.

Parameters:

src

Pointer of the source image.

Returns:

An exception is thrown or false is returned in case of error.

bool Copy

(

gxImageData &

src

)

throw (gxError) [inline]

Copies an image to the class.

Parameters:

src

Reference of the source image.

Returns:

An exception is thrown or false is returned in case of error.

References gx_copyimage().

bool Copy

(

gxImage &

src

)

throw (gxError) [inline]

Copies an image to the class.

Parameters:

src

Pointer of the source image.

Returns:

An exception is thrown or false is returned in case of error.

References gx_copyimage().

bool Zoom	(	gxIMAGE *	src,
		gxi32	xsize,
		gxi32	ysize,
		gxi32	sline,
		gxi32	sx1_8 = 0,
		gxi32	sy1_8 = 0,
		gxi32	sx2_8 = 0,
		gxi32	sy2_8 = 0
	)			throw (gxError) [inline]

Zooms an image to a specified size.

Parameters:

	src	Pointer to the source image.
	xsize	Horizontal size of the destination area.
	ysize	Vertical size of the destination area.
	sline	Size of a row of the destination area.
	sx1_8	Left coordinate of the zoomed area (shifted left with 8 bit = 256)
	sy1_8	Top coordinate of the zoomed area (shifted left with 8 bit = 256)
	sx2_8	Right coordinate of the zoomed area (shifted left with 8 bit = 256)
	sy2_8	Bottom coordinate of the zoomed area (shifted left with 8 bit = 256)

Returns:

An exception is thrown or false is returned in case of error.

References gx_zoomimage().

bool Zoom	(	gxImageData &	src,
		gxi32	xsize,
		gxi32	ysize,
		gxi32	sline,
		gxi32	sx1_8 = 0,
		gxi32	sy1_8 = 0,
		gxi32	sx2_8 = 0,
		gxi32	sy2_8 = 0
	)			throw (gxError) [inline]

Zooms an image to a specified size.

Parameters:

	src	Reference to the source image data.
	xsize	Horizontal size of the destination area.
	ysize	Vertical size of the destination area.
	sline	Size of a row of the destination area.
	sx1_8	Left coordinate of the zoomed area (shifted left with 8 bit = 256)
	sy1_8	Top coordinate of the zoomed area (shifted left with 8 bit = 256)
	sx2_8	Right coordinate of the zoomed area (shifted left with 8 bit = 256)
	sy2_8	Bottom coordinate of the zoomed area (shifted left with 8 bit = 256)

Returns:

An exception is thrown or false is returned in case of error.

References gx_zoomimage().

bool Zoom	(	gxImage &	src,
		gxi32	xsize,
		gxi32	ysize,
		gxi32	sline,
		gxi32	sx1_8 = 0,
		gxi32	sy1_8 = 0,
		gxi32	sx2_8 = 0,
		gxi32	sy2_8 = 0
	)			throw (gxError) [inline]

Zooms an image to a specified size.

Parameters:

	src	Reference to the source image.
	xsize	Horizontal size of the destination area.
	ysize	Vertical size of the destination area.
	sline	Size of a row of the destination area.
	sx1_8	Left coordinate of the zoomed area (shifted left with 8 bit = 256)
	sy1_8	Top coordinate of the zoomed area (shifted left with 8 bit = 256)
	sx2_8	Right coordinate of the zoomed area (shifted left with 8 bit = 256)
	sy2_8	Bottom coordinate of the zoomed area (shifted left with 8 bit = 256)

Returns:

An exception is thrown or false is returned in case of error.

References gx_zoomimage().

bool Rotate	(	gxIMAGE *	src,
		gxi32	degree
	)			throw (gxError) [inline]

Rotates an image to a specified degree.

Parameters:

	src	Pointer to the source image.
	degree	Degree (Must be 0, 90, 180, 270).

Returns:

An exception is thrown or false is returned in case of error.

References gx_rotateimage().

bool Rotate	(	gxImageData &	src,
		gxi32	degree
	)			throw (gxError) [inline]

Rotates an image to a specified degree.

Parameters:

	src	Reference to the source image data.
	degree	Degree (Must be 0, 90, 180, 270).

Returns:

An exception is thrown or false is returned in case of error.

References gx_rotateimage().

bool Rotate	(	gxImage &	src,
		gxi32	degree
	)			throw (gxError) [inline]

Rotates an image to a specified degree.

Parameters:

	src	Reference to the source image.
	degree	Degree (Must be 0, 90, 180, 270).

Returns:

An exception is thrown or false is returned in case of error.

References gx_rotateimage().

bool Mirror	(	gxIMAGE *	src,
		gxi32	flags
	)			throw (gxError) [inline]

Mirrors an image to a specified mode.

Parameters:

	src	Pointer to an image.
	flags	Mirror flags. It can be GX_MIRROR_HORIZONTAL or/and GX_MIRROR_VERTICAL.

Returns:

An exception is thrown or false is returned in case of error.

References gx_mirrorimage().

bool Mirror	(	gxImageData &	src,
		gxi32	flags
	)			[inline]

Mirrors an image to a specified mode.

Parameters:

	src	Reference to an image data.
	flags	Mirror flags. It can be GX_MIRROR_HORIZONTAL or/and GX_MIRROR_VERTICAL.

Returns:

An exception is thrown or false is returned in case of error.

References gx_mirrorimage().

bool Mirror	(	gxImage &	src,
		gxi32	flags
	)			[inline]

Mirrors an image to a specified mode.

Parameters:

	src	Reference to an image.
	flags	Mirror flags. It can be GX_MIRROR_HORIZONTAL or/and GX_MIRROR_VERTICAL.

Returns:

An exception is thrown or false is returned in case of error.

References gx_mirrorimage().

bool Mirror

(

gxi32

flags

)

[inline]

Mirrors an image to a specified mode.

Parameters:

flags

Mirror flags. It can be GX_MIRROR_HORIZONTAL or/and GX_MIRROR_VERTICAL.

Returns:

An exception is thrown or false is returned in case of error.

References gx_mirrorimage().

bool Load	(	const wchar_t *	filename,
		gxi32	pixelformat = GX_UNDEF,
		gxVARIANT	properties = 0,
		gxVARIANT	comments = 0
	)			throw (gxError) [inline]

Loads an image from a mass storage device and converts it to a specific pixel format (Unicode version).

On loading a RAW image, the image must be created with correct parameters (sline parameter also included). The format parameter of the gxImage::Load() must be -1 for RAW images.

       gxImage image;
       image.Create(GX_GRAY, 1024, 768, 1024);
       image.Load("test.raw", -1);
       ...

Parameters:

	filename	Name of the image file.
	pixelformat	The specific pixel format. Giving GX_GRAY converts a color image to grayscale (see GX_PIXELFORMATS).
	properties	Properties for the image loader. It can be empty.
	comments	Comments of the image. It can be empty.

Returns:

An exception is thrown or false is returned in case of error.

References gx_loadimagefromfile().

bool Load	(	const char *	filename,
		gxi32	pixelformat = GX_UNDEF,
		gxVARIANT	properties = 0,
		gxVARIANT	comments = 0
	)			throw (gxError) [inline]

Loads an image from a mass storage device and converts it to a specific pixel format (ASCII version).

On loading a RAW image, the image must be created with correct parameters (sline parameter also included). The format parameter of the gxImage::Load() must be -1 for RAW images.

       gxImage image;
       image.Create(GX_GRAY, 1024, 768, 1024);
       image.Load("test.raw", -1);
       ...

Parameters:

	filename	Name of the image file.
	pixelformat	The specific pixel format. Giving GX_GRAY converts a color image to grayscale (see GX_PIXELFORMATS).
	properties	Properties for the image loader. It can be empty.
	comments	Comments of the image. It can be empty.

Returns:

An exception is thrown or false is returned in case of error.

References gx_loadimagefromfile().

bool Load	(	gxInStr	filename,
		gxi32	pixelformat,
		gxVariant &	properties,
		gxVariant &	comments
	)			throw (gxError) [inline]

Loads an image with comments from a mass storage device and converts it to a specific pixel format (Unicode version).

On loading a RAW image, the image must be created with correct parameters (sline parameter also included). The format parameter of the gxImage::Load() must be -1 for RAW images.

       gxImage image;
       image.Create(GX_GRAY, 1024, 768, 1024);
       image.Load("test.raw", -1);
       ...

Parameters:

	filename	Name of the image file.
	pixelformat	The specific pixel format. Giving GX_GRAY converts a color image to grayscale (see GX_PIXELFORMATS).
	properties	Properties for the image loader.
	comments	Comments of the image.

Returns:

An exception is thrown or false is returned in case of error.

References gx_loadimagefromfile().

bool Load	(	gxInStr	filename,
		gxi32	pixelformat
	)			throw (gxError) [inline]

Loads an image from a mass storage device and converts it to a specific pixel format (Unicode version).

On loading a RAW image, the image must be created with correct parameters (sline parameter also included). The format parameter of the gxImage::Load() must be -1 for RAW images.

       gxImage image;
       image.Create(GX_GRAY, 1024, 768, 1024);
       image.Load("test.raw", -1);
       ...

Parameters:

	filename	Name of the image file.
	pixelformat	The specific pixel format. Giving GX_GRAY converts a color image to grayscale (see GX_PIXELFORMATS).

Returns:

An exception is thrown or false is returned in case of error.

References gx_loadimage().

bool Load

(

gxInStr

filename

)

throw (gxError) [inline]

Loads an image from a mass storage device (Unicode version).

Parameters:

filename

Name of the image file.

Returns:

An exception is thrown or false is returned in case of error.

References gx_loadimage(), and GX_UNDEF.

bool Load	(	gxInAStr	filename,
		gxi32	pixelformat,
		gxVariant &	properties,
		gxVariant &	comments
	)			throw (gxError) [inline]

Loads an image with comments from a mass storage device and converts it to a specific pixel format (ASCII version).

On loading a RAW image, the image must be created with correct parameters (sline parameter also included). The format parameter of the gxImage::Load() must be -1 for RAW images.

       gxImage image;
       image.Create(GX_GRAY, 1024, 768, 1024);
       image.Load("test.raw", -1);
       ...

Parameters:

	filename	Name of the image file.
	pixelformat	The specific pixel format. Giving GX_GRAY converts a color image to grayscale (see GX_PIXELFORMATS).
	properties	Properties for the image loader.
	comments	Comments of the image.

Returns:

An exception is thrown or false is returned in case of error.

References gx_loadimagefromfile().

bool Load	(	gxInAStr	filename,
		gxi32	pixelformat = GX_UNDEF
	)			throw (gxError) [inline]

Loads an image from a mass storage device and converts it to a specific pixel format (ASCII version).

On loading a RAW image, the image must be created with correct parameters (sline parameter also included). The format parameter of the gxImage::Load() must be -1 for RAW images.

       gxImage image;
       image.Create(GX_GRAY, 1024, 768, 1024);
       image.Load("test.raw", -1);
       ...

Parameters:

	filename	Name of the image file.
	pixelformat	The specific pixel format. Giving GX_GRAY converts a color image to grayscale (see GX_PIXELFORMATS).

Returns:

An exception is thrown or false is returned in case of error.

References gx_loadimage().

bool Save	(	const wchar_t *	filename,
		gxi32	fileformat
	)			throw (gxError) [inline]

Saves an image to a mass storage device in the specific file format (Unicode version).

Parameters:

	filename	Name of the image file.
	fileformat	Format of the image file (see GX_IMGFILEFORMATS).

Returns:

An exception is thrown or false is returned in case of error.

References gx_saveimage().

bool Save	(	const char *	filename,
		gxi32	fileformat
	)			throw (gxError) [inline]

Saves an image to a mass storage device in the specific file format (ASCII version).

Parameters:

	filename	Name of the image file.
	fileformat	Format of the image file (see GX_IMGFILEFORMATS).

Returns:

An exception is thrown or false is returned in case of error.

References gx_saveimage().

bool Save	(	const wchar_t *	filename,
		gxi32	fileformat,
		gxVariant &	properties,
		gxVariant &	comments
	)			throw (gxError) [inline]

Saves an image with comments to a mass storage device in the specific file format (Unicode version).

Parameters:

	filename	Name of the image file.
	fileformat	Format of the image file (see GX_IMGFILEFORMATS).
	properties	Properties for the image writer. It can be empty.
	comments	Comments of the image. It can be empty.

Returns:

An exception is thrown or false is returned in case of error.

References gx_saveimagetofile().

bool Save	(	const char *	filename,
		gxi32	fileformat,
		gxVariant &	properties,
		gxVariant &	comments
	)			throw (gxError) [inline]

Saves an image with comments to a mass storage device in the specific file format (ASCII version).

Parameters:

	filename	Name of the image file.
	fileformat	Format of the image file (see GX_IMGFILEFORMATS).
	properties	Properties for the image writer. It can be empty.
	comments	Comments of the image. It can be empty.

Returns:

An exception is thrown or false is returned in case of error.

References gx_saveimagetofile().

bool Save	(	gxInStr	filename,
		gxi32	fileformat,
		gxVariant &	properties,
		gxVariant &	comments
	)			throw (gxError) [inline]

Saves an image to a mass storage device in the specific file format (Unicode version).

Parameters:

	filename	Name of the image file.
	fileformat	Format of the image file (see GX_IMGFILEFORMATS).
	properties	Properties for the image writer. It can be empty.
	comments	Comments of the image. It can be empty.

Returns:

An exception is thrown or false is returned in case of error.

References gx_saveimagetofile().

bool Save	(	gxInStr	filename,
		gxi32	fileformat
	)			throw (gxError) [inline]

Saves an image to a mass storage device in the specific file format (Unicode version).

Parameters:

	filename	Name of the image file.
	fileformat	Format of the image file (see GX_IMGFILEFORMATS).

Returns:

An exception is thrown or false is returned in case of error.

References gx_saveimage().

bool Save	(	gxInAStr	filename,
		gxi32	fileformat,
		gxVariant &	properties,
		gxVariant &	comments
	)			throw (gxError) [inline]

Saves an image with comments to a mass storage device in the specific file format (ASCII version).

Parameters:

	filename	Name of the image file.
	fileformat	Format of the image file (see GX_IMGFILEFORMATS).
	properties	Properties for the image writer. It can be empty.
	comments	Comments of the image. It can be empty.

Returns:

An exception is thrown or false is returned in case of error.

bool Save	(	gxInAStr	filename,
		gxi32	fileformat
	)			throw (gxError) [inline]

Saves an image to a mass storage device in the specific file format (ASCII version).

Parameters:

	filename	Name of the image file.
	fileformat	Format of the image file (see GX_IMGFILEFORMATS).

Returns:

An exception is thrown or false is returned in case of error.

bool LoadFromMem	(	const void *	buffer,
		gxi32	buflen,
		gxi32	pixelformat,
		gxVariant &	properties,
		gxVariant &	comments
	)			throw (gxError) [inline]

Loads an image with comments from the memory and converts it to a specific pixel format.

On loading a RAW image, the image must be created with correct parameters (sline parameter also included). The format parameter of the gxImage::LoadFromMem() must be -1 for RAW images.

Parameters:

	buffer	Pointer to the image data.
	buflen	Length of image data in bytes.
	pixelformat	The specific pixel format. Giving GX_GRAY converts a color image to grayscale (see GX_PIXELFORMATS).
	properties	Properties for the image loader.
	comments	Comments of the image.

Returns:

An exception is thrown or false is returned in case of error.

References gx_loadimagefrommem().

bool SaveToMem	(	void **	buffer,
		gxi32 *	buflen,
		gxi32	fileformat,
		gxVariant &	properties,
		gxVariant &	comments
	)			throw (gxError) [inline]

Saves an image with comments in a specific file format to a specific memory area.

Parameters:

	buffer	Pointer to the memory area pointer that is large enough or NULL.
	buflen	Size of the memory area.
	fileformat	Format of the image file (see GX_IMGFILEFORMATS).
	properties	Properties for the image writer. It can be empty.
	comments	Comments of the image. It can be empty.

Returns:

An exception is thrown or false is returned in case of error.

References gx_saveimagetomem().

bool LoadFromMem	(	const void *	buffer,
		gxi32	buflen,
		gxi32	pixelformat = GX_UNDEF
	)			throw (gxError) [inline]

Loads an image from the memory and converts it to a specific pixel format.

On loading a RAW image, the image must be created with correct parameters (sline parameter also included). The format parameter of the gxImage::LoadFromMem() must be -1 for RAW images.

Parameters:

	buffer	Pointer to the image data.
	buflen	Length of image data in bytes.
	pixelformat	The specific pixel format. Giving GX_GRAY converts a color image to grayscale (see GX_PIXELFORMATS).

Returns:

An exception is thrown or false is returned in case of error.

References gx_loadfrommem().

bool SaveToMem	(	void **	buffer,
		gxi32 *	buflen,
		gxi32	fileformat
	)			throw (gxError) [inline]

Saves an image in a specific file format to a specific memory area.

Parameters:

	buffer	Pointer to the memory area pointer that is large enough or NULL.
	buflen	Size of the memory area.
	fileformat	Format of the image file (see GX_IMGFILEFORMATS).

Returns:

An exception is thrown or false is returned in case of error.

References gx_savetomem().

bool IsValid

(

void

)

const [inline]

Checks if the image structure and the handle are valid.

Returns:

In case of valid image the return value is non-zero.

Reimplemented from gxHandle.

References gx_isvalidimage(), and gxHandle::IsValid().

bool FromVariant

(

gxVariant &

variant

)

throw (gxError) [inline]

Loads an embedded image from a variant.

Parameters:

variant

Variant with an embedded image.

Returns:

An exception is thrown or false is returned in case of error.

References gx_imagefromvariant(), and gx_unrefimage().

gxVariant* ToVariant

(

gxi32

varid

)

throw (gxError) [inline]

Embedds an image into a variant.

Parameters:

varid

The id for the created variant.

Returns:

An exception is thrown or false is returned in case of error.

References GX_ENOMEM, gx_imagetovariant(), gx_unrefvariant(), and gxSystem::SetError().

gxi32 TestImageFileFormat

(

const wchar_t *

filename

)

throw (gxError) [inline]

Tests if a file is an image file.

Parameters:

filename

Name of the file to test.

Returns:

An exception is thrown or 0 is returned in case of error, -1 is returned for unknown file type.

References gx_testimagefileformat().

gxi32 TestImageFileFormat

(

const char *

filename

)

throw (gxError) [inline]

Tests if a file is an image file.

Parameters:

filename

Name of the file to test.

Returns:

An exception is thrown or 0 is returned in case of error, -1 is returned for unknown file type.

References gx_testimagefileformat().

gxi32 TestImageFileFormat	(	const void *	buffer,
		gxi32	buflen
	)			throw (gxError) [inline]

Tests if a memory area contains an image file.

Parameters:

	buffer	Pointer to the memory area.
	buflen	Size of the memory area.

Returns:

An exception is thrown or 0 is returned in case of error, -1 is returned for unknown file type.

References gx_testimagefileformat().

gxi32 TestImageFileFormat

(

gxInStr

filename

)

throw (gxError) [inline]

Tests if a file is an image file.

Parameters:

filename

Name of the file to test.

Returns:

An exception is thrown or 0 is returned in case of error, -1 is returned for unknown file type.

References gx_testimagefileformat().

gxi32 TestImageFileFormat

(

gxInAStr

filename

)

throw (gxError) [inline]

Tests if a file is an image file.

Parameters:

filename

Name of the file to test.

Returns:

An exception is thrown or 0 is returned in case of error, -1 is returned for unknown file type.

References gx_testimagefileformat().

bool Open	(	const wchar_t *	modulename,
		const wchar_t *	groupname = (const wchar_t *)0
	)			throw (gxError) [inline, inherited]

Opens a GX system compatible module (Unicode version).

Parameters:

	modulename	Name of the module.
	groupname	Property place in the property tree.

Returns:

An exception is thrown or false is returned in case of error.

References gx_openmodule().

bool Open	(	const char *	modulename,
		const char *	groupname = (const char *)0
	)			throw (gxError) [inline, inherited]

Opens a GX system compatible module (ASCII version).

Parameters:

	modulename	Name of the module.
	groupname	Property place in the property tree.

Returns:

An exception is thrown or false is returned in case of error.

References gx_openmodule().

bool Open	(	gxInStr	modulename,
		gxInStr	groupname
	)			throw (gxError) [inline, inherited]

Opens a GX system compatible module (Unicode version).

Parameters:

	modulename	Name of the module.
	groupname	Property place in the property tree.

Returns:

An exception is thrown or false is returned in case of error.

References gx_openmodule().

bool Open

(

gxInStr

modulename

)

throw (gxError) [inline, inherited]

Opens a GX system compatible module with the default properties (Unicode version).

Parameters:

modulename

Name of the module.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxGZip, and gxZip.

References gx_openmodule().

bool Open	(	gxInAStr	modulename,
		gxInAStr	groupname
	)			throw (gxError) [inline, inherited]

Opens a GX system compatible module (ASCII version).

Parameters:

	modulename	Name of the module.
	groupname	Property place in the property tree.

Returns:

An exception is thrown or false is returned in case of error.

References gx_openmodulea().

bool Open

(

gxInAStr

modulename

)

throw (gxError) [inline, inherited]

Opens a GX system compatible module with the default properties (ASCII version).

Parameters:

modulename

Name of the module.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxGZip, and gxZip.

References gx_openmodulea().

bool Close

(

void

)

throw (gxError) [inline, inherited]

Closes a previously opened module.

It decreases the reference counter of the handle. The function closes the module if required (in case when the reference counter becames zero).

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxGZip, and gxZip.

References gx_unrefhandle(), and gxHandle::IsValid().

Referenced by gxHandle::operator=().

bool GetInfo

(

const gxMODULEINFO **

moduleinfo

)

throw (gxError) [inline, inherited]

Gives information about an opened module.

Parameters:

moduleinfo

Pointer to an information structure pointer where the system returns the data of the specified module.

Returns:

An exception is thrown or false is returned in case of error.

References gx_getmoduleinfo().

bool Call	(	int	callcode,
		void *	params
	)			[inline, inherited]

Calls a process of the module with its parameters.

The functions and parameters usable inside the modules can be found in the documentation of the modules. The headers given with the modules contain inline functions, which make easier to access the functions of the module.

Parameters:

	callcode	Call code for the function (GX_CALL_xxx call codes).
	params	Parameters to give for the function (GX_PARM_xxx structures).

Returns:

Module defined, usually success is true.

References gx_call().

bool GetProperty	(	const wchar_t *	name,
		wchar_t *	string,
		int	maxlen
	)			throw (gxError) [inline, inherited]

Gets a property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	string	Pointer to a memory area where to store the value.
	maxlen	Size of memory area in characters (not bytes).

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_getmoduleproperty().

std::wstring GetProperty

(

const wchar_t *

name

)

throw (gxError) [inline, inherited]

Gets a property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

Value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmoduleproperty().

bool GetProperty	(	const char *	name,
		char *	string,
		int	maxlen
	)			throw (gxError) [inline, inherited]

Gets a property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	string	Pointer to a memory area where to store the value.
	maxlen	Size of memory area in characters (not bytes).

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_getmoduleproperty().

std::string GetProperty

(

const char *

name

)

throw (gxError) [inline, inherited]

Gets a property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

Value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmoduleproperty().

gxOutStr GetProperty

(

gxInStr

name

)

throw (gxError) [inline, inherited]

Gets a property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

Value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmoduleproperty().

gxOutAStr GetProperty

(

gxInAStr

name

)

throw (gxError) [inline, inherited]

Gets a property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

Value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertya().

bool GetProperty	(	const wchar_t *	name,
		int *	ivalue
	)			throw (gxError) [inline, inherited]

Gets an integer property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	ivalue	Pointer to an integer where to store the value.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyint().

bool GetProperty	(	const char *	name,
		int *	ivalue
	)			throw (gxError) [inline, inherited]

Gets an integer property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	ivalue	Pointer to an integer where to store the value.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyinta().

bool GetProperty	(	const wchar_t *	name,
		double *	fvalue
	)			throw (gxError) [inline, inherited]

Gets a floating-point property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	fvalue	Pointer to a floating-point where to store the value.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyfloat().

bool GetProperty	(	const char *	name,
		double *	fvalue
	)			throw (gxError) [inline, inherited]

Gets a floating-point property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	fvalue	Pointer to a floating-point where to store the value.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyfloata().

int GetPropertyInt

(

const wchar_t *

name

)

throw (gxError) [inline, inherited]

Gets an integer property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyint().

int GetPropertyInt

(

gxInStr

name

)

throw (gxError) [inline, inherited]

Gets an integer property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyint().

int GetPropertyInt

(

const char *

name

)

throw (gxError) [inline, inherited]

Gets an integer property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyinta().

int GetPropertyInt

(

gxInAStr

name

)

throw (gxError) [inline, inherited]

Gets an integer property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyinta().

double GetPropertyFloat

(

const wchar_t *

name

)

throw (gxError) [inline, inherited]

Gets a floating-point property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

The floating-point value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyfloat().

double GetPropertyFloat

(

gxInStr

name

)

throw (gxError) [inline, inherited]

Gets a floating-point property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

The floating-point value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyfloat().

double GetPropertyFloat

(

const char *

name

)

throw (gxError) [inline, inherited]

Gets a floating-point property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

The floating-point value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyfloata().

double GetPropertyFloat

(

gxInAStr

name

)

throw (gxError) [inline, inherited]

Gets a floating-point property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

The floating-point value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyfloata().

bool GetPropertyVersion	(	const wchar_t *	name,
		unsigned int *	version
	)			throw (gxError) [inline, inherited]

Gets a version property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	version	Pointer to an integer where to store the version.

Returns:

An exception is thrown or false is returned in case of error.

References gx_getmodulepropertyversion().

unsigned int GetPropertyVersion

(

const wchar_t *

name

)

throw (gxError) [inline, inherited]

Gets a version property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyversion().

unsigned int GetPropertyVersion

(

gxInStr

name

)

throw (gxError) [inline, inherited]

Gets a version property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyversion().

bool GetPropertyVersion	(	const char *	name,
		unsigned int *	version
	)			throw (gxError) [inline, inherited]

Gets a version property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	version	Pointer to an integer where to store the version.

Returns:

An exception is thrown or false is returned in case of error.

References gx_getmodulepropertyversiona().

unsigned int GetPropertyVersion

(

const char *

name

)

throw (gxError) [inline, inherited]

Gets a version property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyversiona().

unsigned int GetPropertyVersion

(

gxInAStr

name

)

throw (gxError) [inline, inherited]

Gets a version property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyversiona().

bool SetProperty	(	const wchar_t *	name,
		const wchar_t *	string
	)			throw (gxError) [inline, inherited]

Sets a property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	string	Value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmoduleproperty().

bool SetProperty	(	const char *	name,
		const char *	string
	)			throw (gxError) [inline, inherited]

Sets a property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	string	Value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertya().

bool SetProperty	(	gxInStr	name,
		gxInStr	str
	)			throw (gxError) [inline, inherited]

Sets a property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	str	Value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmoduleproperty().

bool SetProperty	(	gxInAStr	name,
		gxInAStr	str
	)			throw (gxError) [inline, inherited]

Sets a property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	str	Value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertya().

bool SetProperty	(	const wchar_t *	name,
		int	ivalue
	)			throw (gxError) [inline, inherited]

Sets an integer property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	ivalue	An integer value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyint().

bool SetProperty	(	const char *	name,
		int	ivalue
	)			throw (gxError) [inline, inherited]

Sets an integer property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	ivalue	An integer value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyinta().

bool SetProperty	(	gxInStr	name,
		int	ivalue
	)			throw (gxError) [inline, inherited]

Sets an integer property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	ivalue	An integer value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyint().

bool SetProperty	(	gxInAStr	name,
		int	ivalue
	)			throw (gxError) [inline, inherited]

Sets an integer property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	ivalue	An integer value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyinta().

bool SetProperty	(	const wchar_t *	name,
		double	fvalue
	)			throw (gxError) [inline, inherited]

Sets a floating-point property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	fvalue	A floating-point value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyfloat().

bool SetProperty	(	const char *	name,
		double	fvalue
	)			throw (gxError) [inline, inherited]

Sets a floating-point property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	fvalue	A floating-point value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyfloata().

bool SetProperty	(	gxInStr	name,
		double	fvalue
	)			throw (gxError) [inline, inherited]

Sets a floating-point property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	fvalue	A floating-point value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyfloat().

bool SetProperty	(	gxInAStr	name,
		double	fvalue
	)			throw (gxError) [inline, inherited]

Sets a floating-point property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	fvalue	A floating-point value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyfloata().

bool SaveProperties	(	const wchar_t *	name,
		int	level = 0
	)			throw (gxError) [inline, inherited]

Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (Unicode version).

Parameters:

	name	Place of property in the tree.
	level	Higher numbers give more details (0 = basic properties, 100 = all properties).

Returns:

An exception is thrown or false is returned in case of error.

References gx_savemoduleproperties().

bool SaveProperties	(	const char *	name,
		int	level = 0
	)			throw (gxError) [inline, inherited]

Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (ASCII version).

Parameters:

	name	Place of property in the tree.
	level	Higher numbers give more details (0 = basic properties, 100 = all properties).

Returns:

An exception is thrown or false is returned in case of error.

References gx_savemoduleproperties().

bool SaveProperties	(	gxInStr	name,
		int	level
	)			throw (gxError) [inline, inherited]

Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (Unicode version).

Parameters:

	name	Place of property in the tree.
	level	Higher numbers give more details (0 = basic properties, 100 = all properties).

Returns:

An exception is thrown or false is returned in case of error.

References gx_savemoduleproperties().

bool SaveProperties

(

gxInStr

name

)

throw (gxError) [inline, inherited]

Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (Unicode version).

Parameters:

name

Place of property in the tree.

Returns:

An exception is thrown or false is returned in case of error.

References gx_savemoduleproperties().

bool SaveProperties	(	gxInAStr	name,
		int	level = 0
	)			throw (gxError) [inline, inherited]

Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (ASCII version).

Parameters:

	name	Place of property in the tree.
	level	Higher numbers give more details (0 = basic properties, 100 = all properties).

Returns:

An exception is thrown or false is returned in case of error.

References gx_savemodulepropertiesa().

bool MPStartTransaction

(

void

)

[inline, inherited]

It starts the property transaction.

The module accepts but doesn't update properties (setmoduleproperty). You must use 'gx_mpcommit' to update these properties.

Warning:

Not supported by each module!

Returns:

An exception is thrown or false is returned in case of error.

References gx_mpstarttransaction().

bool MPCommit

(

void

)

[inline, inherited]

It ends the property transaction and updates your changes to module.

Warning:

Not supported by each module!

Returns:

An exception is thrown or false is returned in case of error.

References gx_mpcommit().

gxi32 ref

(

void

)

const throw (gxError) [inline, inherited]

It returns the reference pointer.

See also:

gxIMAGE, gx_refimage, gx_unrefimage

Returns:

Reference pointer of the gxIMAGE structure

void* image

(

void

)

const throw (gxError) [inline, inherited]

It returns the pointer to the image pixels.

See also:

gxIMAGE

Returns:

Pointer to the image pixels.

gxi32 simage

(

void

)

const throw (gxError) [inline, inherited]

It returns the size of the image in bytes.

See also:

gxIMAGE

Returns:

Size of the image in bytes.

gxi32 format

(

void

)

const throw (gxError) [inline, inherited]

It returns the pixel format of the image.

See also:

gxIMAGE

Returns:

Pixel format of the image (see GX_PIXELFORMATS).

gxi32 xsize

(

void

)

const throw (gxError) [inline, inherited]

It returns the horizontal size of the image in pixels.

See also:

gxIMAGE

Returns:

Horizontal size of the image in pixels.

gxi32 ysize

(

void

)

const throw (gxError) [inline, inherited]

It returns the vertical size of the image in pixels.

See also:

gxIMAGE

Returns:

Vertical size of the image in pixels.

gxi32 sline

(

void

)

const throw (gxError) [inline, inherited]

It returns the size of a row in bytes.

See also:

gxIMAGE

Returns:

Size of a row in bytes.

gxi32 xres

(

void

)

const throw (gxError) [inline, inherited]

It returns the horizontal resolution of the image.

See also:

gxIMAGE

Returns:

Horizontal resolution of the image.

void xres

(

gxi32

_xres

)

throw (gxError) [inline, inherited]

The function sets the horizontal resolution of the image.

See also:

gxIMAGE

Parameters:

_xres

Value to set.

gxi32 yres

(

void

)

const throw (gxError) [inline, inherited]

It returns the vertical resolution of the image.

See also:

gxIMAGE

Returns:

Vertical resolution of the image.

void yres

(

gxi32

_yres

)

throw (gxError) [inline, inherited]

The function sets the vertical resolution of the image.

See also:

gxIMAGE

Parameters:

_yres

Value to set.

gxi32 GetRef

(

void

)

const throw (gxError) [inline, inherited]

It returns the reference pointer.

See also:

gxIMAGE, gx_refimage, gx_unrefimage

Returns:

Reference pointer of the gxIMAGE structure

void* GetPixels

(

void

)

const throw (gxError) [inline, inherited]

It returns the pointer to the image pixels.

See also:

gxIMAGE

Returns:

Pointer to the image pixels.

gxi32 GetSImage

(

void

)

const throw (gxError) [inline, inherited]

It returns size of the image in bytes.

See also:

gxIMAGE

Returns:

Size of the image in bytes.

gxi32 GetPixelFormat

(

void

)

const throw (gxError) [inline, inherited]

It returns the pixel format of the image.

See also:

gxIMAGE

Returns:

Pixel format of the image (see GX_PIXELFORMATS).

gxi32 GetXSize

(

void

)

const throw (gxError) [inline, inherited]

It returns the horizontal size of the image in pixels.

See also:

gxIMAGE

Returns:

Horizontal size of the image in pixels.

gxi32 GetYSize

(

void

)

const throw (gxError) [inline, inherited]

It returns the vertical size of the image in pixels.

See also:

gxIMAGE

Returns:

Vertical size of the image in pixels.

gxi32 GetSLine

(

void

)

const throw (gxError) [inline, inherited]

It returns the size of a row in bytes.

See also:

gxIMAGE

Returns:

Size of a row in bytes.

gxi32 GetXRes

(

void

)

const throw (gxError) [inline, inherited]

It returns the horizontal resolution of the image.

See also:

gxIMAGE

Returns:

Horizontal resolution of the image.

gxi32 GetYRes

(

void

)

const throw (gxError) [inline, inherited]

It returns the vertical resolution of the image.

See also:

gxIMAGE

Returns:

Vertical resolution of the image.

bool SetXRes

(

gxi32

_xres

)

throw (gxError) [inline, inherited]

The function sets the horizontal resolution of the image.

See also:

gxIMAGE

Parameters:

_xres

Value to set.

Returns:

The function always returns true.

bool SetYRes

(

gxi32

_yres

)

throw (gxError) [inline, inherited]

The function sets the vertical resolution of the image.

See also:

gxIMAGE

Parameters:

_yres

Value to set.

Returns:

The function always returns true.

operator gxIMAGE *

(

)

const [inline, inherited]

Returns a pointer to the gxIMAGE structure.

Returns:

Pointer to the gxIMAGE structure.

operator gxIMAGE &

(

)

const throw (gxError) [inline, inherited]

Returns a reference to the gxIMAGE structure.

Returns:

Reference to the gxIMAGE structure.

---

Member Data Documentation

gxu32 handle [inherited]

Handle of the module.

If it is zero, it is invalid.

See also:

gx_isvalidhandle()

Referenced by gx_closehandle(), gx_direct(), gx_isvalidhandle(), gxHandle::gxHandle(), gxImageHandler::gxImageHandler(), gxTrafoHandler::gxTrafoHandler(), and gxHandle::operator=().