MUI Types Reference¶

Type definitions used by muimaster.library and the MUI custom classes. Each struct lives in the C header where it is declared (muimaster.h for the engine types, classes/.h for class attribute structs). This page indexes the public types and links to the per-class or per-library page where they are documented.

Contents¶

muimaster.h (engine)¶

• MUI_CustomClass
• MUI_RenderInfo
• MUI_PenSpec

Class-specific attribute structs¶

These structs are documented on each class's page. The struct name mirrors the class name: struct MUI_AppData is the data area for Application.mui, etc.

• struct MUI_AppData
• struct MUI_AreaData
• ... (one per class — see the per-class page for details)

---

MUI_CustomClass¶

Source: libraries/mui.h

struct MUI_CustomClass
{
    struct IClass   *mcc_Class;              /* the BOOPSI class */
    APTR             mcc_UserData;           /* per-class storage  */
    struct Library  *mcc_LibBase;           /* library base ptr  */
};

Used to register and dispatch a custom MUI class. See MUI_CreateCustomClass() for the C reference; the dispatcher function signature and call convention are described there.

---

MUI_RenderInfo¶

Source: libraries/mui.h

struct MUI_RenderInfo
{
    struct Screen *ri_Screen;               /* Screen being rendered to    */
    APTR            ri_DrawInfo;             /* intuition DrawInfo handle     */
    ULONG           ri_Flags;                /* MUI_RIF_* flags                */
    APTR            ri_ClipRect;             /* optional ClipRect              */
};

Passed to MUI_ObtainPen() / MUI_ReleasePen() and to clipping primitives. See MUI_ObtainPen() for context.

---

MUI_PenSpec¶

Source: libraries/mui.h

struct MUI_PenSpec
{
    ULONG ps_Flags;                         /* PENF_* flags                   */
    LONG  ps_Pen;                            /* matching pen number, or -1     */
    struct {
        WORD r, g, b;                        /* RGB colour                     */
    } ps_Color;
};

Used to specify a pen to obtain. See MUI_ObtainPen().