gxImageData Class Reference

Inheritance diagram for gxImageData:

List of all members.

---

Detailed Description

Class for the IMAGE data and some low-level functions.

See also:

gxImage

Public Member Functions
	gxImageData ()
	Class initialization.
	~gxImageData () throw (gxError)
	Class termination.
void	Dispose (void) throw (gxError)
	It disposes the class.
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.
gxi32	yres (void) const throw (gxError)
	It returns the vertical resolution of the image.
void	xres (gxi32 _xres) throw (gxError)
	The function sets the horizontal 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.

---

Constructor & Destructor Documentation

gxImageData

(

)

[inline]

Class initialization.

~gxImageData

(

)

throw (gxError) [inline]

Class termination.

---

Member Function Documentation

void Dispose

(

void

)

throw (gxError) [inline]

It disposes the class.

no base class

Reimplemented in gxImage.

gxi32 ref

(

void

)

const throw (gxError) [inline]

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]

It returns the pointer to the image pixels.

See also:

gxIMAGE

Returns:

Pointer to the image pixels.

gxi32 simage

(

void

)

const throw (gxError) [inline]

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]

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]

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]

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]

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]

It returns the horizontal resolution of the image.

See also:

gxIMAGE

Returns:

Horizontal resolution of the image.

gxi32 yres

(

void

)

const throw (gxError) [inline]

It returns the vertical resolution of the image.

See also:

gxIMAGE

Returns:

Vertical resolution of the image.

void xres

(

gxi32

_xres

)

throw (gxError) [inline]

The function sets the horizontal resolution of the image.

See also:

gxIMAGE

Parameters:

_xres

Value to set.

void yres

(

gxi32

_yres

)

throw (gxError) [inline]

The function sets the vertical resolution of the image.

See also:

gxIMAGE

Parameters:

_yres

Value to set.

gxi32 GetRef

(

void

)

const throw (gxError) [inline]

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]

It returns the pointer to the image pixels.

See also:

gxIMAGE

Returns:

Pointer to the image pixels.

gxi32 GetSImage

(

void

)

const throw (gxError) [inline]

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]

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]

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]

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]

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]

It returns the horizontal resolution of the image.

See also:

gxIMAGE

Returns:

Horizontal resolution of the image.

gxi32 GetYRes

(

void

)

const throw (gxError) [inline]

It returns the vertical resolution of the image.

See also:

gxIMAGE

Returns:

Vertical resolution of the image.

bool SetXRes

(

gxi32

_xres

)

throw (gxError) [inline]

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]

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]

Returns a pointer to the gxIMAGE structure.

Returns:

Pointer to the gxIMAGE structure.

operator gxIMAGE &

(

)

const throw (gxError) [inline]

Returns a reference to the gxIMAGE structure.

Returns:

Reference to the gxIMAGE structure.