src/ewmhicon.h

   1 /*
   2  * _NET_WM_ICON helpers for slide puzzle game
   3  * Copyright © 2023 Nick Bowler
   4  *
   5  * This program is free software: you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation, either version 3 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  17  */
  18
  19 #ifndef RRACE_EWMHICON_H_
  20 #define RRACE_EWMHICON_H_
  21
  22 /*
  23  * Define X_DISPLAY_MISSING to allow building without X11 (for test purposes)
  24  */
  25 #if !X_DISPLAY_MISSING
  26 #  include <X11/Intrinsic.h>
  27 #else
  28
  29 /* Stub types to allow compilation */
  30 typedef struct {
  31         unsigned long pixel;
  32         unsigned short red, green, blue;
  33 } XColor;
  34
  35 #endif
  36
  37 /*
  38  * Size of generated EWMH icon data (nelements argument to XChangeProperty).
  39  */
  40 #define EWMH_ICON_NELEM (2+16*16 + 2+24*24 + 2+32*32 + 2+48*48)
  41
  42 /*
  43  * For each of the n elements of the array pointed to by map, set the
  44  * 'pixel' member according to its separated red/green/blue components,
  45  * with an alpha value of 255 (opaque).
  46  *
  47  * The resulting colourmap is suitable for use with ewmh_icon_generate.
  48  */
  49 void ewmh_icon_prepare_cmap(XColor *map, unsigned n);
  50
  51 /*
  52  * Generate EWMH icon data based on a sequence of tile colours.  Internally,
  53  * this calls icon_tile16 and friends to draw each of the icon patterns.
  54  *
  55  * The sequence specifies the colour of all 9 icon tiles, beginning from the
  56  * top left in row-major order.  Each value specifies three offsets into
  57  * the provided colour map, using the 'pixel' members directly as 32-bit
  58  * ARGB colour values.
  59  *
  60  * Returns a newly-allocated buffer which is suitable for use directly with
  61  * XChangeProperty, and should be freed by the caller.
  62  *
  63  * If allocation fails, a null pointer is returned.
  64  */
  65 void *ewmh_icon_generate(const unsigned long *seq, const XColor *map);
  66
  67 #if !X_DISPLAY_MISSING
  68 /*
  69  * Check if the root window indicates support for EWMH icons.  Returns 1 if
  70  * supported, or 0 otherwise.
  71  */
  72 int ewmh_probe_wm_icon(Widget shell);
  73 #endif
  74
  75 #endif