brush.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	_BRUSHBODY
struct	_BRUSH
struct	_EBRUSHOBJ

Macros
#define	NB_HATCH_STYLES   6
#define	BR_NEED_FG_CLR   0x00000001
#define	BR_NEED_BK_CLR   0x00000002 /* Background color is needed */
#define	BR_DITHER_OK   0x00000004 /* Allow color dithering */
#define	BR_IS_SOLID   0x00000010 /* Solid brush */
#define	BR_IS_HATCH   0x00000020 /* Hatch brush */
#define	BR_IS_BITMAP   0x00000040 /* DDB pattern brush */
#define	BR_IS_DIB   0x00000080 /* DIB pattern brush */
#define	BR_IS_NULL   0x00000100 /* Null/hollow brush */
#define	BR_IS_GLOBAL   0x00000200 /* Stock objects */
#define	BR_IS_PEN   0x00000400 /* Pen */
#define	BR_IS_OLDSTYLEPEN   0x00000800 /* Geometric pen */
#define	BR_IS_DIBPALCOLORS   0x00001000
#define	BR_IS_DIBPALINDICES   0x00002000
#define	BR_IS_DEFAULTSTYLE   0x00004000
#define	BR_IS_MASKING   0x00008000 /* Pattern bitmap is used as transparent mask (?) */
#define	BR_IS_INSIDEFRAME   0x00010000
#define	BR_CACHED_ENGINE   0x00040000
#define	BR_CACHED_IS_SOLID   0x80000000
#define	BRUSH_ShareLockBrush(hBrush)   ((PBRUSH)GDIOBJ_ShareLockObj((HGDIOBJ)hBrush, GDI_OBJECT_TYPE_BRUSH))
#define	BRUSH_ShareUnlockBrush(pBrush)   GDIOBJ_vDereferenceObject((POBJ)pBrush)
#define	BRUSHOBJ_psoPattern(pbo)   EBRUSHOBJ_psoPattern(CONTAINING_RECORD(pbo, EBRUSHOBJ, BrushObject))
#define	BRUSHOBJ_psoMask(pbo)   EBRUSHOBJ_psoMask(CONTAINING_RECORD(pbo, EBRUSHOBJ, BrushObject))

Typedefs
typedef struct _BRUSHBODY	BRUSHBODY
typedef struct _BRUSH	BRUSH
typedef struct _BRUSH *	PBRUSH
typedef struct _EBRUSHOBJ	EBRUSHOBJ
typedef struct _EBRUSHOBJ *	PEBRUSHOBJ

Functions
INT FASTCALL	BRUSH_GetObject (PBRUSH GdiObject, INT Count, LPLOGBRUSH Buffer)
VOID NTAPI	BRUSH_vDeleteObject (PVOID pvObject)
INIT_FUNCTION NTSTATUS NTAPI	InitBrushImpl (VOID)
VOID NTAPI	EBRUSHOBJ_vInit (EBRUSHOBJ *pebo, PBRUSH pbrush, struct _SURFACE *, COLORREF, COLORREF, struct _PALETTE *)
VOID NTAPI	EBRUSHOBJ_vInitFromDC (EBRUSHOBJ *pebo, PBRUSH pbrush, struct _DC *)
VOID FASTCALL	EBRUSHOBJ_vSetSolidRGBColor (EBRUSHOBJ *pebo, COLORREF crColor)
VOID NTAPI	EBRUSHOBJ_vUpdateFromDC (EBRUSHOBJ *pebo, PBRUSH pbrush, struct _DC *)
BOOL NTAPI	EBRUSHOBJ_bRealizeBrush (EBRUSHOBJ *pebo, BOOL bCallDriver)
VOID NTAPI	EBRUSHOBJ_vCleanup (EBRUSHOBJ *pebo)
PVOID NTAPI	EBRUSHOBJ_pvGetEngBrush (EBRUSHOBJ *pebo)
SURFOBJ *NTAPI	EBRUSHOBJ_psoPattern (EBRUSHOBJ *pebo)
SURFOBJ *NTAPI	EBRUSHOBJ_psoMask (EBRUSHOBJ *pebo)
FORCEINLINE ULONG	EBRUSHOBJ_iSetSolidColor (EBRUSHOBJ *pebo, ULONG iSolidColor)
BOOL FASTCALL	IntGdiSetBrushOwner (PBRUSH, DWORD)
BOOL FASTCALL	GreSetBrushOwner (HBRUSH, DWORD)
HBRUSH APIENTRY	IntGdiCreatePatternBrush (HBITMAP hBitmap)
HBRUSH APIENTRY	IntGdiCreateSolidBrush (COLORREF Color)
HBRUSH APIENTRY	IntGdiCreateNullBrush (VOID)
VOID NTAPI	IntGdiSetSolidBrushColor (_In_ HBRUSH hbr, _In_ COLORREF crColor)

Variables
HSURF	gahsurfHatch [HS_DDI_MAX]

Macro Definition Documentation

BR_CACHED_ENGINE

#define BR_CACHED_ENGINE   0x00040000

Definition at line 110 of file brush.h.

BR_CACHED_IS_SOLID

#define BR_CACHED_IS_SOLID   0x80000000

Definition at line 111 of file brush.h.

BR_DITHER_OK

#define BR_DITHER_OK   0x00000004 /* Allow color dithering */

Definition at line 96 of file brush.h.

BR_IS_BITMAP

#define BR_IS_BITMAP   0x00000040 /* DDB pattern brush */

Definition at line 99 of file brush.h.

BR_IS_DEFAULTSTYLE

#define BR_IS_DEFAULTSTYLE   0x00004000

Definition at line 107 of file brush.h.

BR_IS_DIB

#define BR_IS_DIB   0x00000080 /* DIB pattern brush */

Definition at line 100 of file brush.h.

BR_IS_DIBPALCOLORS

#define BR_IS_DIBPALCOLORS   0x00001000

Definition at line 105 of file brush.h.

BR_IS_DIBPALINDICES

#define BR_IS_DIBPALINDICES   0x00002000

Definition at line 106 of file brush.h.

BR_IS_GLOBAL

#define BR_IS_GLOBAL   0x00000200 /* Stock objects */

Definition at line 102 of file brush.h.

BR_IS_HATCH

#define BR_IS_HATCH   0x00000020 /* Hatch brush */

Definition at line 98 of file brush.h.

BR_IS_INSIDEFRAME

#define BR_IS_INSIDEFRAME   0x00010000

Definition at line 109 of file brush.h.

BR_IS_MASKING

#define BR_IS_MASKING   0x00008000 /* Pattern bitmap is used as transparent mask (?) */

Definition at line 108 of file brush.h.

BR_IS_NULL

#define BR_IS_NULL   0x00000100 /* Null/hollow brush */

Definition at line 101 of file brush.h.

BR_IS_OLDSTYLEPEN

#define BR_IS_OLDSTYLEPEN   0x00000800 /* Geometric pen */

Definition at line 104 of file brush.h.

BR_IS_PEN

#define BR_IS_PEN   0x00000400 /* Pen */

Definition at line 103 of file brush.h.

BR_IS_SOLID

#define BR_IS_SOLID   0x00000010 /* Solid brush */

Definition at line 97 of file brush.h.

BR_NEED_BK_CLR

#define BR_NEED_BK_CLR   0x00000002 /* Background color is needed */

Definition at line 95 of file brush.h.

BR_NEED_FG_CLR

#define BR_NEED_FG_CLR   0x00000001

Definition at line 94 of file brush.h.

BRUSH_ShareLockBrush

#define BRUSH_ShareLockBrush

(

hBrush

)

((PBRUSH)GDIOBJ_ShareLockObj((HGDIOBJ)hBrush, GDI_OBJECT_TYPE_BRUSH))

Definition at line 113 of file brush.h.

BRUSH_ShareUnlockBrush

#define BRUSH_ShareUnlockBrush

(

pBrush

)

GDIOBJ_vDereferenceObject((POBJ)pBrush)

Definition at line 114 of file brush.h.

BRUSHOBJ_psoMask

#define BRUSHOBJ_psoMask

(

pbo

)

EBRUSHOBJ_psoMask(CONTAINING_RECORD(pbo, EBRUSHOBJ, BrushObject))

Definition at line 178 of file brush.h.

BRUSHOBJ_psoPattern

#define BRUSHOBJ_psoPattern

(

pbo

)

EBRUSHOBJ_psoPattern(CONTAINING_RECORD(pbo, EBRUSHOBJ, BrushObject))

Definition at line 171 of file brush.h.

NB_HATCH_STYLES

#define NB_HATCH_STYLES   6

Definition at line 5 of file brush.h.

Typedef Documentation

BRUSH

typedef struct _BRUSH BRUSH

BRUSHBODY

typedef struct _BRUSHBODY BRUSHBODY

EBRUSHOBJ

typedef struct _EBRUSHOBJ EBRUSHOBJ

PBRUSH

typedef struct _BRUSH * PBRUSH

PEBRUSHOBJ

typedef struct _EBRUSHOBJ * PEBRUSHOBJ

Function Documentation

BRUSH_GetObject()

INT FASTCALL BRUSH_GetObject	(	PBRUSH	GdiObject,
		INT	Count,
		LPLOGBRUSH	Buffer
	)

Definition at line 260 of file brush.cpp.

{
    return pbr->cjGetObject(cjBuffer, plbBuffer);
}

Referenced by GreGetObject().

BRUSH_vDeleteObject()

VOID NTAPI BRUSH_vDeleteObject

(

PVOID

pvObject

)

Definition at line 252 of file brush.cpp.

{
    BRUSH::vDeleteObject(pvObject);
}

EBRUSHOBJ_bRealizeBrush()

BOOL NTAPI EBRUSHOBJ_bRealizeBrush	(	EBRUSHOBJ *	pebo,
		BOOL	bCallDriver
	)

Definition at line 309 of file engbrush.c.

{
    BOOL bResult;
    PFN_DrvRealizeBrush pfnRealizeBrush = NULL;
    PSURFACE psurfPattern;
    SURFOBJ *psoMask;
    PPDEVOBJ ppdev;
    EXLATEOBJ exlo;
    PPALETTE ppalPattern;
    PBRUSH pbr = pebo->pbrush;
    HBITMAP hbmPattern;
    ULONG iHatch;

    /* All EBRUSHOBJs have a surface, see EBRUSHOBJ_vInit */
    ASSERT(pebo->psurfTrg);

    ppdev = (PPDEVOBJ)pebo->psurfTrg->SurfObj.hdev;
    if (!ppdev)
        ppdev = gppdevPrimary;

    if (bCallDriver)
    {
        /* Get the Drv function */
        pfnRealizeBrush = ppdev->DriverFunctions.RealizeBrush;
        if (pfnRealizeBrush == NULL)
        {
            ERR("No DrvRealizeBrush. Cannot realize brush\n");
            return FALSE;
        }

        /* Get the mask */
        psoMask = EBRUSHOBJ_psoMask(pebo);
    }
    else
    {
        /* Use the Eng function */
        pfnRealizeBrush = EngRealizeBrush;

        /* We don't handle the mask bitmap here. We do this only on demand */
        psoMask = NULL;
    }

    /* Check if this is a hatch brush */
    if (pbr->flAttrs & BR_IS_HATCH)
    {
        /* Get the hatch brush pattern from the PDEV */
        hbmPattern = (HBITMAP)ppdev->ahsurf[pbr->iHatch];
        iHatch = pbr->iHatch;
    }
    else
    {
        /* Use the brushes pattern */
        hbmPattern = pbr->hbmPattern;
        iHatch = -1;
    }

    psurfPattern = SURFACE_ShareLockSurface(hbmPattern);
    ASSERT(psurfPattern);
    ASSERT(psurfPattern->ppal);

    /* DIB brushes with DIB_PAL_COLORS usage need a new palette */
    if (pbr->flAttrs & BR_IS_DIBPALCOLORS)
    {
        /* Create a palette with the colors from the DC */
        ppalPattern = FixupDIBBrushPalette(psurfPattern->ppal, pebo->ppalDC);
        if (ppalPattern == NULL)
        {
            ERR("FixupDIBBrushPalette() failed.\n");
            return FALSE;
        }

        pebo->ppalDIB = ppalPattern;
    }
    else
    {
        /* The palette is already as it should be */
        ppalPattern = psurfPattern->ppal;
    }

    /* Initialize XLATEOBJ for the brush */
    EXLATEOBJ_vInitialize(&exlo,
                          ppalPattern,
                          pebo->psurfTrg->ppal,
                          0,
                          pebo->crCurrentBack,
                          pebo->crCurrentText);

    /* Create the realization */
    bResult = pfnRealizeBrush(&pebo->BrushObject,
                              &pebo->psurfTrg->SurfObj,
                              &psurfPattern->SurfObj,
                              psoMask,
                              &exlo.xlo,
                              iHatch);

    /* Cleanup the XLATEOBJ */
    EXLATEOBJ_vCleanup(&exlo);

    /* Unlock surface */
    SURFACE_ShareUnlockSurface(psurfPattern);

    return bResult;
}

Referenced by BRUSHOBJ_pvGetRbrush(), and EBRUSHOBJ_pvGetEngBrush().

EBRUSHOBJ_iSetSolidColor()

FORCEINLINE ULONG EBRUSHOBJ_iSetSolidColor	(	EBRUSHOBJ *	pebo,
		ULONG	iSolidColor
	)

Definition at line 183 of file brush.h.

{
    ULONG iOldColor = pebo->BrushObject.iSolidColor;
    pebo->BrushObject.iSolidColor = iSolidColor;
    return iOldColor;
}

Referenced by NtGdiSetPixel().

EBRUSHOBJ_psoMask()

SURFOBJ* NTAPI EBRUSHOBJ_psoMask

(

EBRUSHOBJ *

pebo

)

Definition at line 446 of file engbrush.c.

{
    HBITMAP hbmMask;
    PSURFACE psurfMask;
    PPDEVOBJ ppdev;

    /* Check if we don't have a mask yet */
    if (pebo->psoMask == NULL)
    {
        /* Check if this is a hatch brush */
        if (pebo->flattrs & BR_IS_HATCH)
        {
            /* Get the PDEV */
            ppdev = (PPDEVOBJ)pebo->psurfTrg->SurfObj.hdev;
            if (!ppdev)
                ppdev = gppdevPrimary;

            /* Use the hatch bitmap as the mask */
            hbmMask = (HBITMAP)ppdev->ahsurf[pebo->pbrush->iHatch];
            psurfMask = SURFACE_ShareLockSurface(hbmMask);
            if (psurfMask == NULL)
            {
                ERR("Failed to lock hatch brush for PDEV %p, iHatch %lu\n",
                    ppdev, pebo->pbrush->iHatch);
                return NULL;
            }

            NT_ASSERT(psurfMask->SurfObj.iBitmapFormat == BMF_1BPP);
            pebo->psoMask = &psurfMask->SurfObj;
        }
    }

    return pebo->psoMask;
}

Referenced by EBRUSHOBJ_bRealizeBrush().

EBRUSHOBJ_psoPattern()

SURFOBJ* NTAPI EBRUSHOBJ_psoPattern

(

EBRUSHOBJ *

pebo

)

Definition at line 435 of file engbrush.c.

{
    PSURFACE psurfPattern;

    psurfPattern = EBRUSHOBJ_pvGetEngBrush(pebo);

    return psurfPattern ? &psurfPattern->SurfObj : NULL;
}

EBRUSHOBJ_pvGetEngBrush()

PVOID NTAPI EBRUSHOBJ_pvGetEngBrush

(

EBRUSHOBJ *

pebo

)

Definition at line 415 of file engbrush.c.

{
    BOOL bResult;

    if (!pebo->pengbrush)
    {
        bResult = EBRUSHOBJ_bRealizeBrush(pebo, FALSE);
        if (!bResult)
        {
            if (pebo->pengbrush)
                EngDeleteSurface(pebo->pengbrush);
            pebo->pengbrush = NULL;
        }
    }

    return pebo->pengbrush;
}

Referenced by EBRUSHOBJ_psoPattern().

EBRUSHOBJ_vCleanup()

VOID NTAPI EBRUSHOBJ_vCleanup

(

EBRUSHOBJ *

pebo

)

Definition at line 153 of file engbrush.c.

{
    /* Check if there's a GDI realisation */
    if (pebo->pengbrush)
    {
        /* Unlock the bitmap again */
        SURFACE_ShareUnlockSurface(pebo->pengbrush);
        pebo->pengbrush = NULL;
    }

    /* Check if there's a driver's realisation */
    if (pebo->BrushObject.pvRbrush)
    {
        /* Free allocated driver memory */
        EngFreeMem(pebo->BrushObject.pvRbrush);
        pebo->BrushObject.pvRbrush = NULL;
    }

    if (pebo->psoMask != NULL)
    {
        SURFACE_ShareUnlockSurface(pebo->psoMask);
        pebo->psoMask = NULL;
    }

    /* Dereference the palettes */
    if (pebo->ppalSurf)
    {
        PALETTE_ShareUnlockPalette(pebo->ppalSurf);
    }
    if (pebo->ppalDC)
    {
        PALETTE_ShareUnlockPalette(pebo->ppalDC);
    }
    if (pebo->ppalDIB)
    {
        PALETTE_ShareUnlockPalette(pebo->ppalDIB);
    }
}

Referenced by DC_vCleanup(), EBRUSHOBJ_vUpdateFromDC(), GdiFlushUserBatch(), IntGdiPolyPatBlt(), and UserDrawIconEx().

EBRUSHOBJ_vInit()

VOID NTAPI EBRUSHOBJ_vInit	(	EBRUSHOBJ *	pebo,
		PBRUSH	pbrush,
		struct _SURFACE *	,
		COLORREF	,
		COLORREF	,
		struct _PALETTE *
	)

EBRUSHOBJ_vInitFromDC()

VOID NTAPI EBRUSHOBJ_vInitFromDC	(	EBRUSHOBJ *	pebo,
		PBRUSH	pbrush,
		struct _DC *
	)

EBRUSHOBJ_vSetSolidRGBColor()

VOID FASTCALL EBRUSHOBJ_vSetSolidRGBColor	(	EBRUSHOBJ *	pebo,
		COLORREF	crColor
	)

Definition at line 122 of file engbrush.c.

{
    ULONG iSolidColor;
    EXLATEOBJ exlo;

    /* Never use with non-solid brushes */
    ASSERT(pebo->flattrs & BR_IS_SOLID);

    /* Set the RGB color */
    crColor &= 0xFFFFFF;
    pebo->crRealize = crColor;
    pebo->ulRGBColor = crColor;

    /* Initialize an XLATEOBJ RGB -> surface */
    EXLATEOBJ_vInitialize(&exlo,
                          &gpalRGB,
                          pebo->ppalSurf,
                          pebo->crCurrentBack,
                          0,
                          0);

    /* Translate the brush color to the target format */
    iSolidColor = XLATEOBJ_iXlate(&exlo.xlo, crColor);
    pebo->BrushObject.iSolidColor = iSolidColor;

    /* Clean up the XLATEOBJ */
    EXLATEOBJ_vCleanup(&exlo);
}

Referenced by DC_vUpdateBackgroundBrush(), DC_vUpdateFillBrush(), DC_vUpdateLineBrush(), DC_vUpdateTextBrush(), and EBRUSHOBJ_vInit().

EBRUSHOBJ_vUpdateFromDC()

VOID NTAPI EBRUSHOBJ_vUpdateFromDC	(	EBRUSHOBJ *	pebo,
		PBRUSH	pbrush,
		struct _DC *
	)

GreSetBrushOwner()

BOOL FASTCALL GreSetBrushOwner	(	HBRUSH	,
		DWORD
	)

InitBrushImpl()

INIT_FUNCTION NTSTATUS NTAPI InitBrushImpl

(

VOID

)

Internal functions

Definition at line 31 of file engbrush.c.

{
    ULONG i;
    SIZEL sizl = {8, 8};

    /* Loop all hatch styles */
    for (i = 0; i < HS_DDI_MAX; i++)
    {
        /* Create a default hatch bitmap */
        gahsurfHatch[i] = (HSURF)EngCreateBitmap(sizl,
                                                 0,
                                                 BMF_1BPP,
                                                 0,
                                                 (PVOID)gaulHatchBrushes[i]);
    }

    return STATUS_SUCCESS;
}

Referenced by DriverEntry().

IntGdiCreateNullBrush()

HBRUSH APIENTRY IntGdiCreateNullBrush

(

VOID

)

Definition at line 270 of file brush.cpp.

{
    /* Call the internal function */
    return CreateBrushInternal(BR_IS_NULL | BR_IS_GLOBAL, 0, 0, NULL, NULL);
}

Referenced by CreateStockObjects().

IntGdiCreatePatternBrush()

HBRUSH APIENTRY IntGdiCreatePatternBrush

(

HBITMAP

hBitmap

)

Definition at line 292 of file brush.cpp.

{
    NT_ASSERT(hbmPattern != NULL);
    GreSetBitmapOwner(hbmPattern, BASEOBJECT::OWNER::PUBLIC);
    return CreateBrushInternal(BR_IS_BITMAP | BR_IS_GLOBAL,
                               0,
                               0,
                               hbmPattern,
                               NULL);
}

Referenced by UserInitialize().

IntGdiCreateSolidBrush()

HBRUSH APIENTRY IntGdiCreateSolidBrush

(

COLORREF

Color

)

Definition at line 279 of file brush.cpp.

{
    /* Call the internal function */
    return CreateBrushInternal(BR_IS_SOLID | BR_IS_GLOBAL,
                               crColor,
                               0,
                               NULL,
                               NULL);
}

Referenced by CreateStockObjects(), and CreateSysColorObjects().

IntGdiSetBrushOwner()

BOOL FASTCALL IntGdiSetBrushOwner	(	PBRUSH	,
		DWORD
	)

IntGdiSetSolidBrushColor()

VOID NTAPI IntGdiSetSolidBrushColor	(	_In_ HBRUSH	hbr,
		_In_ COLORREF	crColor
	)

Definition at line 306 of file brush.cpp.

{
    PBRUSH pbr;

    /* Lock the brush */
    pbr = BRUSH::LockAny(hbr);
    if (pbr == NULL)
    {
        ERR("Failed to lock brush %p\n", hbr);
        return;
    }

    /* Call the member function */
    pbr->vSetSolidColor(crColor);

    /* Unlock the brush */
    pbr->vUnlock();
}

Referenced by IntSetSysColors().

Variable Documentation

gahsurfHatch

HSURF gahsurfHatch[HS_DDI_MAX]

Definition at line 24 of file engbrush.c.

Referenced by InitBrushImpl(), and PDEVOBJ_bEnablePDEV().