<--- Cannot embed stylesheet: [Errno 2] No such file or directory: '../../../../aros.css' --->

Pixmap.mui

MUIA_Pixmap_Alpha

Function

Apply global opacity to direct ARGB32 drawing.

Inputs

Initialize, set, get: ULONG; default 0xffffffff.

Notes

WritePixelArrayAlpha uses the top byte (0xff keeps source alpha, 0 hides it).
Other direct formats and palette-screen drawing ignore this setting;
ARGB32 palette masks use source alpha with a threshold of 128.
Set does not recompute Setup-time buffering/fill choices.

MUIA_Pixmap_CLUT

Function

Specify the color table for indexed pixels and palette conversion.

Inputs

Initialize, set, get: borrowed pointer to 256 ULONG XRGB entries;
default NULL (red bits 16-23, green 8-15, blue 0-7).

Notes

A NULL table selects the built-in palette only for palette-screen
conversion. Direct CLUT8 drawing requires a supplied table. No copy
or ownership transfer occurs. Set does not rebuild pens or converted
bitmaps; recreate the object to change the palette safely.

MUIA_Pixmap_CompressedSize

Function

Specify the compressed input length in bytes.

Inputs

Initialize, set, get: ULONG; default 0.

Notes

Supply the complete compressed length for RLE or BZip2. Zero makes
the decoder treat Data as uncompressed; it is not the expanded size.
A failed decode does not restore previously stored attributes.

MUIA_Pixmap_Compression

Function

Select compression of Data.

Inputs

Initialize, set, get: ULONG; None (0, default), RLE (1), BZip2 (2).

Notes

Decoding uses CompressedSize and the uncompressed size implied by
Format and dimensions. A zero CompressedSize bypasses decoding even
when compression is selected. RLE does not fully validate bounds;
BZip2 accepts exact-sized output without requiring end-of-stream.
Failed Set can leave updated fields. Recreate for a different image.

MUIA_Pixmap_Data

Function

Specify packed pixel bytes or a compressed byte stream.

Inputs

Initialize, set, get: borrowed APTR; default NULL.

Notes

Raw pixels use contiguous rows without padding (1, 3 or 4 bytes per
pixel according to Format). Compressed input must match CompressedSize
and the declared uncompressed dimensions. Neither input is copied.
Replacing aliased raw Data can free caller-owned memory; recreate the
object to replace the image safely. Failed decoding can leave changed
attributes in place. Get returns the stored pointer without ownership.

MUIA_Pixmap_Format

Function

Select the pixel format.

Inputs

Initialize, set, get: ULONG; default ARGB32 (2).
CLUT8 (0): one palette index per pixel; RGB24 (1): RGB bytes;
ARGB32 (2): alpha, red, green, blue bytes.

Notes

Rows have no separate stride. Direct CLUT8 needs a valid CLUT.
Changing Format does not invalidate cached pixels or regenerate
palette-screen resources; recreate the object instead.

MUIA_Pixmap_Height

Function

Specify the image height in pixels.

Inputs

Initialize, set, get: LONG; default 0. Supply a positive dimension.

Notes

Contributes to all AskMinMax sizes. No scaling or source-length
validation is performed. Set does not resize cached buffers or refresh
palette resources; recreate the object when changing dimensions.
Ensure allocation sizes remain representable.

MUIA_Pixmap_UncompressedData

Function

Retrieve raw image bytes, decompressing synchronously if required.

Inputs

Get: APTR; may be NULL even when the getter returns TRUE.

Notes

The returned pointer is borrowed: raw input aliases Data, while
decoded input normally points to object-owned storage. Never free it;
do not retain decoded storage across image changes or Dispose.
Cached data is not revalidated after Format or dimension changes.

MUIA_Pixmap_Width

Function

Specify the image width in pixels.

Inputs

Initialize, set, get: LONG; default 0. Supply a positive dimension.

Notes

Controls packed-row width and contributes to all AskMinMax sizes.
No scaling or source-length validation is performed. Set does not
resize cached buffers or refresh palette resources; recreate the object
when changing dimensions. Ensure allocation sizes remain representable.

MUIC_Pixmap

Superclass

Area.mui

Description

Displays caller-supplied CLUT8, RGB24 or ARGB32 pixels, optionally
RLE- or BZip2-compressed. The object borrows Data and CLUT; keep both
valid while in use. Dimensions, format and buffer lengths must agree.
The picture is drawn without scaling.

Notes

Decompression is synchronous. Setup does not propagate decode or
palette-resource allocation failures; successful Setup does not prove
a drawable image. On palette screens the object prepares mapped pens
and, for ARGB32, a binary transparency mask. Only direct ARGB32 drawing
applies global Alpha. Use the usual Setup/Cleanup lifecycle.
Changing Data can incorrectly free a previously borrowed raw buffer.
Format, dimensions and CLUT changes do not refresh cached image or
palette-screen resources. Recreate the object for a new image contract.
Neither RLE bounds nor calculated allocation sizes are fully validated;
use valid, trusted image data.