| ximage(3x) | AfterStep X11 window manager | ximage(3x) |
ximage - functionality for displaying ASImages on X display libAfterImage/ximage.h
- Defines conversion to and from XImages and Pixmaps.
ximage2asimage() - convert XImage structure into ASImage
pixmap2asimage() - convert X11 pixmap into ASImage asimage2ximage() -
convert ASImage into XImage asimage2mask_ximage() - convert alpha channel of
ASImage into XImage asimage2pixmap() - convert ASImage into Pixmap (
possibly using
precreated XImage ) asimage2mask() - convert alpha channel of ASImage into 1
bit
mask Pixmap.
Other libAfterImage modules :
ascmap.h asfont.h asimage.h asvisual.h blender.h export.h
import.h transform.h ximage.h
Sasha Vasko <sasha at aftercode dot net>
libAfterImage/picture_ximage2asimage()
ASImage *picture_ximage2asimage ( struct ASVisual *asv,
XImage * xim, XImage *alpha_xim,
unsigned int compression );
pointer to newly allocated ASImage, containing encoded data, on
success. NULL on failure.
picture_ximage2asimage will attempt to create new ASImage with the
same dimensions as supplied XImage. If both XImages are supplied - they must
have same dimensions. XImage will be decoded based on supplied ASVisual, and
resulting scanlines will be encoded into ASImage.
libAfterImage/ximage2asimage()
- same as picture_ximage2asimage with alpha_ximage set to NULL. Supplied for compatibility with older versions and for convenience.
ASImage *ximage2asimage ( struct ASVisual *asv, XImage * xim,
unsigned int compression );
pointer to newly allocated ASImage, containing encoded data, on
success. NULL on failure.
ASImage *pixmap2ximage( ASVisual *asv, Pixmap p, int x, int y,
unsigned int width, unsigned int height,
unsigned long plane_mask,
unsigned int compression);
pointer to newly allocated ASImage, containing data in XImage
format, on success. NULL on failure.
pixmap2ximage will obtain XImage of the requested area of the X
Pixmap, and it will attach it to newly created ASImage using alt.ximage
member. After that newly created ASImage could be used in any
transformations.
libAfterImage/pixmap2asimage()
ASImage *pixmap2asimage ( struct ASVisual *asv, Pixmap p,
int x, int y,
unsigned int width,
unsigned int height,
unsigned long plane_mask,
Bool keep_cache,
unsigned int compression );
pointer to newly allocated ASImage, containing encoded data, on
success. NULL on failure.
same as picture2asimage() with alpha pixmap set to None. Supplied
for compatibility and convenience.
libAfterImage/picture2asimage()
ASImage *picture2asimage (struct ASVisual *asv,
Pixmap rgb, Pixmap a,
int x, int y,
unsigned int width,
unsigned int height,
unsigned long plane_mask,
Bool keep_cache,
unsigned int compression );
pointer to newly allocated ASImage, containing encoded data, on
success. NULL on failure.
picture2asimage will obtain XImage of the requested area of the X
Pixmap, If alpha channel pixmap is supplied - it will be used to encode
ASImage's alpha channel. Alpha channel pixmap must be either 8 or 1 bit
deep, and it must have the same dimensions as main Pixmap.
libAfterImage/asimage2ximage()
XImage *asimage2ximage (struct ASVisual *asv, ASImage *im);
On success returns newly created and encoded XImage of the same
colordepth as the supplied ASVisual. NULL on failure.
asimage2ximage() creates new XImage of the exact same size as
supplied ASImage, and depth of supplied ASVisual. REd, Green and Blue
channels of ASImage then gets decoded, and encoded into XImage. Missing
scanlines get filled with black color.
Returned pointer to XImage will also be stored in
im->alt.ximage, and It will be destroyed when XImage is destroyed, or
reused in any subsequent calls to asimage2ximage(). If any other behaviour
is desired - make sure you set im->alt.ximage to NULL, to dissociate
XImage object from ASImage.
create_visual_ximage()
libAfterImage/asimage2alpha_ximage()
XImage *asimage2alpha_ximage (struct ASVisual *asv,
ASImage *im, Bool bitmap);
On success returns newly created and encoded XImage of the depth 1
or 8. NULL on failure.
asimage2alpha_ximage() creates new XImage of the exact same size
as supplied ASImage, and depth 1 or 8. Alpha channels of ASImage then gets
decoded, and encoded into XImage. In case requested depth is 1 then alpha
channel is interpreted like so: 127 or greater is encoded as 1, otherwise as
0. Missing scanlines get filled with 1s as they signify absence of mask.
Returned pointer to XImage will also be stored in
im->alt.mask_ximage, and It will be destroyed when XImage is destroyed,
or reused in any subsequent calls to asimage2mask_ximage(). If any other
behaviour is desired - make sure you set im->alt.mask_ximage to NULL, to
dissociate XImage object from ASImage.
libAfterImage/asimage2mask_ximage()
- same as asimage2alpha_ximage(). Supplied for convenience and compatibility with older versions.
XImage *asimage2mask_ximage (struct ASVisual *asv, ASImage *im);
On success returns newly created and encoded XImage of the depth
1. NULL on failure.
libAfterImage/asimage2pixmap()
Bool asimage2drawable( struct ASVisual *asv, Drawable d, ASImage
*im,
GC gc,
int src_x, int src_y, int dest_x, int dest_y,
unsigned int width, unsigned int height,
Bool use_cached);
On success returns True.
asimage2drawable() creates will copy portion of ASImage onto the X
Drawable. It checks if it needs to encode XImage from ASImage data, and
calls asimage2ximage() if yes, it has to. It then supplied gc or DefaultGC
of the screen to transfer XImage to the server. Missing scanlines get filled
with black color.
asimage2ximage() asimage2pixmap() create_visual_pixmap()
libAfterImage/asimage2pixmap()
Pixmap asimage2pixmap ( struct ASVisual *asv, Window root,
ASImage *im, GC gc, Bool use_cached);
On success returns newly pixmap of the same colordepth as
ASVisual. None on failure.
asimage2pixmap() creates new pixmap of exactly same size as
supplied ASImage. It then calls asimage2drawable to copy entire content of
the ASImage onto that created pixmap.
asview.c: ASView.5
asimage2ximage() asimage2drawable() create_visual_pixmap()
libAfterImage/asimage2mask()
Pixmap asimage2mask ( struct ASVisual *asv, Window root,
ASImage *im, GC gc, Bool use_cached); asv - pointer to valid ASVisual
structure root - root window of destination screen im - source ASImage gc -
precreated GC for 1 bit deep drawables to use for
XImage transfer. If NULL, asimage2mask() will create one. use_cached - If
True will make asimage2mask() to use mask XImage
attached to ASImage, instead of creating new one. Only
works if ASImage->alt.mask_ximage data member is not NULL.
On success returns newly created pixmap of the colordepth 1. None
on failure.
asimage2mask() creates new pixmap of exactly same size as supplied
ASImage. It then calls asimage2mask_ximage(). It then uses supplied gc, or
creates new gc, to transfer XImage to the server and put it on Pixmap.
Missing scanlines get filled with 1s.
asimage2mask_ximage()
| AfterStep v.2.2.12 | 3rd Berkeley Distribution |