screencapture.h

Go to the documentation of this file.

/*****************************************************************************************
 * SGCT                                                                                  *
 * Simple Graphics Cluster Toolkit                                                       *
 *                                                                                       *
 * Copyright (c) 2012-2026                                                               *
 * For conditions of distribution and use, see copyright notice in LICENSE.md            *
 ****************************************************************************************/
 
#ifndef __SGCT__SCREENCAPTURE__H__
#define __SGCT__SCREENCAPTURE__H__
 
#include <sgct/sgctexports.h>
 
#include <sgct/math.h>
#include <cstdint>
#include <memory>
#include <mutex>
#include <string>
#include <thread>
#include <vector>
 
namespace sgct {
 
class Image;
class Window;

class SGCT_EXPORT ScreenCapture {
public:
    enum class CaptureSource { Texture, BackBuffer, LeftBackBuffer, RightBackBuffer };
    enum class EyeIndex { Mono, StereoLeft, StereoRight };
 
    struct ScreenCaptureThreadInfo {
        std::string filename;
        std::unique_ptr<Image> frameBufferImage;
        std::unique_ptr<std::thread> captureThread;
        std::mutex* mutex = nullptr;
        bool isRunning = false; // needed for test if running without join
    };
 
    ScreenCapture(const Window& window, ScreenCapture::EyeIndex ei, int bytesPerColor,
        unsigned int colorDataType, bool addAlpha);
    ~ScreenCapture();

    void resize(ivec2 resolution);

    void saveScreenCapture(unsigned int textureId,
        CaptureSource capSrc = CaptureSource::Texture);
 
private:
    std::string createFilename(uint64_t frameNumber);
    int availableCaptureThread();
    Image* prepareImage(int index, std::string file);
 
    std::mutex _mutex;
    std::vector<ScreenCaptureThreadInfo> _captureInfos;
 
    const unsigned int _nThreads;
    unsigned int _pbo = 0;
    const unsigned int _downloadType;
    int _dataSize = 0;
    ivec2 _resolution = ivec2{ 0, 0 };
    const int _bytesPerColor;
    const bool _addAlpha;
 
    const EyeIndex _eyeIndex;
    const Window& _window;
};
 
} // namespace sgct
 
#endif // __SGCT__SCREENCAPTURE__H__