//**********************************************************************
//                                                                      
// Filename: gpeflat.h
//                                                                      
// Description: Header file for the GPEFlat Class.
//                                                                      
// THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF
// ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO
// THE IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A
// PARTICULAR PURPOSE.
// Copyright(c) Cirrus Logic Corporation 2001, All Rights Reserved                       
//                                                                      
//**********************************************************************

#ifndef __GPEFLAT_H__
#define __GPEFLAT_H__

class GPEFlat : public GPE
{
private:

    GPEMode         m_ModeInfo;
    DWORD           m_pvFlatFrameBuffer;
    DWORD           m_cbScanLineLength;
    DWORD           m_cxPhysicalScreen;
    DWORD           m_cyPhysicalScreen;
    DWORD           m_ulColorDepth;
    DWORD           m_VirtualFrameBuffer;
    DWORD           m_RedMaskSize;
    DWORD           m_RedMaskPosition;
    DWORD           m_GreenMaskSize;
    DWORD           m_GreenMaskPosition;
    DWORD           m_BlueMaskSize;
    DWORD           m_BlueMaskPosition;

    BOOL            m_CursorDisabled;
    BOOL            m_CursorVisible;
    BOOL            m_CursorForcedOff;
    RECTL           m_CursorRect;
    POINTL          m_CursorSize;
    POINTL          m_CursorHotspot;
    UCHAR           *m_CursorBackingStore;
    UCHAR           *m_CursorXorShape;
    UCHAR           *m_CursorAndShape;
    PALETTEENTRY    m_Palette[256];
    Ep931xRegistrySettings   m_Registry;

    

public:
                    GPEFlat(void);
    virtual INT     NumModes(void);
    virtual SCODE   SetMode(INT modeId, HPALETTE *palette);
    virtual INT     InVBlank(void);
    virtual SCODE   SetPalette(const PALETTEENTRY *source, USHORT firstEntry,
                                USHORT numEntries);
    virtual SCODE   GetModeInfo(GPEMode *pMode, INT modeNumber);
    virtual SCODE   SetPointerShape(GPESurf *mask, GPESurf *colorSurface,
                                    INT xHot, INT yHot, INT cX, INT cY);
    virtual SCODE   MovePointer(INT xPosition, INT yPosition);
    virtual void    WaitForNotBusy(void);
    virtual INT     IsBusy(void);
    virtual void    GetPhysicalVideoMemory(unsigned long *physicalMemoryBase, unsigned long *videoMemorySize);
    virtual SCODE   AllocSurface(GPESurf **surface, INT width, INT height,
                                    EGPEFormat format, INT surfaceFlags);
    virtual SCODE   Line(GPELineParms *lineParameters, EGPEPhase phase);
    virtual SCODE   BltPrepare(GPEBltParms *blitParameters);
    virtual SCODE   BltComplete(GPEBltParms *blitParameters);
    virtual ULONG   GetGraphicsCaps();

    SCODE           WrappedEmulatedLine (GPELineParms *lineParameters);
    void            CursorOn (void);
    void            CursorOff (void);
};


#endif __GPEFLAT_H__