PiStorm3D 29.1

Hardware-accelerated MiniGL for PiStorm

Short:        Hardware-accelerated MiniGL for PiStorm
Author:       dennisvdboon@gmail.com (Dennis Boon), tirionareonwe@gmail.com (Steffen Haeuser)
Uploader:     tirionareonwe gmail com (Steffen Haeuser)
Type:         util/libs
Version:      29.1
Requires:     AmigaOS 3.x, PiStorm with Pi 4/4B/CM4, RTG
Architecture: m68k-amigaos

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.