/*
 * Copyright © Canonical Ltd.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License version 2 or 3,
 * as published by the Free Software Foundation.
 *
 * 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef MIR_RENDERER_GL_RENDER_TARGET_H_
#define MIR_RENDERER_GL_RENDER_TARGET_H_

#include <mir/geometry/forward.h>

namespace mir
{
namespace renderer
{
namespace gl
{

class RenderTarget
{
public:
    virtual ~RenderTarget() = default;

    /** Returns the current size in pixels of the render target */
    virtual auto size() const -> geometry::Size = 0;
    /** Makes GL render target current to calling thread */
    virtual void make_current() = 0;
    /** Releases the current GL render target. */
    virtual void release_current() = 0;
    /**
     * Swap buffers for OpenGL rendering.
     * After this method returns is the earliest time that it is safe to
     * free GL-related resources such as textures and buffers.
     */
    virtual void swap_buffers() = 0;
    /** Binds any necessary resources (fbos, textures if any)
     * in preparation for drawing.
     */
    virtual void bind() = 0;

protected:
    RenderTarget() = default;
    RenderTarget(RenderTarget const&) = delete;
    RenderTarget& operator=(RenderTarget const&) = delete;
};

}
}
}

#endif
