client/frame.h

/* Copyright (c) 2006-2012, Stefan Eilemann <eile@equalizergraphics.com>
 *                    2010, Cedric Stalder <cedric.stalder@gmail.com>
 *
 * 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/client/api.h>
#include <eq/client/types.h>
#include <eq/client/zoomFilter.h> // enum
#include <eq/fabric/frame.h>   // base class

namespace eq
{
namespace detail{ class Frame; }

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

        EQ_API virtual ~Frame();

        EQ_API const std::string& getName() const;

        EQ_API const Range& getRange() const;

        EQ_API const Pixel& getPixel() const;

        EQ_API const SubPixel& getSubPixel() const;

        EQ_API uint32_t getPeriod() const;

        EQ_API uint32_t getPhase() const;

        EQ_API void setZoomFilter( const ZoomFilter zoomFilter );

        EQ_API ZoomFilter getZoomFilter() const;

        EQ_API const Images& getImages() const;

#ifndef EQ_2_0_API

        EQ_API void setData( FrameData* data );

        EQ_API FrameData* getData();

        EQ_API const FrameData* getData() const;
#endif

        EQ_API void setFrameData( FrameDataPtr data );

        EQ_API FrameDataPtr getFrameData();

        EQ_API ConstFrameDataPtr getFrameData() const;

        EQ_API uint32_t getBuffers() const;

        EQ_API void disableBuffer( const Buffer buffer );

        EQ_API void setAlphaUsage( const bool useAlpha );

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

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

        EQ_API void clear();

        void deleteGLObjects( ObjectManager* om );

        EQ_API void readback( ObjectManager* glObjects,
                              const DrawableConfig& config );

        EQ_API void readback( ObjectManager* glObjects,
                              const DrawableConfig& config,
                              const PixelViewports& regions );

        EQ_API Images startReadback( ObjectManager* glObjects,
                                     const DrawableConfig& config,
                                     const PixelViewports& regions );

        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