screen.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef ACCESS_SCREEN_H
#define ACCESS_SCREEN_H

#include "common/scummsys.h"
#include "common/rect.h"
#include "common/stream.h"
#include "graphics/screen.h"
#include "access/asurface.h"

namespace Access {

class AccessEngine;

struct ScreenSave {
    int _clipWidth;
    int _clipHeight;
    int _windowXAdd;
    int _windowYAdd;
    Common::Point _scroll;
    int _scrollCol;
    int _scrollRow;
    Common::Point _bufferStart;
    int _screenYOff;

    ScreenSave();
};

class Screen : public BaseSurface {
private:
    AccessEngine *_vm;
    byte _tempPalette[Graphics::PALETTE_SIZE];
    byte _rawPalette[Graphics::PALETTE_SIZE];
    byte _savedPalettes[2][Graphics::PALETTE_SIZE];
    int _savedPaletteCount;
    int _vesaCurrentWin;
    int _currentPanel;
    Common::Point _msVirtualOffset;
    Common::Point _virtualOffsetsTable[4];
    bool _hideFlag;
    ScreenSave _screenSave;
    int _startCycle;
    int _cycleStart;
    int _endCycle;

    void updatePalette();
public:
    int _vesaMode;
    int _startColor, _numColors;
    Common::Point _bufferStart;
    int _windowXAdd, _windowYAdd; // the offset between the screen and the 2 buffers
    int _screenYOff;
    byte _manPal[0x84];
    byte _stilPal[99]; // only used in Noctropolis
    byte _scaleTable1[256];
    byte _scaleTable2[256];
    int _vWindowWidth;
    int _vWindowHeight;
    int _vWindowBytesWide;
    int _bufferBytesWide;
    int _vWindowLinesTall;
    bool _screenChangeFlag;
    bool _fadeIn;
public:
    void update() override;

    void copyBlock(const BaseSurface *src, const Common::Rect &bounds) override;

    void restoreBlock() override;

    void drawRect() override;

    void drawBox() override;

    void copyBuffer(Graphics::ManagedSurface *src) override;
public:
    Screen(AccessEngine *vm);

    ~Screen() override {}

    void setDisplayScan();

    void setPanel(int num);

    void forceFadeOut();

    void forceFadeIn();

    void forceFadeWhite();

    void fadeOut() { forceFadeOut(); }
    void fadeIn() { forceFadeIn(); }
    void clearScreen();

    void fadeOutThenClearAndSetPal();

    void copyRawPalToTempPal();

    void setInitialPalettte();

    void setIconPalette();

    void setManPalette();

    void setStilPalette();

    void setDarkPalette(int16 mulValue, uint firstIndex, uint count);

    void loadPalette(int fileNum, int subfile, int srcOffset = 0);

    void setPalette();

    void setRawPalette(const Graphics::Palette &p);

    void loadRawPalette(Common::SeekableReadStream *stream);

    void savePalette();

    void restorePalette();

    void getPalette(byte *pal);

    void flashPalette(int step);

    void copyBuffer(const byte *data);

    void setBufferScan();

    void setScaleTable(int scale);

    void saveScreen();

    void restoreScreen();

    void setPaletteCycle(int startCycle, int endCycle, int timer);

    void cyclePaletteForward();

    void cyclePaletteBackwards();

    void clearColor0();
};

} // End of namespace Access

#endif /* ACCESS_SCREEN_H */