PiStorm3D
=========

PiStorm3D brings hardware-accelerated 3D graphics to classic Amigas
equipped with a compatible PiStorm and Raspberry Pi 4, Pi 4B or CM4.
It uses the Raspberry Pi's VideoCore V3D GPU directly to accelerate
68k applications and games using the MiniGL API.

PiStorm3D is based on MiniGL V1.2. It implements a substantial subset
of the classic MiniGL API, together with independently developed
extensions providing functionality equivalent to the additions in
MiniGLQ3 and some more additions done by Dennis Boon. 

No MiniGLQ3 code was used in PiStorm3D.

IMPORTANT: BETA COMPATIBILITY
-----------------------------

The public release no longer supports executables compiled for the
beta version. These applications and games must be recompiled using
the latest SDK. Installing the new library alone is not sufficient.

Requirements
------------

* A compatible PiStorm with Raspberry Pi 4, Pi 4B or CM4 hardware
  and access to its VideoCore V3D GPU.
* AmigaOS 3.x.
* RTG graphics with cybergraphics.library or Picasso96.
* Not using fast_page_zero in config.txt of the PiStorm
* BGRA32 Screenmodes as the only 32 Bit Screenmodes in your P96 Setup (else Fullscreen doesn't work)

Raspberry Pi 3 systems are not supported by this implementation.
Their GPU requires a different backend.

Installation
------------

Copy the PiStorm3D minigl.library to LIBS: and use applications built
for the current public-release SDK. 

About minigl.library
--------------------

PiStorm3D supports both a static linker library and the shared
minigl.library interface. Applications using the shared interface
can also run on other supported hardware when a suitable
minigl.library implementation is installed (assuming they support BGRA32).

This package provides the PiStorm3D implementation. Implementations
for other hardware are separate projects.

Features include texture mapping, depth buffering, blending, alpha
testing, fog, vertex arrays, indexed rendering and multitexturing.
Support for individual API operations depends on the backend; the
presence of an entry point does not imply full OpenGL support.

For developers
--------------

To adapt a MiniGL application to the shared library:

* Replace MGLInit() and MGLTerm() with MiniGLOpen() and MiniGLClose().
* Include <proto/minigl.h> instead of the static MiniGL headers.
* Link against libminigl.a instead of libmgl.a.
* Latest SDK is included in this archive.

SDL1, SDL2 and SDL3 versions with minigl.library support are also
available. See the main README and SDK for API and build details.

Credits
-------

PiStorm3D was conceived and implemented by Dennis Boon.
minigl.library was conceived and implemented by Steffen "MagicSN" Haeuser.

Thanks to:

* Claude Schwarz and Michal Schulz for PiStorm and Raspberry Pi
  hardware information and advice.
* paraj for Proof-of-Concept for Pi3
* Macoy Madson and Mike, the Wandering Hacker, for V3D information,
  documentation and programming examples.
* Hans-Joerg Frieden, Thomas Frieden and Christian "Surgeon" Michael
  for MiniGL V1.2.
* CowCat for the MiniGLQ3 extensions, whose functionality PiStorm3D
  implements independently.
* Artur "arczi" Jarosik and Serkan Dursun for supporting PiStorm3D with their games.
* flype, Mr-Z, mbo77, vitosky70, Joacim Strand and Justin Webb
  for beta testing.
* All donors, especially Ben Hermans and Justin Webb for their
  substantial initial donations.
* Alinea Computer and Claude for donating hardware.
* Everyone who tested, reported bugs or otherwise helped.

License
-------

MiniGL-derived code and original PiStorm3D code are distributed
under the Hyperion MiniGL Open Source License. The complete license
is included as a separate file with this distribution.

Incorporated third-party code and headers retain their original
copyright notices and license terms. These include V3D components
by or derived from work by Macoy Madson, Broadcom, VMware and Mesa.
They are not covered by the MiniGL license. See the respective
source files for their applicable terms.

PiStorm3D is provided without warranty, to the extent permitted by
applicable law. See the main README and included licenses for the
complete warranty and liability provisions.

 PERMSSN    UID  GID    PACKED    SIZE  RATIO METHOD CRC     STAMP          NAME
---------- ----------- ------- ------- ------ ---------- ------------ -------------
[Amiga]                 159014  381184  41.7% -lh5- e4c3 Oct  5 21:56 PiStorm3D/bin/minigl.library
[Amiga]                  12129   22600  53.7% -lh5- 1168 Oct  6 13:09 PiStorm3D/demos/cube
[Amiga]                  52311  196623  26.6% -lh5- b3fa Nov 30  2002 PiStorm3D/demos/data/chrome.ppm
[Amiga]                   9823   49167  20.0% -lh5- 5d20 Nov 30  2002 PiStorm3D/demos/data/flare.ppm
[Amiga]                   3845   49167   7.8% -lh5- b751 Nov 30  2002 PiStorm3D/demos/data/stars.ppm
[Amiga]                  31835   63396  50.2% -lh5- ac3d Oct  6 13:09 PiStorm3D/demos/gears
[Amiga]                  14137   24876  56.8% -lh5- 0bd4 Oct  5 20:43 PiStorm3D/demos/library_test
[Amiga]                  12028   21356  56.3% -lh5- 808c Oct  6 13:09 PiStorm3D/demos/ring
[Amiga]                  24864   45836  54.2% -lh5- 5099 Oct  7 11:14 PiStorm3D/demos/warp
[Amiga]                   1286    2622  49.0% -lh5- 0d90 Oct  5 13:48 PiStorm3D/FAQ
[Amiga]                    431     757  56.9% -lh5- f473 Nov 30  2002 PiStorm3D/licences/License_MiniGL_Library.txt
[Amiga]                    431     757  56.9% -lh5- f473 Nov 30  2002 PiStorm3D/licences/License_PiStorm3D.txt
[Amiga]                   1290    4365  29.6% -lh5- da9a Sep  1 11:00 PiStorm3D/licences/License_V3D_ThirdParty.txt
[Amiga]                    399     839  47.6% -lh5- c042 Sep 23 07:51 PiStorm3D/licences/README_Licences.txt
[Amiga]                   4495   11665  38.5% -lh5- 2acb Oct  7 12:16 PiStorm3D/Readme.md
[Amiga]                   1407    3085  45.6% -lh5- ddc5 Oct  5 21:56 PiStorm3D/SDK/backend/include/v3d_clbuf.h
[Amiga]                   1502    5086  29.5% -lh5- c2aa Oct  5 21:56 PiStorm3D/SDK/backend/include/v3d_commands.h
[Amiga]                   9183   23283  39.4% -lh5- d4df Oct  5 21:56 PiStorm3D/SDK/backend/include/v3d_context.h
[Amiga]                    653    1374  47.5% -lh5- 96fc Oct  5 21:56 PiStorm3D/SDK/backend/include/v3d_device.h
[Amiga]                   3209    7301  44.0% -lh5- a334 Oct  5 21:56 PiStorm3D/SDK/backend/include/v3d_frame.h
[Amiga]                   8637   26777  32.3% -lh5- ee53 Oct  5 21:56 PiStorm3D/SDK/backend/include/v3d_shader_assembler.h
[Amiga]                   7043   17780  39.6% -lh5- 9c1d Oct  5 21:56 PiStorm3D/SDK/backend/include/v3d_texture.h
[Amiga]                   2773    6058  45.8% -lh5- 5b23 Oct  5 21:56 PiStorm3D/SDK/backend/include/v3d_types.h
[Amiga]                   1954    4612  42.4% -lh5- 3ca1 Oct  5 21:56 PiStorm3D/SDK/backend/include/v3d_vertex.h
[Amiga]                    390     828  47.1% -lh5- d19f Oct  7 11:42 PiStorm3D/SDK/lib/libminigl.a
[Amiga]                    161     277  58.1% -lh5- 10b7 Sep 28 21:33 PiStorm3D/SDK/minigl-shared-library/include/clib/minigl_protos.h
[Amiga]                   1423    2876  49.5% -lh5- 028b Oct  5 01:12 PiStorm3D/SDK/minigl-shared-library/include/libraries/minigl.h
[Amiga]                  17808   79756  22.3% -lh5- 67c6 Oct  5 20:30 PiStorm3D/SDK/minigl-shared-library/include/libraries/minigl_dispatch.h
[Amiga]                    149     197  75.6% -lh5- d0d4 Sep 28 21:33 PiStorm3D/SDK/minigl-shared-library/include/libraries/minigl_offsets.h
[Amiga]                    523    1068  49.0% -lh5- 503d Oct  5 21:50 PiStorm3D/SDK/minigl-shared-library/include/mgl/clip.h
[Amiga]                   1130    2025  55.8% -lh5- 811e Oct  5 21:50 PiStorm3D/SDK/minigl-shared-library/include/mgl/config.h
[Amiga]                  17507   44842  39.0% -lh5- fae0 Oct  5 21:50 PiStorm3D/SDK/minigl-shared-library/include/mgl/context.h
[Amiga]                  23095   83801  27.6% -lh5- 399e Oct  5 21:50 PiStorm3D/SDK/minigl-shared-library/include/mgl/gl.h
[Amiga]                   3565    9662  36.9% -lh5- 25cb Oct  5 21:50 PiStorm3D/SDK/minigl-shared-library/include/mgl/glut.h
[Amiga]                    241     367  65.7% -lh5- 156d Oct  5 21:50 PiStorm3D/SDK/minigl-shared-library/include/mgl/log.h
[Amiga]                    854    1924  44.4% -lh5- 2c8d Oct  5 21:50 PiStorm3D/SDK/minigl-shared-library/include/mgl/matrix.h
[Amiga]                    948    1748  54.2% -lh5- 11c5 Oct  5 21:50 PiStorm3D/SDK/minigl-shared-library/include/mgl/mglmacros.h
[Amiga]                   4408   22487  19.6% -lh5- 9e35 Sep 28 21:33 PiStorm3D/SDK/minigl-shared-library/include/mgl/minigl.h
[Amiga]                    439     770  57.0% -lh5- 9709 Oct  5 21:50 PiStorm3D/SDK/minigl-shared-library/include/mgl/modes.h
[Amiga]                    980    1885  52.0% -lh5- 4230 Oct  5 21:50 PiStorm3D/SDK/minigl-shared-library/include/mgl/vertexbuffer.h
[Amiga]                     98     139  70.5% -lh5- 4bca Sep 28 21:33 PiStorm3D/SDK/minigl-shared-library/include/proto/minigl.h
[Amiga]                   2406    5173  46.5% -lh5- 37b6 Oct  6 20:07 PiStorm3D/SDK/README.txt
[Amiga]                  11906   23316  51.1% -lh5- 9c9f Sep 23 09:33 PiStorm3D/tools/Emu68DeviceTree
[Amiga]                    127     325  39.1% -lh5- 4fc2 Sep 23 09:31 PiStorm3D/tools/P96Version.sh
[Amiga]                    584    1185  49.3% -lh5- 6574 Sep 23 18:35 PiStorm3D.info
---------- ----------- ------- ------- ------ ---------- ------------ -------------
 Total        45 files  453421 1255217  36.1%            Oct  7 22:51