base_soft_render_surface.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 ULTIMA8_GRAPHICS_BASESOFTRENDERSURFACE_H
#define ULTIMA8_GRAPHICS_BASESOFTRENDERSURFACE_H

#include "ultima/ultima8/graphics/render_surface.h"
#include "ultima/ultima8/misc/rect.h"
#include "graphics/managed_surface.h"

namespace Ultima {
namespace Ultima8 {

//
// Class BaseSoftRenderSurface
//
// Desc: The base abstact class for software rendering in Pentagram
//
class BaseSoftRenderSurface : public RenderSurface {
protected:
    // Frame buffer
    uint8           *_pixels;                // Pointer to logical pixel 0,0
    uint8           *_pixels00;              // Pointer to physical pixel 0,0

    // Pixel Format (also see 'Colour shifting values' later)
    int             _bytesPerPixel;          // 2 or 4
    int             _bitsPerPixel;           // 16 or 32
    int             _formatType;             // 16, 555, 565, 32 or 888

    // Dimensions
    int32           _ox, _oy;                // Physical Pixel for Logical Origin
    int32           _width, _height;         // Width and height
    int32           _pitch;                  // Frame buffer pitch (bytes) (could be negated)
    bool            _flipped;

    // Clipping Rectangle
    Rect _clipWindow;

    // Locking count
    uint32          _lockCount;              // Number of locks on surface

    Graphics::ManagedSurface *_surface;

    // Create from a managed surface
    BaseSoftRenderSurface(Graphics::ManagedSurface *);

    // Update the Pixels Pointer
    void    SetPixelsPointer() {
        uint8 *pix00 = _pixels00;

        if (_flipped) {
            pix00 += -_pitch * (_height - 1);
        }

        _pixels = pix00 + _ox * _bytesPerPixel + _oy * _pitch;
    }

public:

    // Virtual Destructor
    ~BaseSoftRenderSurface() override;

    //
    // Being/End Painting
    //

    // Begin painting to the buffer. MUST BE CALLED BEFORE DOING ANYTHING TO THE SURFACE!
    // Can be called multiple times
    // Returns Error Code on error. Check return code.....
    bool BeginPainting() override;

    // Finish paining to the buffer. MUST BE CALLED FOR EACH CALL TO BeginPainting()
    // Returns Error Code on error. Check return code.....
    bool EndPainting() override;

    //
    // Surface Properties
    //

    // Set the Origin of the Surface
    void SetOrigin(int32 x, int32 y) override;

    // Set the Origin of the Surface
    void GetOrigin(int32 &x, int32 &y) const override;

    // Get the Surface Dimensions
    void GetSurfaceDims(Rect &) const override;

    // Get Clipping Rectangle
    void GetClippingRect(Rect &) const override;

    // Set Clipping Rectangle
    void SetClippingRect(const Rect &) override;

    // Check Clipped. -1 if off screen, 0 if not clipped, 1 if clipped
    int16 CheckClipped(const Rect &) const override;

    // Flip the surface
    void SetFlipped(bool flipped) override;

    // Has the render surface been flipped?
    bool IsFlipped() const override;

    //
    // Surface Palettes
    //
    // TODO: Make a Palette class
    // TODO: Handle Ultima8 and Crusader Xforms
    //

    // Set The Surface Palette
    // virtual void SetPalette(uint8 palette[768]);

    // Set The Surface Palette to be the one used by another surface
    // TODO: virtual void SetPalette(RenderSurface &);

    // Get The Surface Palette
    // TODO: virtual void GetPalette(uint8 palette[768]);

    void CreateNativePalette(Palette *palette, int maxindex = 0) override;

    Graphics::ManagedSurface *getRawSurface() const override {
        return _surface;
    }
};

} // End of namespace Ultima8
} // End of namespace Ultima

#endif