wiki:Documentation/API/MUI_Bodychunk

Bodychunk.mui

Super class

Bitmap.mui

Background

Big and colorful images (e.g. About-Logos) usually take lots of space when stored in a traditional BitMap structure. To save memory, you can decide to have the picture compressed in your code and use the Bodychunk class instead of the Bitmap class for displaying. MUI will then automatically decompress your image when its about to appear in a window.

Since Bodychunk class is a subclass of Bitmap class, you can of course use all the Bitmaps remapping and transparency features.

Attributes

Attribute Version ISG Type
MUIA_Bodychunk_Body V8ISGUBYTE *
MUIA_Bodychunk_Compression V8ISGUBYTE
MUIA_Bodychunk_Depth V8ISGLONG
MUIA_Bodychunk_Masking V8ISGUBYTE


MUIA_Bodychunk_Body

NAME

MUIA_Bodychunk_Body — V8 [ISG], UBYTE *, 0x8042ca67

FUNCTION

Specify a pointer to the BODY data of your picture. This BODY data must follow normal IFF/ILBM conventions.

You have to supply MUIA_Bitmap_Width, MUIA_Bitmap_Height and MUIA_Bodychunk_Depth to describe the contents of the BODY data, otherwise MUI will fail to decompress it.

Body data may be shared between different Bodychunk objects and does not need to be in chip ram.

SEE ALSO

MUIA_Bodychunk_Depth, MUIA_Bodychunk_Compression, MUIA_Bodychunk_Masking

MUIA_Bodychunk_Compression

NAME

MUIA_Bodychunk_Compression — V8 [ISG], UBYTE, 0x8042de5f

FUNCTION

MUI is able to uncompress byte&run compressed BODY chunks automatically. If your data is compressed, you must supply a value of cmpByteRun1 (==1) for this tag. Other compression techniques are not supported.

Omitting this tag or setting it to 0 indicates that the BODY data is uncompressed. Using the Bodychunk class doesn't make much sense in this case since its main purpose is to save memory for big images.

SEE ALSO

MUIA_Bodychunk_Masking, MUIA_Bodychunk_Body

MUIA_Bodychunk_Depth

NAME

MUIA_Bodychunk_Depth — V8 [ISG], LONG, 0x8042c392

FUNCTION

Specify the depth of your picture here. This tag is required for correct BODY chunk parsing. Also remember to use MUIA_Bodychunk_Masking if your BODY data contains a masking bitplane.

SEE ALSO

MUIA_Bodychunk_Body, MUIA_Bodychunk_Masking

MUIA_Bodychunk_Masking

NAME

MUIA_Bodychunk_Masking — V8 [ISG], UBYTE, 0x80423b0e

FUNCTION

You must indicate if your BODY data contains a masking plane. Currently, MUI does not use this masking plane for any purpose, but this attribute is required to allow correct parsing of the BODY data.

SEE ALSO

MUIA_Bodychunk_Body, MUIA_Bodychunk_Compression


Copyright © 1992-2006 by Stefan Stuntz
Copyright © 2006-2017 by Thore Böckelmann, Jens Maus

MUI for AmigaOS - MUI-Autodocs

Updated: 13-Dec-2017

Last modified 9 months ago Last modified on Mar 27, 2017, 3:59:19 PM