git.hungrycats.org Git - xscreensaver/blob - hacks/spotlight.c

   1 /*
   2  * spotlight - an xscreensaver module
   3  * Copyright (c) 1999 Rick Schultz <rick@skapunx.net>
   4  *
   5  * loosely based on the BackSpace module "StefView" by Darcy Brockbank
   6  */
   7
   8 /* modified from a module from the xscreensaver distribution */
   9
  10 /*
  11  * xscreensaver, Copyright (c) 1992, 1993, 1994, 1996, 1997, 1998
  12  * Jamie Zawinski <jwz@jwz.org>
  13  *
  14  * Permission to use, copy, modify, distribute, and sell this software and its
  15  * documentation for any purpose is hereby granted without fee, provided that
  16  * the above copyright notice appear in all copies and that both that
  17  * copyright notice and this permission notice appear in supporting
  18  * documentation.  No representations are made about the suitability of this
  19  * software for any purpose.  It is provided "as is" without express or
  20  * implied warranty.
  21  */
  22
  23 /* #define DEBUG */
  24 #include <math.h>
  25 #include "screenhack.h"
  26 #include <X11/Xutil.h>
  27 #include <sys/time.h>
  28
  29 #define MINX 0.0
  30 #define MINY 0.0
  31 #define X_PERIOD 15000.0
  32 #define Y_PERIOD 12000.0
  33
  34 static int sizex, sizey; /* screen size */
  35 static int delay;        /* in case it's too fast... */
  36 static GC window_gc;
  37 #ifdef DEBUG
  38 static GC white_gc;
  39 #endif
  40 static GC buffer_gc;     /* draw in buffer, then flush to screen
  41                             to avoid flicker */
  42 static int radius;       /* radius of spotlight in pixels */
  43
  44 static Pixmap pm;        /* pixmap grabbed from screen */
  45 static Pixmap clip_pm;   /* pixmap for clipping (spotlight shape) */
  46 static Pixmap buffer;    /* pixmap for the buffer */
  47
  48 static GC clip_gc;       /* GC for the clip pixmap */
  49
  50 static int x, y, s;      /* x & y coords of buffer (upper left corner) */
  51                          /* s is the width of the buffer */
  52
  53 static int oldx, oldy, max_x_speed, max_y_speed;
  54                          /* used to keep the new buffer position
  55                             over the old spotlight image to make sure
  56                             the old image is completely erased */
  57
  58 /* The path the spotlight follows around the screen is sinusoidal.
  59    This function is fed to sin() to get the x & y coords */
  60 static long
  61 currentTimeInMs(void)
  62 {
  63   struct timeval curTime;
  64 #ifdef GETTIMEOFDAY_TWO_ARGS
  65   struct timezone tz = {0,0};
  66   gettimeofday(&curTime, &tz);
  67 #else
  68   gettimeofday(&curTime);
  69 #endif
  70   return curTime.tv_sec*1000 + curTime.tv_usec/1000.0;
  71 }
  72
  73
  74 static void
  75 init_hack (Display *dpy, Window window)
  76 {
  77   XGCValues gcv;
  78   XWindowAttributes xgwa;
  79   long gcflags;
  80   Colormap cmap;
  81   unsigned long fg, bg;
  82
  83   XGetWindowAttributes (dpy, window, &xgwa);
  84   sizex = xgwa.width;
  85   sizey = xgwa.height;
  86   cmap = xgwa.colormap;
  87   fg = get_pixel_resource ("foreground", "Foreground", dpy, cmap);
  88   bg = get_pixel_resource ("background", "Background", dpy, cmap);
  89
  90   /* read parameters, keep em sane */
  91   delay = get_integer_resource ("delay", "Integer");
  92   if (delay < 1) delay = 1;
  93   radius = get_integer_resource ("radius", "Integer");
  94   if (radius < 0) radius = 125;
  95
  96   /* do the dance */
  97   gcv.function = GXcopy;
  98   gcv.subwindow_mode = IncludeInferiors;
  99   gcflags = GCForeground | GCFunction;
 100   gcv.foreground = bg;
 101
 102 #ifdef NOPE
 103   if (use_subwindow_mode_p(xgwa.screen, window)) /* see grabscreen.c */
 104     gcflags |= GCSubwindowMode;
 105 #endif
 106   window_gc = XCreateGC(dpy, window, gcflags, &gcv);
 107
 108
 109   /* grab screen to window */
 110   grab_screen_image(xgwa.screen, window);
 111
 112   /* save screen to pixmap for copying later */
 113   pm = XCreatePixmap(dpy, window, sizex, sizey, xgwa.depth);
 114   XCopyArea(dpy, window, pm, window_gc, 0, 0, sizex, sizey, 0, 0);
 115
 116
 117   /* create buffer to reduce flicker */
 118   buffer = XCreatePixmap(dpy, window, sizex, sizey, xgwa.depth);
 119   buffer_gc = XCreateGC(dpy, buffer, gcflags, &gcv);
 120
 121   /* blank out screen */
 122   XFillRectangle(dpy, window, window_gc, 0, 0, sizex, sizey);
 123   XSetWindowBackground (dpy, window, bg);
 124
 125   /* create clip mask (so it's a circle, not a square) */
 126   clip_pm = XCreatePixmap(dpy, window, radius*4, radius*4, 1);
 127
 128   gcv.foreground = 0L;
 129   clip_gc = XCreateGC(dpy, clip_pm, gcflags, &gcv);
 130   XFillRectangle(dpy, clip_pm, clip_gc, 0, 0, radius*4, radius*4);
 131
 132   XSetForeground(dpy, clip_gc, 1L);
 133   XFillArc(dpy, clip_pm, clip_gc, radius , radius,
 134            radius*2, radius*2, 0, 360*64);
 135
 136   /* set buffer's clip mask to the one we just made */
 137   XSetClipMask(dpy, buffer_gc, clip_pm);
 138
 139   /* free everything */
 140   XFreeGC(dpy, clip_gc);
 141   XFreePixmap(dpy, clip_pm);
 142
 143   /* avoid remants */
 144   max_x_speed = max_y_speed = radius;
 145
 146 #ifdef DEBUG
 147   /* create GC with white fg */
 148   gcv.foreground = fg;
 149   white_gc = XCreateGC(dpy, window, gcflags, &gcv);
 150 #endif
 151
 152   /* initialize x and y to avoid initial `jump' across screen */
 153   x = ((1 + sin(((float)currentTimeInMs()) / X_PERIOD * 2. * M_PI))/2.0)
 154     * (sizex - s/2) -s/4  + MINX;
 155   y = ((1 + sin(((float)currentTimeInMs()) / Y_PERIOD * 2. * M_PI))/2.0)
 156     * (sizey - s/2) -s/4  + MINY;
 157
 158 }
 159
 160
 161 /*
 162  * perform one iteration
 163  */
 164 static void
 165 onestep (Display *dpy, Window window)
 166 {
 167     long now;
 168
 169     /* clear buffer */
 170     XFillRectangle(dpy, buffer, buffer_gc, x, y, s, s);
 171
 172
 173 #define nrnd(x) (random() % (x))
 174
 175     oldx = x;
 176     oldy = y;
 177
 178     s = radius *4 ;   /* s = width of buffer */
 179
 180     now = currentTimeInMs();
 181
 182     /* find new x,y */
 183     x = ((1 + sin(((float)now) / X_PERIOD * 2. * M_PI))/2.0)
 184       * (sizex - s/2) -s/4  + MINX;
 185     y = ((1 + sin(((float)now) / Y_PERIOD * 2. * M_PI))/2.0)
 186       * (sizey - s/2) -s/4  + MINY;
 187
 188     /* limit change in x and y to buffer width */
 189     if ( x < (oldx - max_x_speed) ) x = oldx - max_x_speed;
 190     if ( x > (oldx + max_x_speed) ) x = oldx + max_x_speed;
 191     if ( y < (oldy - max_y_speed) ) y = oldy - max_y_speed;
 192     if ( y > (oldy + max_y_speed) ) y = oldy + max_y_speed;
 193
 194     /* copy area of screen image (pm) to buffer
 195        Clip to a circle */
 196     XSetClipOrigin(dpy, buffer_gc, x,y);
 197     XCopyArea(dpy, pm, buffer, buffer_gc, x, y, s, s, x, y);
 198     /* copy buffer to screen (window) */
 199     XCopyArea(dpy, buffer, window, window_gc, x , y, s, s, x, y);
 200
 201 #ifdef DEBUG
 202     /* draw a box around the buffer */
 203     XDrawLine(dpy, window, white_gc, x, y, x+s, y);
 204     XDrawLine(dpy, window, white_gc, x, y, x, y+s);
 205     XDrawLine(dpy, window, white_gc, x+s, y, x+s, y+s);
 206     XDrawLine(dpy, window, white_gc, x, y+s, x+s, y+s);
 207 #endif
 208
 209 }
 210
 211 \f
 212 char *progclass = "Spotlight";
 213
 214 char *defaults [] = {
 215   "*dontClearRoot:              True",
 216
 217 #ifdef __sgi    /* really, HAVE_READ_DISPLAY_EXTENSION */
 218   "*visualID:                   Best",
 219 #endif
 220
 221   "*delay:                      10000",
 222   "*radius:                     125",
 223   0
 224 };
 225
 226 XrmOptionDescRec options [] = {
 227   { "-delay",           ".delay",               XrmoptionSepArg, 0 },
 228   { "-radius",          ".radius",              XrmoptionSepArg, 0 },
 229   { 0, 0, 0, 0 }
 230 };
 231
 232 void
 233 screenhack (Display *dpy, Window window)
 234 {
 235   init_hack (dpy, window);
 236   while (1) {
 237     onestep(dpy, window);
 238     XSync(dpy, False);
 239     if (delay) usleep (delay);
 240     screenhack_handle_events (dpy);
 241   }
 242 }
 243