frame.h

/* Copyright (c) 2006-2017, Stefan Eilemann <eile@equalizergraphics.com>
 *                          Daniel Nachbaur <danielnachbaur@gmail.com>
 *                          Cedric Stalder <cedric.stalder@gmail.com>
 *                          Enrique <egparedes@ifi.uzh.ch>
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 2.1 as published
 * by the Free Software Foundation.
 *
 * This library 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 library; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef EQ_FRAME_H
#define EQ_FRAME_H

#include <eq/api.h>
#include <eq/fabric/frame.h> // base class
#include <eq/types.h>
#include <eq/zoomFilter.h> // enum

namespace eq
{
namespace detail
{
class Frame;
}

class Frame : public fabric::Frame
{
public:
    EQ_API Frame();

    EQ_API virtual ~Frame();

    EQ_API void setZoomFilter(const ZoomFilter zoomFilter);

    EQ_API ZoomFilter getZoomFilter() const;

    EQ_API const Images& getImages() const;

    EQ_API void setFrameData(FrameDataPtr data);

    EQ_API FrameDataPtr getFrameData();

    EQ_API ConstFrameDataPtr getFrameData() const;

    EQ_API Buffer getBuffers() const;

    EQ_API void disableBuffer(const Buffer buffer);

    EQ_API void setAlphaUsage(const bool useAlpha);

    EQ_API void setQuality(const Buffer buffer, const float quality);

    EQ_API void useCompressor(const Buffer buffer, const uint32_t name);

    EQ_API void clear();

    void deleteGLObjects(util::ObjectManager& om);

    EQ_API void readback(util::ObjectManager& glObjects,
                         const DrawableConfig& config,
                         const PixelViewports& regions,
                         const RenderContext& context);

    EQ_API Images startReadback(util::ObjectManager& glObjects,
                                const DrawableConfig& config,
                                const PixelViewports& regions,
                                const RenderContext& context);

    void setReady();

    EQ_API bool isReady() const;

    EQ_API void waitReady(const uint32_t timeout = LB_TIMEOUT_INDEFINITE) const;

    void addListener(lunchbox::Monitor<uint32_t>& listener);

    void removeListener(lunchbox::Monitor<uint32_t>& listener);

private:
    detail::Frame* const _impl;
};
};
#endif // EQ_FRAME_H