surface.h File Reference

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

Go to the source code of this file.

Classes
struct	_SURFACE

Macros
#define	BMF_POOLALLOC   0x100
#define	SURFACE_AllocSurfaceWithHandle()   ((PSURFACE) GDIOBJ_AllocObjWithHandle(GDI_OBJECT_TYPE_BITMAP, sizeof(SURFACE)))
#define	SURFACE_ShareLockSurface(hBMObj)   ((PSURFACE) GDIOBJ_ShareLockObj ((HGDIOBJ) hBMObj, GDI_OBJECT_TYPE_BITMAP))
#define	SURFACE_UnlockSurface(pBMObj)   GDIOBJ_vUnlockObject ((POBJ)pBMObj)
#define	SURFACE_ShareUnlockSurface(pBMObj)   GDIOBJ_vDereferenceObject ((POBJ)pBMObj)
#define	GDIDEV(SurfObj)   ((PDEVOBJ *)((SurfObj)->hdev))
#define	GDIDEVFUNCS(SurfObj)   ((PDEVOBJ *)((SurfObj)->hdev))->DriverFunctions
#define	BitsPerFormat(Format)   gajBitsPerFormat[Format]
#define	WIDTH_BYTES_ALIGN32(cx, bpp)   ((((cx) * (bpp) + 31) & ~31) >> 3)
#define	WIDTH_BYTES_ALIGN16(cx, bpp)   ((((cx) * (bpp) + 15) & ~15) >> 3)

Typedefs
typedef struct _SURFACE	SURFACE
typedef struct _SURFACE *	PSURFACE

Enumerations
enum	_SURFACEFLAGS {   SHAREACCESS_SURFACE = 0x00000200, UMPD_SURFACE = 0x00040000, MIRROR_SURFACE = 0x00080000, DIRECTDRAW_SURFACE = 0x00100000,   DRIVER_CREATED_SURFACE = 0x00200000, ENG_CREATE_DEVICE_SURFACE = 0x00400000, DDB_SURFACE = 0x00800000, LAZY_DELETE_SURFACE = 0x01000000,   BANDING_SURFACE = 0x02000000, API_BITMAP = 0x04000000, PALETTE_SELECT_SET = 0x08000000, UNREADABLE_SURFACE = 0x10000000,   DYNAMIC_MODE_PALETTE = 0x20000000, ABORT_SURFACE = 0x40000000, PDEV_SURFACE = 0x80000000 }

Functions
FORCEINLINE VOID	SURFACE_ShareLockByPointer (PSURFACE psurf)
ULONG FASTCALL	BitmapFormat (ULONG cBits, ULONG iCompression)
VOID NTAPI	SURFACE_vCleanup (PVOID ObjectBody)
PSURFACE NTAPI	SURFACE_AllocSurface (_In_ USHORT iType, _In_ ULONG cx, _In_ ULONG cy, _In_ ULONG iFormat, _In_ ULONG fjBitmap, _In_opt_ ULONG cjWidth, _In_opt_ ULONG cjBits, _In_opt_ PVOID pvBits)
FORCEINLINE VOID	SURFACE_vSetPalette (_Inout_ PSURFACE psurf, _In_ PPALETTE ppal)

Variables
UCHAR	gajBitsPerFormat []

Macro Definition Documentation

BitsPerFormat

#define BitsPerFormat

(

Format

)

gajBitsPerFormat[Format]

Definition at line 109 of file surface.h.

BMF_POOLALLOC

#define BMF_POOLALLOC   0x100

Definition at line 84 of file surface.h.

GDIDEV

#define GDIDEV

(

SurfObj

)

((PDEVOBJ *)((SurfObj)->hdev))

Definition at line 105 of file surface.h.

GDIDEVFUNCS

#define GDIDEVFUNCS

(

SurfObj

)

((PDEVOBJ *)((SurfObj)->hdev))->DriverFunctions

Definition at line 106 of file surface.h.

SURFACE_AllocSurfaceWithHandle

#define SURFACE_AllocSurfaceWithHandle

(

)

((PSURFACE) GDIOBJ_AllocObjWithHandle(GDI_OBJECT_TYPE_BITMAP, sizeof(SURFACE)))

Definition at line 88 of file surface.h.

SURFACE_ShareLockSurface

#define SURFACE_ShareLockSurface

(

hBMObj

)

((PSURFACE) GDIOBJ_ShareLockObj ((HGDIOBJ) hBMObj, GDI_OBJECT_TYPE_BITMAP))

Definition at line 91 of file surface.h.

SURFACE_ShareUnlockSurface

#define SURFACE_ShareUnlockSurface

(

pBMObj

)

GDIOBJ_vDereferenceObject ((POBJ)pBMObj)

Definition at line 102 of file surface.h.

SURFACE_UnlockSurface

#define SURFACE_UnlockSurface

(

pBMObj

)

GDIOBJ_vUnlockObject ((POBJ)pBMObj)

Definition at line 100 of file surface.h.

WIDTH_BYTES_ALIGN16

#define WIDTH_BYTES_ALIGN16	(		cx,
			bpp
	)		((((cx) * (bpp) + 15) & ~15) >> 3)

Definition at line 112 of file surface.h.

WIDTH_BYTES_ALIGN32

#define WIDTH_BYTES_ALIGN32	(		cx,
			bpp
	)		((((cx) * (bpp) + 31) & ~31) >> 3)

Definition at line 111 of file surface.h.

Typedef Documentation

PSURFACE

typedef struct _SURFACE * PSURFACE

SURFACE

typedef struct _SURFACE SURFACE

Enumeration Type Documentation

_SURFACEFLAGS

enum _SURFACEFLAGS

Enumerator
SHAREACCESS_SURFACE
UMPD_SURFACE
MIRROR_SURFACE
DIRECTDRAW_SURFACE
DRIVER_CREATED_SURFACE
ENG_CREATE_DEVICE_SURFACE
DDB_SURFACE
LAZY_DELETE_SURFACE
BANDING_SURFACE
API_BITMAP
PALETTE_SELECT_SET
UNREADABLE_SURFACE
DYNAMIC_MODE_PALETTE
ABORT_SURFACE
PDEV_SURFACE

Definition at line 41 of file surface.h.

{
//#define HOOK_BITBLT               0x00000001
//#define HOOK_STRETCHBLT           0x00000002
//#define HOOK_PLGBLT               0x00000004
//#define HOOK_TEXTOUT              0x00000008
//#define HOOK_PAINT                0x00000010
//#define HOOK_STROKEPATH           0x00000020
//#define HOOK_FILLPATH             0x00000040
//#define HOOK_STROKEANDFILLPATH    0x00000080
//#define HOOK_LINETO               0x00000100
    SHAREACCESS_SURFACE       = 0x00000200,
//#define HOOK_COPYBITS             0x00000400
//#define REDIRECTION_SURFACE       0x00000800 // ?
//#define HOOK_MOVEPANNING          0x00000800
//#define HOOK_SYNCHRONIZE          0x00001000
//#define HOOK_STRETCHBLTROP        0x00002000
//#define HOOK_SYNCHRONIZEACCESS    0x00004000
//#define USE_DEVLOCK_SURFACE       0x00004000
//#define HOOK_TRANSPARENTBLT       0x00008000
//#define HOOK_ALPHABLEND           0x00010000
//#define HOOK_GRADIENTFILL         0x00020000
//#if (NTDDI_VERSION < 0x06000000)
// #define HOOK_FLAGS               0x0003B5FF
//#else
// #define HOOK_FLAGS               0x0003B5EF
//#endif
    UMPD_SURFACE              = 0x00040000,
    MIRROR_SURFACE            = 0x00080000,
    DIRECTDRAW_SURFACE        = 0x00100000,
    DRIVER_CREATED_SURFACE    = 0x00200000,
    ENG_CREATE_DEVICE_SURFACE = 0x00400000,
    DDB_SURFACE               = 0x00800000,
    LAZY_DELETE_SURFACE       = 0x01000000,
    BANDING_SURFACE           = 0x02000000,
    API_BITMAP                = 0x04000000,
    PALETTE_SELECT_SET        = 0x08000000,
    UNREADABLE_SURFACE        = 0x10000000,
    DYNAMIC_MODE_PALETTE      = 0x20000000,
    ABORT_SURFACE             = 0x40000000,
    PDEV_SURFACE              = 0x80000000
};

Function Documentation

BitmapFormat()

ULONG FASTCALL BitmapFormat	(	ULONG	cBits,
		ULONG	iCompression
	)

Definition at line 39 of file surface.c.

{
    switch (iCompression)
    {
        case BI_RGB:
            /* Fall through */
        case BI_BITFIELDS:
            if (cBits <= 1) return BMF_1BPP;
            if (cBits <= 4) return BMF_4BPP;
            if (cBits <= 8) return BMF_8BPP;
            if (cBits <= 16) return BMF_16BPP;
            if (cBits <= 24) return BMF_24BPP;
            if (cBits <= 32) return BMF_32BPP;
            return 0;

        case BI_RLE4:
            return BMF_4RLE;

        case BI_RLE8:
            return BMF_8RLE;

        default:
            return 0;
    }
}

Referenced by DIB_CreateDIBSection(), GreCreateBitmap(), IntCreateDIBitmap(), IntSetDIBits(), NtGdiCreateBitmap(), NtGdiDdDDICreateDCFromMemory(), NtGdiSetDIBitsToDeviceInternal(), and NtGdiStretchDIBitsInternal().

SURFACE_AllocSurface()

PSURFACE NTAPI SURFACE_AllocSurface	(	_In_ USHORT	iType,
		_In_ ULONG	cx,
		_In_ ULONG	cy,
		_In_ ULONG	iFormat,
		_In_ ULONG	fjBitmap,
		_In_opt_ ULONG	cjWidth,
		_In_opt_ ULONG	cjBits,
		_In_opt_ PVOID	pvBits
	)

Definition at line 116 of file surface.c.

{
    ULONG cBitsPixel, cjBits, cjObject;
    PSURFACE psurf;
    SURFOBJ *pso;
    PVOID pvSection;

    NT_ASSERT(!pvBits || (iType == STYPE_BITMAP));
    NT_ASSERT((iFormat <= BMF_32BPP) || (cjBufSize != 0));
    NT_ASSERT((LONG)cy > 0);

    /* Verify format */
    if ((iFormat < BMF_1BPP) || (iFormat > BMF_PNG))
    {
        DPRINT1("Invalid bitmap format: %lu\n", iFormat);
        return NULL;
    }

    /* Get bits per pixel from the format */
    cBitsPixel = gajBitsPerFormat[iFormat];

    /* Are bits and a width in bytes given? */
    if (pvBits && cjWidth)
    {
        /* Align the width (Windows compatibility, drivers expect that) */
        cjWidth = WIDTH_BYTES_ALIGN32((cjWidth << 3) / cBitsPixel, cBitsPixel);
    }
    else
    {
        /* Calculate width from the bitmap width in pixels */
        cjWidth = WIDTH_BYTES_ALIGN32(cx, cBitsPixel);
    }

    /* Is this an uncompressed format? */
    if (iFormat <= BMF_32BPP)
    {
        /* Calculate the correct bitmap size in bytes */
        if (!NT_SUCCESS(RtlULongMult(cjWidth, cy, &cjBits)))
        {
            DPRINT1("Overflow calculating size: cjWidth %lu, cy %lu\n",
                    cjWidth, cy);
            return NULL;
        }

        /* Did we get a buffer and size? */
        if ((pvBits != NULL) && (cjBufSize != 0))
        {
            /* Make sure the buffer is large enough */
            if (cjBufSize < cjBits)
            {
                DPRINT1("Buffer is too small, required: %lu, got %lu\n",
                        cjBits, cjBufSize);
                return NULL;
            }
        }
    }
    else
    {
        /* Compressed format, use the provided size */
        NT_ASSERT(cjBufSize != 0);
        cjBits = cjBufSize;
    }

    /* Check if we need an extra large object */
    if ((iType == STYPE_BITMAP) && (pvBits == NULL) &&
        !(fjBitmap & BMF_USERMEM) && !(fjBitmap & BMF_KMSECTION))
    {
        /* Allocate an object large enough to hold the bits */
        cjObject = sizeof(SURFACE) + cjBits;
    }
    else
    {
        /* Otherwise just allocate the SURFACE structure */
        cjObject = sizeof(SURFACE);
    }

    /* Check for arithmetic overflow */
    if (cjObject < sizeof(SURFACE))
    {
        /* Fail! */
        DPRINT1("Overflow calculating cjObject: cjBits %lu\n", cjBits);
        return NULL;
    }

    /* Allocate a SURFACE object */
    psurf = (PSURFACE)GDIOBJ_AllocObjWithHandle(GDI_OBJECT_TYPE_BITMAP, cjObject);
    if (!psurf)
    {
        return NULL;
    }

    /* Initialize the basic fields */
    pso = &psurf->SurfObj;
    pso->hsurf = psurf->BaseObject.hHmgr;
    pso->sizlBitmap.cx = cx;
    pso->sizlBitmap.cy = cy;
    pso->iBitmapFormat = iFormat;
    pso->iType = iType;
    pso->fjBitmap = (USHORT)fjBitmap;
    pso->iUniq = InterlockedIncrement(&giUniqueSurface);
    pso->cjBits = cjBits;

    /* Check if we need a bitmap buffer */
    if (iType == STYPE_BITMAP)
    {
        /* Check if we got one or if we need to allocate one */
        if (pvBits != NULL)
        {
            /* Use the caller provided buffer */
            pso->pvBits = pvBits;
        }
        else if (fjBitmap & BMF_USERMEM)
        {
            /* User mode memory was requested */
            pso->pvBits = EngAllocUserMem(cjBits, 0);

            /* Check for failure */
            if (!pso->pvBits)
            {
                GDIOBJ_vDeleteObject(&psurf->BaseObject);
                return NULL;
            }
        }
        else if (fjBitmap & BMF_KMSECTION)
        {
            /* Use a kernel mode section */
            pso->pvBits = EngAllocSectionMem(&pvSection,
                                             (fjBitmap & BMF_NOZEROINIT) ?
                                                 0 : FL_ZERO_MEMORY,
                                             cjBits, TAG_DIB);

            /* Check for failure */
            if (!pso->pvBits)
            {
                GDIOBJ_vDeleteObject(&psurf->BaseObject);
                return NULL;
            }

            /* Free the section already, but keep the mapping */
            EngFreeSectionMem(pvSection, NULL);
        }
        else
        {
            /* Buffer is after the object */
            pso->pvBits = psurf + 1;

            /* Zero the buffer, except requested otherwise */
            if (!(fjBitmap & BMF_NOZEROINIT))
            {
                RtlZeroMemory(pso->pvBits, cjBits);
            }
        }

        /* Set pvScan0 and lDelta */
        if (fjBitmap & BMF_TOPDOWN)
        {
            /* Topdown is the normal way */
            pso->pvScan0 = pso->pvBits;
            pso->lDelta = cjWidth;
        }
        else
        {
            /* Inversed bitmap (bottom up) */
            pso->pvScan0 = ((PCHAR)pso->pvBits + pso->cjBits - cjWidth);
            pso->lDelta = -(LONG)cjWidth;
        }
    }
    else
    {
        /* There are no bitmap bits */
        pso->pvScan0 = pso->pvBits = NULL;
        pso->lDelta = 0;
    }

    /* Assign a default palette and increment its reference count */
    SURFACE_vSetPalette(psurf, appalSurfaceDefault[iFormat]);

    return psurf;
}

Referenced by EngCreateBitmap(), EngCreateDeviceBitmap(), EngCreateDeviceSurface(), GreCreateBitmapEx(), IntEngMaskBlt(), NtGdiCreateBitmap(), NtGdiDdDDICreateDCFromMemory(), NtGdiGetPixel(), and UserDrawIconEx().

SURFACE_ShareLockByPointer()

FORCEINLINE VOID SURFACE_ShareLockByPointer

(

PSURFACE

psurf

)

Definition at line 95 of file surface.h.

{
    GDIOBJ_vReferenceObjectByPointer(&psurf->BaseObject);
}

Referenced by NtGdiExtEscape().

SURFACE_vCleanup()

VOID NTAPI SURFACE_vCleanup

(

PVOID

ObjectBody

)

Definition at line 67 of file surface.c.

{
    PSURFACE psurf = (PSURFACE)ObjectBody;
    PVOID pvBits = psurf->SurfObj.pvBits;

    /* Check if the surface has bits */
    if (pvBits)
    {
        /* Only bitmaps can have bits */
        ASSERT(psurf->SurfObj.iType == STYPE_BITMAP);

        /* Check if it is a DIB section */
        if (psurf->hDIBSection)
        {
            /* Unmap the section view */
            EngUnmapSectionView(pvBits, psurf->dwOffset, psurf->hSecure);
        }
        else if (psurf->SurfObj.fjBitmap & BMF_USERMEM)
        {
            /* Bitmap was allocated from usermode memory */
            EngFreeUserMem(pvBits);
        }
        else if (psurf->SurfObj.fjBitmap & BMF_KMSECTION)
        {
            /* Bitmap was allocated from a kernel section */
            if (!EngFreeSectionMem(NULL, pvBits))
            {
                DPRINT1("EngFreeSectionMem failed for %p!\n", pvBits);
                // Should we BugCheck here?
                ASSERT(FALSE);
            }
        }
        else if (psurf->SurfObj.fjBitmap & BMF_POOLALLOC)
        {
            /* Free a pool allocation */
            EngFreeMem(pvBits);
        }
    }

    /* Free palette */
    if(psurf->ppal)
    {
        PALETTE_ShareUnlockPalette(psurf->ppal);
    }
}

SURFACE_vSetPalette()

FORCEINLINE VOID SURFACE_vSetPalette	(	_Inout_ PSURFACE	psurf,
		_In_ PPALETTE	ppal
	)

Definition at line 136 of file surface.h.

{
    if (psurf->ppal)
        GDIOBJ_vDereferenceObject((POBJ)psurf->ppal);
    if (ppal)
        GDIOBJ_vReferenceObjectByPointer((POBJ)ppal);
    *(PVOID*)&psurf->ppal = ppal;
}

Referenced by BITMAP_CopyBitmap(), DIB_CreateDIBSection(), EngAssociateSurface(), EngModifySurface(), IntCreateCompatibleBitmap(), IntCreateDIBitmap(), NtGdiDdDDICreateDCFromMemory(), and SURFACE_AllocSurface().

Variable Documentation

gajBitsPerFormat

UCHAR gajBitsPerFormat[]

Definition at line 21 of file surface.c.

Referenced by DC_bIsBitmapCompatible(), EngBitBlt(), GreCreateBitmapEx(), NtGdiCreateBitmap(), NtGdiMaskBlt(), and SURFACE_AllocSurface().