Layer.hh

Go to the documentation of this file.

#ifndef LAYER_HH
#define LAYER_HH
 
namespace openmsx {
 
class OutputSurface;
class LayerListener;
 
class Layer
{
public:
        enum ZIndex {
                Z_DUMMY = -1,
                Z_BACKGROUND = 0,
                Z_MSX_PASSIVE = 30,
                Z_MSX_ACTIVE = 40,
                Z_OSDGUI = 50,
                Z_CONSOLE = 100
        };
 
        enum Coverage {
                COVER_FULL,
                COVER_PARTIAL,
                COVER_NONE
        };
 
        virtual ~Layer() = default;
 
        virtual void paint(OutputSurface& output) = 0;
 
        [[nodiscard]] ZIndex getZ() const { return z; }
        [[nodiscard]] bool isActive() const { return getZ() == Z_MSX_ACTIVE; }
 
        [[nodiscard]] Coverage getCoverage() const { return coverage; }
 
        void setDisplay(LayerListener& display_) { display = &display_; }
 
protected:
        explicit Layer(Coverage coverage_ = COVER_NONE, ZIndex z_ = Z_DUMMY)
                : coverage(coverage_), z(z_)
        {
        }
 
        void setCoverage(Coverage coverage_) { coverage = coverage_; }
 
        void setZ(ZIndex z);
 
private:
        LayerListener* display = nullptr;
 
        Coverage coverage;
 
        ZIndex z;
 
        friend class ScopedLayerHider; // for setCoverage()
};
 
 
class ScopedLayerHider
{
public:
        explicit ScopedLayerHider(Layer& layer);
        ~ScopedLayerHider();
private:
        Layer& layer;
        Layer::Coverage originalCoverage;
};
 
} // namespace openmsx
 
#endif