git.hungrycats.org Git - xscreensaver/blob - hacks/xlockmoreI.h

   1 /* xlockmore.h --- xscreensaver compatibility layer for xlockmore modules.
   2  * xscreensaver, Copyright (c) 1997-2014 Jamie Zawinski <jwz@jwz.org>
   3  *
   4  * Permission to use, copy, modify, distribute, and sell this software and its
   5  * documentation for any purpose is hereby granted without fee, provided that
   6  * the above copyright notice appear in all copies and that both that
   7  * copyright notice and this permission notice appear in supporting
   8  * documentation.  No representations are made about the suitability of this
   9  * software for any purpose.  It is provided "as is" without express or
  10  * implied warranty.
  11  *
  12  * See xlockmore.h and xlockmore.c.
  13  */
  14
  15 #ifndef __XLOCKMORE_INTERNAL_H__
  16 #define __XLOCKMORE_INTERNAL_H__
  17
  18 #include <time.h>
  19
  20 #include "screenhackI.h"
  21
  22 #ifdef HAVE_XSHM_EXTENSION
  23 # include "xshm.h"
  24 #endif /* HAVE_XSHM_EXTENSION */
  25
  26
  27 typedef struct ModeInfo ModeInfo;
  28
  29 #ifdef USE_GL
  30
  31 /* I'm told that the Sun version of OpenGL needs to have the constant
  32    SUN_OGL_NO_VERTEX_MACROS defined in order for morph3d to compile
  33    (the number of arguments to the glNormal3f macro changes...)
  34    Verified with gcc 2.7.2.2 and Sun cc 4.2 with OpenGL 1.1.1 dev 4
  35    on Solaris 2.5.1.
  36  */
  37 # ifndef HAVE_MESA_GL
  38 #  if defined(__sun) && defined(__SVR4) /* Solaris */
  39 #   define SUN_OGL_NO_VERTEX_MACROS 1
  40 #  endif /* Solaris */
  41 # endif /* !HAVE_MESA_GL */
  42
  43 # ifdef HAVE_COCOA
  44 #  ifndef USE_IPHONE
  45 #   include <OpenGL/gl.h>
  46 #   include <OpenGL/glu.h>
  47 #  endif
  48 # elif defined(HAVE_ANDROID)
  49 #  include <GLES/gl.h>
  50 # else
  51 #  include <GL/gl.h>
  52 #  include <GL/glu.h>
  53 #  include <GL/glx.h>
  54 # endif
  55
  56 # ifdef HAVE_JWZGLES
  57 #  include "jwzgles.h"
  58 # endif /* HAVE_JWZGLES */
  59
  60
  61   extern GLXContext *init_GL (ModeInfo *);
  62   extern void xlockmore_reset_gl_state(void);
  63   extern void clear_gl_error (void);
  64   extern void check_gl_error (const char *type);
  65
  66   extern Visual *xlockmore_pick_gl_visual (Screen *);
  67   extern Bool xlockmore_validate_gl_visual (Screen *, const char *, Visual *);
  68
  69 #endif /* !USE_GL */
  70
  71 /* These are only used in GL mode, but I don't understand why XCode
  72    isn't seeing the prototypes for them in glx/fps-gl.c... */
  73 extern void do_fps (ModeInfo *);
  74 extern void xlockmore_gl_compute_fps (Display *, Window, fps_state *, void *);
  75 extern void xlockmore_gl_draw_fps (ModeInfo *);
  76 # define do_fps xlockmore_gl_draw_fps
  77
  78
  79 extern void xlockmore_setup (struct xscreensaver_function_table *, void *);
  80 extern void xlockmore_do_fps (Display *, Window, fps_state *, void *);
  81
  82
  83 /* Compatibility with the xlockmore RNG API
  84    (note that the xlockmore hacks never expect negative numbers.)
  85  */
  86 #define LRAND()                 ((long) (random() & 0x7fffffff))
  87 #define NRAND(n)                ((int) (LRAND() % (n)))
  88 #define MAXRAND                 (2147483648.0) /* unsigned 1<<31 as a float */
  89 #define SRAND(n)                /* already seeded by screenhack.c */
  90
  91
  92 struct ModeInfo {
  93   struct xlockmore_function_table *xlmft;
  94   Display *dpy;
  95   Window window;
  96   Bool root_p;
  97   int num_screens;
  98   int screen_number;
  99   int npixels;
 100   unsigned long *pixels;
 101   XColor *colors;
 102   Bool writable_p;
 103   unsigned long white;
 104   unsigned long black;
 105   XWindowAttributes xgwa;
 106   GC gc;
 107   long pause;
 108   Bool fullrandom;
 109   long cycles;
 110   long batchcount;
 111   long size;
 112   Bool threed;
 113   long threed_left_color;
 114   long threed_right_color;
 115   long threed_both_color;
 116   long threed_none_color;
 117   long threed_delta;
 118   Bool wireframe_p;
 119   Bool is_drawn;
 120
 121   /* Used only by OpenGL programs, since FPS is tricky there. */
 122   fps_state *fpst;
 123   Bool fps_p;
 124   unsigned long polygon_count;  /* These values are for -fps display only */
 125   double recursion_depth;
 126
 127 #ifdef HAVE_XSHM_EXTENSION
 128   Bool use_shm;
 129   XShmSegmentInfo shm_info;
 130 #endif
 131 };
 132
 133 typedef enum {  t_String, t_Float, t_Int, t_Bool } xlockmore_type;
 134
 135 typedef struct {
 136   void *var;
 137   char *name;
 138   char *classname;
 139   char *def;
 140   xlockmore_type type;
 141 } argtype;
 142
 143 typedef struct {
 144   char *opt;
 145   char *desc;
 146 } OptionStruct;
 147
 148 typedef struct {
 149   int numopts;
 150   XrmOptionDescRec *opts;
 151   int numvarsdesc;
 152   argtype *vars;
 153   OptionStruct *desc;
 154 } ModeSpecOpt;
 155
 156 struct xlockmore_function_table {
 157   const char *progclass;
 158   const char *defaults;
 159   Bool want_writable_colors;
 160   enum { color_scheme_default, color_scheme_uniform,
 161          color_scheme_smooth, color_scheme_bright }
 162     desired_color_scheme;
 163   void (*hack_init) (ModeInfo *);
 164   void (*hack_draw) (ModeInfo *);
 165   void (*hack_reshape) (ModeInfo *, int, int);
 166   void (*hack_refresh) (ModeInfo *);
 167   void (*hack_free) (ModeInfo *);
 168   Bool (*hack_handle_events) (ModeInfo *, XEvent *);
 169   ModeSpecOpt *opts;
 170
 171   unsigned int screen_count; /* Only used on the OS X and iOS ports. */
 172 };
 173
 174 #endif /* __XLOCKMORE_INTERNAL_H__ */