ximage(3x)

📦

version 2.2.12 · 7 versions

2.2.12 · ubuntu resolute, ubuntu stonking (latest)
2.2.12 · nixos 26.05
2.2.12 · ubuntu questing
2.2.12 · ubuntu jammy
2.2.12 · ubuntu noble
2.2.12 · debian bookworm
2.2.12 · debian trixie

✨ NAME ✨

okay so bestie, welcome to ximage(3x) — yep, that's the section 3 page from the AfterStep X11 window manager, and it's all about the libAfterImage module that hangs out in libAfterImage/ximage.h. 💖

ximage — functionality for displaying ASImages on X display

libAfterImage/ximage.h

🌈 NAME — `ximage` 🌈

ok so this bit defines the whole conversion pipeline both ways: X stuff into ASImages, and ASImages back out into X stuff. Defines conversion to and from XImages and Pixmaps. ✨

💅 DESCRIPTION 💅

here's the whole friend group, one by one, and what each of them does:

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.

🔍 SEE ALSO 🔍

Other libAfterImage modules, aka the rest of the extended universe 🦋:

ascmap.h asfont.h asimage.h asvisual.h blender.h export.h import.h transform.h ximage.h

👑 AUTHOR 👑

Sasha Vasko <sasha at aftercode dot net> — the icon who wrote all this, no cap. 🫶

📁 `libAfterImage/picture_ximage2asimage()`

✨ NAME ✨ — `picture_ximage2asimage()`

🎀 SYNOPSIS 🎀

ASImage *picture_ximage2asimage ( struct ASVisual *asv,
                                  XImage * xim, XImage *alpha_xim,
                                  unsigned int compression );

🧚 INPUTS 🧚

asv — pointer to valid ASVisual structure
xim — source XImage
alpha_xim — source XImage for Alpha channel
compression — degree of compression of resulting ASImage.

🍓 RETURN VALUE 🍓

pointer to newly allocated ASImage, containing encoded data, on success. NULL on failure.

💜 DESCRIPTION 💜

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. ✨

fr fr: if you hand it two XImages, they must match in size. no exceptions, bestie.

📁 `libAfterImage/ximage2asimage()`

✨ NAME ✨ — `ximage2asimage()`

same as picture_ximage2asimage with alpha_ximage set to NULL. Supplied for compatibility with older versions and for convenience. 🌸

🎀 SYNOPSIS 🎀

ASImage *ximage2asimage ( struct ASVisual *asv, XImage * xim,
                          unsigned int compression );

🧚 INPUTS 🧚

asv — pointer to valid ASVisual structure
xim — source XImage
compression — degree of compression of resulting ASImage.

🍓 RETURN VALUE 🍓

pointer to newly allocated ASImage, containing encoded data, on success. NULL on failure.

💜 DESCRIPTION 💜

(no alpha, no drama — it's the streamlined version of the big one up top 🫶)

📁 `libAfterImage/pixmap2asimage()`

✨ NAME ✨ — `pixmap2asimage()`

🎀 SYNOPSIS 🎀

ASImage *pixmap2ximage( ASVisual *asv, Pixmap p, int x, int y,
                        unsigned int width, unsigned int height,
                           unsigned long plane_mask,
                        unsigned int compression);

🧚 INPUTS 🧚

asv — pointer to valid ASVisual structure
p — source Pixmap
x, y, width, height — rectangle on Pixmap to be encoded into ASImage.
plane_mask — limits color planes to be copied from Pixmap.
keep_cache — indicates if we should keep XImage, used to copy image data from the X server, and attached it to ximage member of resulting ASImage.
compression — degree of compression of resulting ASImage.

🍓 RETURN VALUE 🍓

pointer to newly allocated ASImage, containing data in XImage format, on success. NULL on failure.

💜 DESCRIPTION 💜

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()`

✨ NAME ✨ — `pixmap2asimage()`

🎀 SYNOPSIS 🎀

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 );

🧚 INPUTS 🧚

asv — pointer to valid ASVisual structure
p — source Pixmap
x, y, width, height — rectangle on Pixmap to be encoded into ASImage.
plane_mask — limits color planes to be copied from Pixmap.
keep_cache — indicates if we should keep XImage, used to copy image data from the X server, and attached it to ximage member of resulting ASImage.
compression — degree of compression of resulting ASImage.

🍓 RETURN VALUE 🍓

pointer to newly allocated ASImage, containing encoded data, on success. NULL on failure.

💜 DESCRIPTION 💜

same as picture2asimage() with alpha pixmap set to None. Supplied for compatibility and convenience. 😌

📁 `libAfterImage/picture2asimage()`

✨ NAME ✨ — `picture2asimage()`

🎀 SYNOPSIS 🎀

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 );

🧚 INPUTS 🧚

asv — pointer to valid ASVisual structure
rgb — source Pixmap for red, green and blue channels
a — source Pixmap for the alpha channel
x, y, width, height — rectangle on Pixmap to be encoded into ASImage.
plane_mask — limits color planes to be copied from Pixmap.
keep_cache — indicates if we should keep XImage, used to copy image data from the X server, and attached it to ximage member of resulting ASImage.
compression — degree of compression of resulting ASImage.

🍓 RETURN VALUE 🍓

pointer to newly allocated ASImage, containing encoded data, on success. NULL on failure.

💜 DESCRIPTION 💜

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. 💅

not me stressing the rules again but: alpha pixmap = 8 or 1 bit deep AND same dimensions as the main Pixmap. that's the vibe check, bestie. ✅

📁 `libAfterImage/asimage2ximage()`

✨ NAME ✨ — `asimage2ximage()`

🎀 SYNOPSIS 🎀

XImage  *asimage2ximage  (struct ASVisual *asv, ASImage *im);

🧚 INPUTS 🧚

asv — pointer to valid ASVisual structure
im — source ASImage

🍓 RETURN VALUE 🍓

On success returns newly created and encoded XImage of the same colordepth as the supplied ASVisual. NULL on failure.

💜 DESCRIPTION 💜

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. 🖤

🌟 NOTES 🌟

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. ⚠️

the way this sneaky little pointer tucks itself into im->alt.ximage... if you want your own life, set it to NULL. periodt.

🔍 SEE ALSO 🔍

create_visual_ximage()

📁 `libAfterImage/asimage2alpha_ximage()`

✨ NAME ✨ — `asimage2alpha_ximage()`

🎀 SYNOPSIS 🎀

XImage  *asimage2alpha_ximage (struct ASVisual *asv,
                               ASImage *im, Bool bitmap);

🧚 INPUTS 🧚

asv — pointer to valid ASVisual structure
im — source ASImage
bitmap — if True resulting XImage will have depth of 1 bit — traditional X mask; otherwise it will have depth of 8 (useful for XFree86 RENDER extension)

🍓 RETURN VALUE 🍓

On success returns newly created and encoded XImage of the depth 1 or 8. NULL on failure.

💜 DESCRIPTION 💜

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. ✨

🌟 NOTES 🌟

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()`

✨ NAME ✨ — `asimage2mask_ximage()`

same as asimage2alpha_ximage(). Supplied for convenience and compatibility with older versions. 🌸

🎀 SYNOPSIS 🎀

XImage  *asimage2mask_ximage (struct ASVisual *asv, ASImage *im);

🧚 INPUTS 🧚

asv — pointer to valid ASVisual structure
im — source ASImage

🍓 RETURN VALUE 🍓

On success returns newly created and encoded XImage of the depth 1. NULL on failure.

📁 `libAfterImage/asimage2pixmap()`

✨ NAME ✨ — `asimage2pixmap()`

🎀 SYNOPSIS 🎀

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);

🧚 INPUTS 🧚

asv — pointer to valid ASVisual structure
d — destination drawable — Pixmap or Window
im — source ASImage
gc — precreated GC to use for XImage transfer. If NULL, asimage2drawable() will use DefaultGC.
src_x — Specifies the offset in X from the left edge of the image defined by the ASImage structure.
src_y — Specifies the offset in Y from the top edge of the image defined by the ASImage structure.
dest_x,dest_y — Specify the x and y coordinates, which are relative to the origin of the drawable and are the coordinates of the subimage.
width,height — Specify the width and height of the subimage, which define the dimensions of the rectangle.
use_cached — If True will make asimage2pixmap() to use XImage attached to ASImage, instead of creating new one. Only works if ASImage->ximage data member is not NULL.

🍓 RETURN VALUE 🍓

On success returns True.

💜 DESCRIPTION 💜

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. 👑

🔍 SEE ALSO 🔍

asimage2ximage() asimage2pixmap() create_visual_pixmap()

📁 `libAfterImage/asimage2pixmap()`

✨ NAME ✨ — `asimage2pixmap()`

🎀 SYNOPSIS 🎀

Pixmap   asimage2pixmap  ( struct ASVisual *asv, Window root,
                           ASImage *im, GC gc, Bool use_cached);

✨ INPUTS ✨

okay so here's the lil shopping list of what you gotta hand over, no substitutions bestie 💅

asv — pointer to a valid ASVisual structure 🫶
root — root window of the destination screen 🌸
im — the source ASImage (the pic in question, the moment itself) 💖
gc — a precreated GC to use for the XImage transfer. If it's NULL, asimage2pixmap() will just use DefaultGC instead. no biggie ✨
use_cached — if True, this makes asimage2pixmap() use the XImage attached to the ASImage instead of making a brand new one. ⚠️ it only works if the ASImage->ximage data member is not NULL — so like, check first, don't just yolo it 🙈

💫 RETURN VALUE 💫

slay on success, it hands you back a newly pixmap with the exact same colordepth as ASVisual. 👑

and on failure? None. literally nothing. the void. 💀

🌈 DESCRIPTION 🌈

okay so asimage2pixmap() makes a new pixmap that's exactly the same size as the ASImage you gave it. then it calls asimage2drawable to copy the entire content of the ASImage onto that freshly created pixmap. whole thing. every pixel. no crumbs left behind. ✨

🎀 EXAMPLE 🎀

live footage of it being used irl:

asview.c: ASView.5

🦋 SEE ALSO 🦋

go read these too, i'm obsessed with them fr fr:

asimage2ximage()
asimage2drawable()
create_visual_pixmap()
libAfterImage/asimage2mask()

👑 NAME `asimage2mask()` 👑

📜 SYNOPSIS 📜

Pixmap   asimage2mask ( struct ASVisual *asv, Window root,
                        ASImage *im, GC gc, Bool use_cached);

💖 the arg breakdown 💖

asv — pointer to a valid ASVisual structure
root — root window of the destination screen
im — source ASImage
gc — a precreated GC for 1 bit deep drawables, used for the XImage transfer. If it's NULL, asimage2mask() will create one itself. girlboss behaviour 💅
use_cached — if True, asimage2mask() will use the mask XImage attached to the ASImage instead of creating a new one. ⚠️ only works if the ASImage->alt.mask_ximage data member is not NULL.

⭐ RETURN VALUE ⭐

on success you get a newly created pixmap with the colordepth 1. yes queen, one bit and thriving. 👑

on failure: None. that's it. that's the whole story. 😭

🌸 DESCRIPTION 🌸

so asimage2mask() creates a new pixmap that is exactly the same size as the ASImage you supplied. then it calls asimage2mask_ximage(). ✨

after that it takes the gc you gave it — or makes a new gc if you didn't — and uses it to transfer the XImage over to the server and put it onto the Pixmap. 🚚💨

oh and heads up: missing scanlines get filled with 1s. that's just how it do. no cap. 🩹

🔥 SEE ALSO 🔥

asimage2mask_ximage()

<div align="center">this masterpiece comes to you from the 3rd Berkeley Distribution, riding with AfterStep v.2.2.12, and it's the ximage(3x) page you just read every last crumb of. go forth and mask, bestie 🫶💜🧚‍♀️</div>

📦 where this page comes from

ubuntu resolute: libafterimage-dev 2.2.12-19 · GPL-2.0-or-later
ubuntu stonking: libafterimage-dev 2.2.12-19 · GPL-2.0-or-later
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on 2026-11-03: a language model's rewrite of the original, under its terms

ximage(3x)

✨ NAME ✨

🌈 NAME — ximage 🌈

💅 DESCRIPTION 💅

🔍 SEE ALSO 🔍

👑 AUTHOR 👑

📁 libAfterImage/picture_ximage2asimage()

✨ NAME ✨ — picture_ximage2asimage()

🎀 SYNOPSIS 🎀

🧚 INPUTS 🧚

🍓 RETURN VALUE 🍓

💜 DESCRIPTION 💜

📁 libAfterImage/ximage2asimage()

✨ NAME ✨ — ximage2asimage()

🎀 SYNOPSIS 🎀

🧚 INPUTS 🧚

🍓 RETURN VALUE 🍓

💜 DESCRIPTION 💜

📁 libAfterImage/pixmap2asimage()

✨ NAME ✨ — pixmap2asimage()

🎀 SYNOPSIS 🎀

🧚 INPUTS 🧚

🍓 RETURN VALUE 🍓

💜 DESCRIPTION 💜

📁 libAfterImage/pixmap2asimage()

✨ NAME ✨ — pixmap2asimage()

🎀 SYNOPSIS 🎀

🧚 INPUTS 🧚

🍓 RETURN VALUE 🍓

💜 DESCRIPTION 💜

📁 libAfterImage/picture2asimage()

✨ NAME ✨ — picture2asimage()

🎀 SYNOPSIS 🎀

🧚 INPUTS 🧚

🍓 RETURN VALUE 🍓

💜 DESCRIPTION 💜

📁 libAfterImage/asimage2ximage()

✨ NAME ✨ — asimage2ximage()

🎀 SYNOPSIS 🎀

🧚 INPUTS 🧚

🍓 RETURN VALUE 🍓

💜 DESCRIPTION 💜

🌟 NOTES 🌟

🔍 SEE ALSO 🔍

📁 libAfterImage/asimage2alpha_ximage()

✨ NAME ✨ — asimage2alpha_ximage()

🎀 SYNOPSIS 🎀

🧚 INPUTS 🧚

🍓 RETURN VALUE 🍓

💜 DESCRIPTION 💜

🌟 NOTES 🌟

📁 libAfterImage/asimage2mask_ximage()

✨ NAME ✨ — asimage2mask_ximage()

🎀 SYNOPSIS 🎀

🧚 INPUTS 🧚

🍓 RETURN VALUE 🍓

📁 libAfterImage/asimage2pixmap()

✨ NAME ✨ — asimage2pixmap()

🎀 SYNOPSIS 🎀

🧚 INPUTS 🧚

🍓 RETURN VALUE 🍓

💜 DESCRIPTION 💜

🔍 SEE ALSO 🔍

📁 libAfterImage/asimage2pixmap()

✨ NAME ✨ — asimage2pixmap()

🎀 SYNOPSIS 🎀

✨ INPUTS ✨

💫 RETURN VALUE 💫

🌈 DESCRIPTION 🌈

🎀 EXAMPLE 🎀

🦋 SEE ALSO 🦋

👑 NAME asimage2mask() 👑

📜 SYNOPSIS 📜

💖 the arg breakdown 💖

⭐ RETURN VALUE ⭐

🌸 DESCRIPTION 🌸

🔥 SEE ALSO 🔥

🌈 NAME — `ximage` 🌈

📁 `libAfterImage/picture_ximage2asimage()`

✨ NAME ✨ — `picture_ximage2asimage()`

📁 `libAfterImage/ximage2asimage()`

✨ NAME ✨ — `ximage2asimage()`

📁 `libAfterImage/pixmap2asimage()`

✨ NAME ✨ — `pixmap2asimage()`

📁 `libAfterImage/pixmap2asimage()`

✨ NAME ✨ — `pixmap2asimage()`

📁 `libAfterImage/picture2asimage()`

✨ NAME ✨ — `picture2asimage()`

📁 `libAfterImage/asimage2ximage()`

✨ NAME ✨ — `asimage2ximage()`

📁 `libAfterImage/asimage2alpha_ximage()`

✨ NAME ✨ — `asimage2alpha_ximage()`

📁 `libAfterImage/asimage2mask_ximage()`

✨ NAME ✨ — `asimage2mask_ximage()`

📁 `libAfterImage/asimage2pixmap()`

✨ NAME ✨ — `asimage2pixmap()`

📁 `libAfterImage/asimage2pixmap()`

✨ NAME ✨ — `asimage2pixmap()`

👑 NAME `asimage2mask()` 👑