author Sam Lantinga
Sun, 04 Jan 2004 17:04:54 +0000
changeset 770 ac44ddb84f6f
parent 753 b14fdadd8311
child 821 30168104389f
permissions -rw-r--r--
*** empty log message ***
     1 README by Mike Gorchak <>, <>
     2 Last changed at 30 Sep 2003.
     4 ======================================================================
     5 Table of Contents:
     7 1. OpenGL.
     8 2. Wheel and multi-button mouses.
     9 3. CDROM handling issues.
    10 4. Hardware video overlays.
    11 5. Shared library building.
    12 6. Some building issues.
    13 7. Environment variables.
    15 ======================================================================
    16 OpenGL:
    18     OpenGL works well and is stable, but fullscreen mode has not  been
    19 heavily tested yet.
    20     If you have QNX RtP version 6.1.0 or above you must  download  the
    21 Photon3D runtime from or install it from the
    22 public repository or the  public CD, available  with  QNX. OS versions
    23 below 6.1.0 are not supported.
    24     When creating an OpenGL context, software renderer mode is artifi-
    25 cially selected (QSSL made acceleration  only  for  Voodoo  boards  in
    26 fullscreen mode, sorry but I don't have this board  to  test  OpenGL -
    27 maybe it works or maybe not :)). If you  want  acceleration - you  can
    28 remove one line in the source code: find the  file SDL_ph_image.c  and
    29 remove the following
    31     OGLAttrib[OGLargc++]=PHOGL_ATTRIB_FORCE_SW;
    33 line in the ph_SetupOpenGLContext() function or change the argument to
    36 ======================================================================
    37 Wheel and multi-button mouses:
    39     Photon emits  keyboard  events (key up and down)  when  the  mouse
    40 wheel is moved. The key_scan field appears valid, and it contains zero.
    41 That is a basic method of detecting  mouse  wheel events under Photon.
    42 It looks like a hack, but it works for me :) on various PC  configura-
    43 tions.
    45 I've tested it on:
    47 1. Genius Optical NetScroll/+ (1 wheel)
    48 2. A4Tech Optical  GreatEye  WheelMouse,  model: WOP-35. (2 wheels + 2
    49    additional buttons). The wheel for vertical scrolling works as usu-
    50    al, but the second wheel for horizontal scrolling emits two sequen-
    51    tial events up or down, so it can provide faster scrolling than the
    52    first wheel. Additional buttons don't emit any events, but it looks
    53    like they're handled by photon in an unusual  way - like  click  to
    54    front, but works not with any window, looks like bug-o-feature :).
    56 ======================================================================
    57 CDROM handling issues:
    59     Access to CDROM can only be  provided  with  'root'  privileges. I
    60 can't do anything about that, /dev/cd0 has brw------- permissions  and
    61 root:root rights.
    63 ======================================================================
    64 Hardware video overlays:
    66     Overlays can flicker  during  window  movement,  resizing, etc. It
    67 happens because the photon driver updates the real window contents be-
    68 hind the overlay, then draws the temporary chroma key color  over  the
    69 window contents. It can be done without using the chroma key but  that
    70 causes the overlay to always be on top. So  flickering  during  window
    71 movement is preferred instead.
    72     Double buffering code is temporarily disabled in the photon driver
    73 code, because on my GF2-MX it can accidentally cause a buffer  switch,
    74 which causes the old frame to show. S3 Savage4 has the  same  problem,
    75 but ATI Rage 128 doesn't. I think it can be fixed later. Current  code
    76 works very well, so maybe double buffering is not needed right now.
    77     Something strange happens when you try to move the window with the
    78 overlay beyond the left border  of the screen. The  overlay  tries  to
    79 stay at position x=0, but when attempting to move it  a  bit  more  it
    80 jumps to position x=-60 (on GF2-MX, on ATI Rage128 this  value  a  bit
    81 smaller). It's really strange, looks  like  the  overlay  doesn't like
    82 negative coordinates.
    84 =======================================================================
    85 Shared library building:
    87     A shared library can be built, but before running  the
    88 script you must manually delete the libtool.m4 stuff from the acinclu-
    89 de.m4 file (it comes after the ESD detection code up to the end of the
    90 file), because the libtool stuff in the acinclude.m4 file is very  old
    91 in SDL distribution before the version 1.2.7 and doesn't know anything
    92 about QNX. SDL 1.2.7 distribution contain  the  new libtool.m4 script,
    93 but anyway  it  is  broken :), Just  remove  it, then  run "libtoolize
    94 --force --copy",  delete the file aclocal.m4 and after  that  run  the
    95 script.
    97 ======================================================================
    98 Some building issues:
   100     Feel free to not use the --disable-shared configure option if you'
   101 ve read the above comment about 'Shared  library  building'. Otherwise
   102 this  option  is  strongly  recommended, as  without it the sdl-config
   103 script will be broken.
   105     Run the configure script without x11 support, e.g.:
   107     a) for OpenGL support:
   108     ./configure --prefix=/usr       \
   109                 --disable-video-x11 \
   110                 --disable-shared
   112     b) without OpenGL support:
   113     ./configure --prefix=/usr       \
   114                 --disable-video-x11 \
   115                 --disable-shared    \
   116                 --disable-video-opengl
   118     In the test directory also run the ./configure script without
   119 x11 support, e.g.:
   121     ./configure  --with-sdl-prefix=/usr            \
   122                  --with-sdl-exec-prefix=/usr       \
   123                  --prefix=/usr --without-x
   125 ======================================================================
   126 Environment variables:
   128     Please note that the photon driver  is  sensible to the  following
   129 environmental variables:
   131  * SDL_VIDEO_WINDOW_POS - can be  set in the "X,Y" format.  If X and Y
   132 coordinates are bigger than the current desktop resolution, then  win-
   133 dow positioning across  virtual  consoles is activated. If X and Y are
   134 smaller than the desktop resolution  then  window  positioning  in the
   135 current console is activated. The word "center" can be used instead of
   136 coordinates, it  produces  the  same  behavior  as  SDL_VIDEO_CENTERED
   137 environmental variable.
   139  * SDL_VIDEO_CENTERED - if this environmental variable exists then the
   140 window centering is perfomed in the current virtual console.
   142     The SDL_VIDEO_CENTERED enviromental variable has greater  priority
   143 than the SDL_VIDEO_WINDOW_POS in case if both variables  are  supplied
   144 to the application.