3.2 Configuring Plananarama

When @REQUIRE-ing Plananarama, you can pass the following tags to Hollywood's @REQUIRE preprocessor command:

PaletteMode:
This tag can be used to set whether or not Plananarama should run in palette mode. This defaults to False which means remapping mode (see above for details). (V2.0)

NoBlackBackground:
If this is set to True, Plananarama won't set color 0 to black when opening in fullscreen mode. This is only handled when Plananarama is in remapping mode. In palette mode, Plananarama will use the display's palette. Defaults to False. (V2.0)

SpriteResolution:
This tag can be used to force a specific sprite resolution for the hardware sprites created by Plananarama. By default, Plananarama will use the system's sprite resolution which might not be what you want. E.g. if the system's sprite resolution is hires, your sprites will appear in hires as well which might not be what you want. The system's sprite resolution is typically identical with the mouse pointer resolution set in the system's "Pointer" preferences because AmigaOS implements the mouse pointer using a hardware sprite. So if the user has configured a hires pointer here, then all your sprites will use hires by default as well. If you don't want that, set this tag to 1 to force lores sprite resolution. To force hires sprites, set the tag to 2. This tag defaults to 0 which means use the system's sprite resolution. Note that this tag is only ever useful on AGA systems because on ECS systems sprites are always lores. (V2.0)

DitherMode:
When Plananarama is in remapping mode, this can be used to configure the dithering mode. This can be set to None, FS (the default), Random, or Edd. Here is a description of the different dither modes:

None
No dithering at all.

FS
Floyd-Steinberg dithering. This is the default.

Random
Random dithering. This mode is significantly slower than Floyd-Steinberg dithering.

Edd
EDD dithering. This mode is faster than Floyd-Steinberg dithering.

This tag is ignored in palette mode.

DitherAmount:
When Plananarama is in remapping mode, this can be used to set the dither amount. This must be between 0 and 255. Currently this value is of any use only for the Random dither mode. Defaults to 40. This tag is ignored in palette mode.

AutoDither:
When Plananarama is in remapping mode, this can be used to enable automatic dithering. If set to True, dithering is automatically activated for drawing a particular picture to a particular environment, when the loss of color information would exceed a certain threshold (see below). Defaults to True. This tag is ignored in palette mode.

DitherThreshold:
When Plananarama is in remapping mode, this can be used to set the threshold for automatic dithering. The lower, the earlier automatic dithering is activated. Useful thresholds range between 10 and 10000. Refer to render.library/RGBArrayDiversityA() for further details. Better you do not use this tag unless you have a good reason to. Let the user customize it with the environment variable AUTODITHERTHRESHOLD. Defaults to 250. This tag is ignored in palette mode.

Precision:
When Plananarama is in remapping mode, this can be used to set the precision for pen allocations. This can be Exact, Image (the default), Icon, or GUI. See graphics.library/ObtainBestPenA() for details. Note that the default precision suffices for almost every application. Pens are obtained in an extremely effective way. You get excellent results even with lower precisions. Commodore's idea with ObtainBestPenA() was to create a fair and effective pen-sharing mechanism, and Plananarama behaves in perfect accordance to this intention. Never use insane patches for ObtainBestPenA(). This tag is ignored in palette mode.


Show TOC