VuoShaderFile.hh

Go to the documentation of this file.

 
#pragma once
 
#include <vector>
 
#include "VuoFileUtilities.hh"
 
typedef struct _VuoShader *VuoShader; 
class VuoShaderIssues;
class VuoCompositionMetadata;
 
class VuoShaderFile
{
public:
 
    enum Type
    {
        GLSLImageFilter,
        GLSLImageGenerator,
        GLSLImageTransition,
        GLSLObjectRenderer,
        GLSLObjectFilter,
    };
 
    enum Stage
    {
        Vertex,
        Geometry,
        Fragment,
 
        Program,
    };
 
    struct Port
    {
        string key;
        string vuoTypeName;
        json_object *vuoPortDetails;
    };
 
    VuoShaderFile(Type type);
    VuoShaderFile(VuoFileUtilities::File file, const string &overriddenFragmentSource="");
 
    static VuoFileUtilities::File getTemplate(Type type);
    static string stageName(Stage stage);
    void dump();
 
    string name();
 
    Type type();
    string typeName();
    string typeNameISF();
 
//  bool typeAllowsVertexShader(); // All types allow a Vertex Shader.
    bool typeAllowsGeometryShader();
    bool typeAllowsFragmentShader();
 
    static set<string> supportedVuoTypes();
 
    VuoCompositionMetadata *metadata();
    void setMetadata(VuoCompositionMetadata *metadata);
 
    json_object *vuoModuleMetadata();
    void setVuoModuleMetadata(json_object *metadata);
 
    vector<Port> inputPorts();
    void setInputPorts(vector<Port> ports);
    bool showsTime();
 
    Port outputPort();
 
    string &vertexSource();
    void setVertexSource(const string &source);
    string expandedVertexSource();
 
    string &geometrySource();
    void setGeometrySource(const string &source);
    string expandedGeometrySource();
 
    string &fragmentSource();
    void setFragmentSource(const string &source);
    string expandedFragmentSource();
 
    void save(string filePath);
    string fragmentFileContents();
 
private:
    void init(VuoFileUtilities::File file, const string &overriddenFragmentSource="");
    string readStage(VuoFileUtilities::File path);
    void splitMetadataAndSource(string inputString, json_object **outputMetadata, string &outputSourceString);
    void parseMetadata(json_object *metadata);
    string vuoTypeForIsfType(string isfType);
    string isfTypeForVuoType(string vuoType);
    string glslDeclarationForPort(Port port);
    void saveStage(string filePath, string &source, json_object *vuoModuleMetadata=NULL);
    string stageFileContents(string &source, json_object *vuoModuleMetadata=NULL);
    string spacesToTabs(string &str);
    void insertPreamble(ostringstream &oss, bool isFragment);
 
    json_object *_vuoModuleMetadata;
 
    string basename;
    string extension;
 
    Type _type;
 
    vector<Port> _inputPorts;
    string outputKey;
    string outputName;
 
    string _vertexSource;
    string _geometrySource;
    string _fragmentSource;
 
    string isfVersion;
    string shaderVersion;
    string _name;
    string copyright;
    string license;
    string description;
    string homepageLink;
    string documentationLink;
    vector<string> categories;
    vector<string> keywords;
    vector<string> examples;
    bool _showsTime;
};