commandline.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__COMMANDLINE__H__
#define __SGCT__COMMANDLINE__H__
 
#include <sgct/sgctexports.h>
 
#include <sgct/log.h>
#include <filesystem>
#include <optional>
#include <string>
#include <vector>
 
namespace sgct {
 
struct SGCT_EXPORT Configuration {
    std::optional<std::string> configFilename;
    std::optional<bool> isServer;
    std::optional<Log::Level> logLevel;
    std::optional<bool> showHelpText;
    std::optional<int> nodeId;
    std::optional<bool> firmSync;
    std::optional<bool> ignoreSync;
    std::optional<int> nCaptureThreads;
    std::optional<std::filesystem::path> screenshotPath;
    std::optional<std::string> screenshotPrefix;
    std::optional<bool> addNodeNameInScreenshot;
    std::optional<bool> omitWindowNameInScreenshot;
    std::optional<bool> useOpenGLDebugContext;
 
    std::optional<bool> printWaitMessage;
    std::optional<float> waitTimeout;
};

SGCT_EXPORT Configuration parseArguments(std::vector<std::string>& arg);

SGCT_EXPORT std::string helpMessage();
 
} // namespace sgct
 
#endif // __SGCT__COMMANDLINE__H__