config.h File Reference

#include <sgct/sgctexports.h>
#include <sgct/math.h>
#include <cstdint>
#include <filesystem>
#include <optional>
#include <string>
#include <string_view>
#include <variant>
#include <vector>

Include dependency graph for config.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	sgct::config::User
struct	sgct::config::User::Tracking
struct	sgct::config::Capture
struct	sgct::config::Capture::ScreenShotRange
struct	sgct::config::Scene
struct	sgct::config::Settings
struct	sgct::config::Settings::Display
struct	sgct::config::Tracker
struct	sgct::config::Tracker::Device
struct	sgct::config::Tracker::Device::Sensor
struct	sgct::config::Tracker::Device::Button
struct	sgct::config::Tracker::Device::Axis
struct	sgct::config::NoProjection
struct	sgct::config::CubemapProjection
struct	sgct::config::CubemapProjection::Channels
struct	sgct::config::CubemapProjection::Spout
struct	sgct::config::CubemapProjection::NDI
struct	sgct::config::CylindricalProjection
struct	sgct::config::EquirectangularProjection
struct	sgct::config::FisheyeProjection
struct	sgct::config::FisheyeProjection::Crop
struct	sgct::config::PlanarProjection
struct	sgct::config::PlanarProjection::FOV
struct	sgct::config::ProjectionPlane
struct	sgct::config::SphericalMirrorProjection
struct	sgct::config::SphericalMirrorProjection::Mesh
struct	sgct::config::TextureMappedProjection
struct	sgct::config::Viewport
struct	sgct::config::Window
struct	sgct::config::Window::Spout
struct	sgct::config::Window::NDI
struct	sgct::config::Window::Scalable
struct	sgct::config::Window::OpenXR
struct	sgct::config::Node
struct	sgct::config::GeneratorVersion
struct	sgct::config::Meta
struct	sgct::config::Cluster

Namespaces
namespace	sgct
namespace	sgct::config

Typedefs
using	sgct::config::Projections

Functions
void	sgct::config::validateUser (const User &user)
void	sgct::config::validateCapture (const Capture &capture)
void	sgct::config::validateScene (const Scene &scene)
void	sgct::config::validateSettings (const Settings &settings)
void	sgct::config::validateTracker (const Tracker &tracker)
void	sgct::config::validateProjection (const CubemapProjection &proj)
void	sgct::config::validateProjection (const CylindricalProjection &proj)
void	sgct::config::validateProjection (const EquirectangularProjection &proj)
void	sgct::config::validateProjection (const FisheyeProjection &proj)
void	sgct::config::validateProjection (const PlanarProjection &proj)
void	sgct::config::validateProjection (const ProjectionPlane &proj)
void	sgct::config::validateProjection (const SphericalMirrorProjection &proj)
void	sgct::config::validateProjection (const TextureMappedProjection &proj)
void	sgct::config::validateViewport (const Viewport &viewport)
void	sgct::config::validateWindow (const Window &window)
void	sgct::config::validateNode (const Node &node)
void	sgct::config::validateGeneratorVersion (const GeneratorVersion &gVersion)
void	sgct::config::validateCluster (const Cluster &cluster)
config::Cluster	sgct::readConfig (const std::filesystem::path &filename)
	Reads a JSON configuration file from the provided filename.
config::Cluster	sgct::readJsonConfig (std::string_view configuration)
	Reads a JSON-formatted configuration direction from the provided configuration.
config::Cluster	sgct::defaultCluster ()
std::string	sgct::serializeConfig (const config::Cluster &cluster, std::optional< config::GeneratorVersion > genVersion=std::nullopt)
	Serialize the provided cluster into its JSON string representation such that parsing the serialized string later with readJsonConfig will result int the same cluster again.
std::string	sgct::validateConfigAgainstSchema (std::string_view configuration, const std::filesystem::path &schema)
	Validate the provided JSON-based string representation of a configuration against the schema file located at the provided schema file.
std::string	sgct::validateConfigAgainstSchema (const std::filesystem::path &configuration, const std::filesystem::path &schema)
	Validate the provided configuration file against the schema file located at the provided schema file.