Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members

FX::FXImage Class Reference

#include <FXImage.h>

Inheritance diagram for FX::FXImage:
FX::FXDrawable FX::FXId FX::FXObject FX::FXBMPImage FX::FXGIFImage FX::FXICOImage FX::FXIcon FX::FXIFFImage FX::FXJPGImage FX::FXPCXImage FX::FXPNGImage FX::FXPPMImage FX::FXRASImage FX::FXRGBImage FX::FXTGAImage FX::FXTIFImage FX::FXXBMImage FX::FXXPMImage

Public Member Functions

 FXImage (FXApp *a, const FXColor *pix=NULL, FXuint opts=0, FXint w=1, FXint h=1)
 
void setOptions (FXuint opts)
 
FXuint getOptions () const
 
virtual void setData (FXColor *pix, FXuint opts=0)
 
virtual void setData (FXColor *pix, FXuint opts, FXint w, FXint h)
 
FXColorgetData () const
 
FXColor getPixel (FXint x, FXint y) const
 
void setPixel (FXint x, FXint y, FXColor color)
 
bool hasAlpha () const
 
virtual void create ()
 
virtual void detach ()
 
virtual void destroy ()
 
virtual void restore ()
 
virtual void render ()
 
virtual void release ()
 
virtual void resize (FXint w, FXint h)
 
virtual void scale (FXint w, FXint h, FXint quality=0)
 
virtual void mirror (bool horizontal, bool vertical)
 
virtual void rotate (FXint degrees)
 
virtual void crop (FXint x, FXint y, FXint w, FXint h, FXColor color=0)
 
virtual void fill (FXColor color)
 
virtual void fade (FXColor color, FXint factor=255)
 
virtual void xshear (FXint shear, FXColor clr=0)
 
virtual void yshear (FXint shear, FXColor clr=0)
 
virtual void hgradient (FXColor left, FXColor right)
 
virtual void vgradient (FXColor top, FXColor bottom)
 
virtual void gradient (FXColor topleft, FXColor topright, FXColor bottomleft, FXColor bottomright)
 
virtual void blend (FXColor color)
 
virtual void save (FXStream &store) const
 
virtual void load (FXStream &store)
 
virtual bool savePixels (FXStream &store) const
 
virtual bool loadPixels (FXStream &store)
 
virtual ~FXImage ()
 
- Public Member Functions inherited from FX::FXDrawable
FXint getWidth () const
 
FXint getHeight () const
 
FXVisualgetVisual () const
 
void setVisual (FXVisual *vis)
 
virtual ~FXDrawable ()
 
- Public Member Functions inherited from FX::FXId
FXAppgetApp () const
 
FXID id () const
 
void setUserData (void *ptr)
 
void * getUserData () const
 
virtual ~FXId ()
 
- Public Member Functions inherited from FX::FXObject
virtual long onDefault (FXObject *, FXSelector, void *)
 
const FXchargetClassName () const
 
bool isMemberOf (const FXMetaClass *metaclass) const
 
virtual long tryHandle (FXObject *sender, FXSelector sel, void *ptr)
 
virtual ~FXObject ()
 

Friends

class FXDC
 
class FXDCWindow
 

Detailed Description

An Image is a rectangular array of pixels.

It supports two representations of these pixels: a client-side pixel buffer which is stored as an array of FXColor, and a server-side pixmap which is stored in an organization directly compatible with the screen, for fast drawing onto the device. The server-side representation is not directly accessible from the current process as it lives in the process of the X Server or GDI.

See also:

Constructor & Destructor Documentation

FX::FXImage::FXImage ( FXApp a,
const FXColor pix = NULL,
FXuint  opts = 0,
FXint  w = 1,
FXint  h = 1 
)

Create an image.

If a client-side pixel buffer has been specified, the image does not own the pixel buffer unless the IMAGE_OWNED flag is set. If the IMAGE_OWNED flag is set but a NULL pixel buffer is passed, a pixel buffer will be automatically created and will be owned by the image. The flags IMAGE_SHMI and IMAGE_SHMP may be specified for large images to instruct render() to use shared memory to communicate with the server.

virtual FX::FXImage::~FXImage ( )
virtual

Destructor.

Member Function Documentation

void FX::FXImage::setOptions ( FXuint  opts)

Change options.

FXuint FX::FXImage::getOptions ( ) const
inline

To get to the option flags.

virtual void FX::FXImage::setData ( FXColor pix,
FXuint  opts = 0 
)
virtual

Populate the image with new pixel data of the same size; it will assume ownership of the pixel data if image IMAGE_OWNED option is passed.

The server-side representation of the image, if it exists, is not updated. This can be done by calling render().

virtual void FX::FXImage::setData ( FXColor pix,
FXuint  opts,
FXint  w,
FXint  h 
)
virtual

Populate the image with new pixel data of a new size; it will assume ownership of the pixel data if image IMAGE_OWNED option is passed.

The size of the server- side representation of the image, if it exists, is adjusted but the contents are not updated yet. This can be done by calling render().

FXColor* FX::FXImage::getData ( ) const
inline

Return pointer to the pixel data of the image.

FXColor FX::FXImage::getPixel ( FXint  x,
FXint  y 
) const
inline

Get pixel at x,y.

void FX::FXImage::setPixel ( FXint  x,
FXint  y,
FXColor  color 
)
inline

Change pixel at x,y.

bool FX::FXImage::hasAlpha ( ) const

Scan the image and return false if fully opaque.

virtual void FX::FXImage::create ( )
virtual

Create the server side pixmap, then call render() to fill it with the pixel data from the client-side buffer.

After the server-side image has been created, the client-side pixel buffer will be deleted unless IMAGE_KEEP has been specified. If the pixel buffer is not owned, i.e. the flag IMAGE_OWNED is not set, the pixel buffer will not be deleted, however the pixel buffer will be set to NULL.

Reimplemented from FX::FXId.

Reimplemented in FX::FXIcon.

virtual void FX::FXImage::detach ( )
virtual

Detach the server side pixmap from the Image.

Afterwards, the Image is left as if it never had a server-side resources.

Reimplemented from FX::FXId.

Reimplemented in FX::FXIcon.

virtual void FX::FXImage::destroy ( )
virtual

Destroy the server-side pixmap.

The client-side pixel buffer is not affected.

Reimplemented from FX::FXId.

Reimplemented in FX::FXIcon.

virtual void FX::FXImage::restore ( )
virtual

Retrieves pixels from the server-side image.

For example, to make screen snapshots, or to retrieve an image after it has been drawn into by various means.

virtual void FX::FXImage::render ( )
virtual

Render the server-side representation of the image from client-side pixels.

Normally, IMAGE_DITHER is used which causes the server-side representation to be rendered using a 16x16 ordered dither if necessary; however if IMAGE_NEAREST is used a faster (but uglier-looking), nearest neighbor algorithm is used.

Reimplemented in FX::FXIcon.

virtual void FX::FXImage::release ( )
virtual

Release the client-side pixels buffer, free it if it was owned.

If it is not owned, the image just forgets about the buffer.

virtual void FX::FXImage::resize ( FXint  w,
FXint  h 
)
virtual

Resize both client-side and server-side representations (if any) to the given width and height.

The new representations typically contain garbage after this operation and need to be re-filled.

Reimplemented from FX::FXDrawable.

Reimplemented in FX::FXIcon.

virtual void FX::FXImage::scale ( FXint  w,
FXint  h,
FXint  quality = 0 
)
virtual

Rescale pixels image to the specified width and height; this calls resize() to adjust the client and server side representations.

virtual void FX::FXImage::mirror ( bool  horizontal,
bool  vertical 
)
virtual

Mirror image horizontally and/or vertically.

virtual void FX::FXImage::rotate ( FXint  degrees)
virtual

Rotate image by degrees ccw; this calls resize() to adjust the client and server side representations if necessary.

virtual void FX::FXImage::crop ( FXint  x,
FXint  y,
FXint  w,
FXint  h,
FXColor  color = 0 
)
virtual

Crop image to given rectangle; this calls resize() to adjust the client and server side representations.

The new image may be smaller or larger than the old one; blank areas are filled with color. There must be at least one pixel of overlap between the old and the new image.

virtual void FX::FXImage::fill ( FXColor  color)
virtual

Fill image with uniform color.

virtual void FX::FXImage::fade ( FXColor  color,
FXint  factor = 255 
)
virtual

Fade image to uniform color.

virtual void FX::FXImage::xshear ( FXint  shear,
FXColor  clr = 0 
)
virtual

Shear image horizontally; the number of pixels is equal to the shear parameter times 256.

The area outside the image is filled with transparent black, unless another color is specified.

virtual void FX::FXImage::yshear ( FXint  shear,
FXColor  clr = 0 
)
virtual

Shear image vertically; the number of pixels is equal to the shear parameter times 256.

The area outside the image is filled with transparent black, unless another color is specified.

virtual void FX::FXImage::hgradient ( FXColor  left,
FXColor  right 
)
virtual

Fill horizontal gradient.

virtual void FX::FXImage::vgradient ( FXColor  top,
FXColor  bottom 
)
virtual

Fill vertical gradient.

virtual void FX::FXImage::gradient ( FXColor  topleft,
FXColor  topright,
FXColor  bottomleft,
FXColor  bottomright 
)
virtual

Fill with gradient.

virtual void FX::FXImage::blend ( FXColor  color)
virtual

Blend image over uniform color.

virtual void FX::FXImage::save ( FXStream store) const
virtual

Save object to stream.

Reimplemented from FX::FXDrawable.

virtual void FX::FXImage::load ( FXStream store)
virtual

Load object from stream.

Reimplemented from FX::FXDrawable.

Friends And Related Function Documentation

friend class FXDC
friend
friend class FXDCWindow
friend

Copyright © 1997-2005 Jeroen van der Zijp