OutputSurface.hh

Go to the documentation of this file.

#ifndef OUTPUTSURFACE_HH
#define OUTPUTSURFACE_HH
 
#include "PixelOperations.hh"
#include "gl_vec.hh"
#include <string>
#include <cassert>
#include <cstdint>
 
namespace openmsx {
 
class OutputSurface
{
public:
        using Pixel = uint32_t;
 
        OutputSurface(const OutputSurface&) = delete;
        OutputSurface& operator=(const OutputSurface&) = delete;
 
        virtual ~OutputSurface() = default;
 
        [[nodiscard]] int getLogicalWidth()  const { return m_logicalSize[0]; }
        [[nodiscard]] int getLogicalHeight() const { return m_logicalSize[1]; }
        [[nodiscard]] gl::ivec2 getLogicalSize()  const { return m_logicalSize; }
        [[nodiscard]] gl::ivec2 getPhysicalSize() const { return m_physSize; }
 
        [[nodiscard]] gl::ivec2 getViewOffset() const { return m_viewOffset; }
        [[nodiscard]] gl::ivec2 getViewSize()   const { return m_viewSize; }
        [[nodiscard]] gl::vec2  getViewScale()  const { return m_viewScale; }
 
        [[nodiscard]] uint32_t mapRGB(gl::vec3 rgb) const
        {
                return mapRGB255(gl::ivec3(rgb * 255.0f));
        }
 
        [[nodiscard]] uint32_t mapRGB255(gl::ivec3 rgb) const
        {
                auto [r, g, b] = rgb;
                PixelOperations pixelOps;
                return pixelOps.combine(r, g, b);
        }
 
        [[nodiscard]] inline Pixel getKeyColor() const
        {
                return 0x00000000; // alpha = 0
        }
 
        virtual void saveScreenshot(const std::string& filename) = 0;
 
protected:
        OutputSurface() = default;
 
        // These two _must_ be called from (each) subclass constructor.
        void calculateViewPort(gl::ivec2 logSize, gl::ivec2 physSize);
 
private:
        gl::ivec2 m_logicalSize;
        gl::ivec2 m_physSize;
        gl::ivec2 m_viewOffset;
        gl::ivec2 m_viewSize;
        gl::vec2 m_viewScale{1.0f};
};
 
} // namespace openmsx
 
#endif