Shader.hpp

//
// SFML - Simple and Fast Multimedia Library
// Copyright (C) 2007-2018 Laurent Gomila (laurent@sfml-dev.org)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//

#ifndef SFML_SHADER_HPP
#define SFML_SHADER_HPP

// Headers
#include <SFML/Graphics/Export.hpp>
#include <SFML/Graphics/Glsl.hpp>
#include <SFML/Window/GlResource.hpp>
#include <SFML/System/NonCopyable.hpp>
#include <SFML/System/Vector2.hpp>
#include <SFML/System/Vector3.hpp>
#include <map>
#include <string>


namespace sf
{
class Color;
class InputStream;
class Texture;
class Transform;

class SFML_GRAPHICS_API Shader : GlResource, NonCopyable
{
public:

    enum Type
    {
        Vertex,   
        Geometry, 
        Fragment  
    };

    struct CurrentTextureType {};

    static CurrentTextureType CurrentTexture;

public:

    Shader();

    ~Shader();

    bool loadFromFile(const std::string& filename, Type type);

    bool loadFromFile(const std::string& vertexShaderFilename, const std::string& fragmentShaderFilename);

    bool loadFromFile(const std::string& vertexShaderFilename, const std::string& geometryShaderFilename, const std::string& fragmentShaderFilename);

    bool loadFromMemory(const std::string& shader, Type type);

    bool loadFromMemory(const std::string& vertexShader, const std::string& fragmentShader);

    bool loadFromMemory(const std::string& vertexShader, const std::string& geometryShader, const std::string& fragmentShader);

    bool loadFromStream(InputStream& stream, Type type);

    bool loadFromStream(InputStream& vertexShaderStream, InputStream& fragmentShaderStream);

    bool loadFromStream(InputStream& vertexShaderStream, InputStream& geometryShaderStream, InputStream& fragmentShaderStream);

    void setUniform(const std::string& name, float x);

    void setUniform(const std::string& name, const Glsl::Vec2& vector);

    void setUniform(const std::string& name, const Glsl::Vec3& vector);

    void setUniform(const std::string& name, const Glsl::Vec4& vector);

    void setUniform(const std::string& name, int x);

    void setUniform(const std::string& name, const Glsl::Ivec2& vector);

    void setUniform(const std::string& name, const Glsl::Ivec3& vector);

    void setUniform(const std::string& name, const Glsl::Ivec4& vector);

    void setUniform(const std::string& name, bool x);

    void setUniform(const std::string& name, const Glsl::Bvec2& vector);

    void setUniform(const std::string& name, const Glsl::Bvec3& vector);

    void setUniform(const std::string& name, const Glsl::Bvec4& vector);

    void setUniform(const std::string& name, const Glsl::Mat3& matrix);

    void setUniform(const std::string& name, const Glsl::Mat4& matrix);

    void setUniform(const std::string& name, const Texture& texture);

    void setUniform(const std::string& name, CurrentTextureType);

    void setUniformArray(const std::string& name, const float* scalarArray, std::size_t length);

    void setUniformArray(const std::string& name, const Glsl::Vec2* vectorArray, std::size_t length);

    void setUniformArray(const std::string& name, const Glsl::Vec3* vectorArray, std::size_t length);

    void setUniformArray(const std::string& name, const Glsl::Vec4* vectorArray, std::size_t length);

    void setUniformArray(const std::string& name, const Glsl::Mat3* matrixArray, std::size_t length);

    void setUniformArray(const std::string& name, const Glsl::Mat4* matrixArray, std::size_t length);

    SFML_DEPRECATED void setParameter(const std::string& name, float x);

    SFML_DEPRECATED void setParameter(const std::string& name, float x, float y);

    SFML_DEPRECATED void setParameter(const std::string& name, float x, float y, float z);

    SFML_DEPRECATED void setParameter(const std::string& name, float x, float y, float z, float w);

    SFML_DEPRECATED void setParameter(const std::string& name, const Vector2f& vector);

    SFML_DEPRECATED void setParameter(const std::string& name, const Vector3f& vector);

    SFML_DEPRECATED void setParameter(const std::string& name, const Color& color);

    SFML_DEPRECATED void setParameter(const std::string& name, const Transform& transform);

    SFML_DEPRECATED void setParameter(const std::string& name, const Texture& texture);

    SFML_DEPRECATED void setParameter(const std::string& name, CurrentTextureType);

    unsigned int getNativeHandle() const;

    static void bind(const Shader* shader);

    static bool isAvailable();

    static bool isGeometryAvailable();

private:

    bool compile(const char* vertexShaderCode, const char* geometryShaderCode, const char* fragmentShaderCode);

    void bindTextures() const;

    int getUniformLocation(const std::string& name);

    struct UniformBinder;

    // Types
    typedef std::map<int, const Texture*> TextureTable;
    typedef std::map<std::string, int> UniformTable;

    // Member data
    unsigned int m_shaderProgram;  
    int          m_currentTexture; 
    TextureTable m_textures;       
    UniformTable m_uniforms;       
};

} // namespace sf


#endif // SFML_SHADER_HPP