FrameBuffer.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2024, EPFL/Blue Brain Project
 *
 * The Blue Brain BioExplorer is a tool for scientists to extract and analyse
 * scientific data from visualization
 *
 * This file is part of Blue Brain BioExplorer <https://github.com/BlueBrain/BioExplorer>
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 3.0 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.
 */
 
#pragma once
 
#include <platform/core/common/Api.h>
#include <platform/core/common/BaseObject.h>
#include <platform/core/common/Types.h>
#include <platform/core/common/utils/ImageUtils.h>
 
namespace core
{
class FrameBuffer : public BaseObject
{
public:
    PLATFORM_API FrameBuffer(const std::string& name, const Vector2ui& frameSize, FrameBufferFormat frameBufferFormat);
 
    PLATFORM_API virtual void map() = 0;
 
    PLATFORM_API virtual void unmap() = 0;
 
    PLATFORM_API virtual const uint8_t* getColorBuffer() const = 0;
 
    PLATFORM_API virtual const float* getFloatBuffer() const = 0;
 
    PLATFORM_API virtual void resize(const Vector2ui& frameSize) = 0;
 
    PLATFORM_API virtual void clear() { _accumFrames = 0; }
 
    PLATFORM_API virtual Vector2ui getSize() const { return _frameSize; }
 
    PLATFORM_API virtual void setAccumulation(const bool accumulation) { _accumulation = accumulation; }
 
    PLATFORM_API virtual void setFormat(FrameBufferFormat frameBufferFormat) { _frameBufferFormat = frameBufferFormat; }
 
    PLATFORM_API virtual void setSubsampling(const size_t) {}
 
    PLATFORM_API virtual void createPixelOp(const std::string& /*name*/){};
 
    PLATFORM_API virtual void updatePixelOp(const PropertyMap& /*properties*/){};
 
    PLATFORM_API size_t getColorDepth() const;
 
    PLATFORM_API const Vector2ui& getFrameSize() const { return _frameSize; }
 
    PLATFORM_API bool getAccumulation() const { return _accumulation; }
 
    PLATFORM_API FrameBufferFormat getFrameBufferFormat() const { return _frameBufferFormat; }
 
    PLATFORM_API const std::string& getName() const { return _name; }
 
    PLATFORM_API void incrementAccumFrames() { ++_accumFrames; }
 
    PLATFORM_API size_t numAccumFrames() const { return _accumFrames; }
 
    PLATFORM_API freeimage::ImagePtr getImage();
 
    PLATFORM_API void setAccumulationType(const AccumulationType accumulationType)
    {
        _accumulationType = accumulationType;
    }
 
    PLATFORM_API AccumulationType getAccumulationType() const { return _accumulationType; }
 
protected:
    const std::string _name;
    Vector2ui _frameSize;
    FrameBufferFormat _frameBufferFormat;
    bool _accumulation{true};
    AccumulationType _accumulationType{AccumulationType::linear};
    std::atomic_size_t _accumFrames{0};
};
} // namespace core