Loading...
Searching...
No Matches
Shader.hpp
Go to the documentation of this file.
1
2//
3// SFML - Simple and Fast Multimedia Library
4// Copyright (C) 2007-2015 Laurent Gomila (laurent@sfml-dev.org)
5//
6// This software is provided 'as-is', without any express or implied warranty.
7// In no event will the authors be held liable for any damages arising from the use of this software.
8//
9// Permission is granted to anyone to use this software for any purpose,
10// including commercial applications, and to alter it and redistribute it freely,
11// subject to the following restrictions:
12//
13// 1. The origin of this software must not be misrepresented;
14// you must not claim that you wrote the original software.
15// If you use this software in a product, an acknowledgment
16// in the product documentation would be appreciated but is not required.
17//
18// 2. Altered source versions must be plainly marked as such,
19// and must not be misrepresented as being the original software.
20//
21// 3. This notice may not be removed or altered from any source distribution.
22//
24
25#ifndef SFML_SHADER_HPP
26#define SFML_SHADER_HPP
27
29// Headers
31#include <SFML/Graphics/Export.hpp>
32#include <SFML/Graphics/Transform.hpp>
33#include <SFML/Graphics/Color.hpp>
34#include <SFML/Window/GlResource.hpp>
35#include <SFML/System/NonCopyable.hpp>
36#include <SFML/System/Vector2.hpp>
37#include <SFML/System/Vector3.hpp>
38#include <map>
39#include <string>
40
41
42namespace sf
43{
44class InputStream;
45class Texture;
46
51class SFML_GRAPHICS_API Shader : GlResource, NonCopyable
52{
53public:
54
59 enum Type
60 {
61 Vertex,
62 Fragment
63 };
64
72 struct CurrentTextureType {};
73
80 static CurrentTextureType CurrentTexture;
81
82public:
83
90 Shader();
91
96 ~Shader();
97
117 bool loadFromFile(const std::string& filename, Type type);
118
138 bool loadFromFile(const std::string& vertexShaderFilename, const std::string& fragmentShaderFilename);
139
158 bool loadFromMemory(const std::string& shader, Type type);
159
179 bool loadFromMemory(const std::string& vertexShader, const std::string& fragmentShader);
180
199 bool loadFromStream(InputStream& stream, Type type);
200
220 bool loadFromStream(InputStream& vertexShaderStream, InputStream& fragmentShaderStream);
221
241 void setParameter(const std::string& name, float x);
242
263 void setParameter(const std::string& name, float x, float y);
264
286 void setParameter(const std::string& name, float x, float y, float z);
287
310 void setParameter(const std::string& name, float x, float y, float z, float w);
311
331 void setParameter(const std::string& name, const Vector2f& vector);
332
352 void setParameter(const std::string& name, const Vector3f& vector);
353
379 void setParameter(const std::string& name, const Color& color);
380
402 void setParameter(const std::string& name, const Transform& transform);
403
434 void setParameter(const std::string& name, const Texture& texture);
435
457 void setParameter(const std::string& name, CurrentTextureType);
458
469 unsigned int getNativeHandle() const;
470
492 static void bind(const Shader* shader);
493
507 static bool isAvailable();
508
509private:
510
523 bool compile(const char* vertexShaderCode, const char* fragmentShaderCode);
524
532 void bindTextures() const;
533
542 int getParamLocation(const std::string& name);
543
545 // Types
547 typedef std::map<int, const Texture*> TextureTable;
548 typedef std::map<std::string, int> ParamTable;
549
551 // Member data
553 unsigned int m_shaderProgram;
554 int m_currentTexture;
555 TextureTable m_textures;
556 ParamTable m_params;
557};
558
559} // namespace sf
560
561
562#endif // SFML_SHADER_HPP
563
564
SFML_GRAPHICS_API
#define SFML_GRAPHICS_API
Definition Graphics/Export.hpp:43
sf::Color
Utility class for manipulating RGBA colors.
Definition Color.hpp:41
sf::GlResource::GlResource
GlResource()
Default constructor.
sf::InputStream
Abstract class for custom file input streams.
Definition InputStream.hpp:42
sf::NonCopyable::NonCopyable
NonCopyable()
Default constructor.
Definition NonCopyable.hpp:53
sf::Shader::loadFromFile
bool loadFromFile(const std::string &filename, Type type)
Load either the vertex or fragment shader from a file.
sf::Shader::bind
static void bind(const Shader *shader)
Bind a shader for rendering.
sf::Shader::Shader
Shader()
Default constructor.
sf::Shader::loadFromStream
bool loadFromStream(InputStream &stream, Type type)
Load either the vertex or fragment shader from a custom stream.
sf::Shader::setParameter
void setParameter(const std::string &name, const Vector2f &vector)
Change a 2-components vector parameter of the shader.
sf::Shader::loadFromStream
bool loadFromStream(InputStream &vertexShaderStream, InputStream &fragmentShaderStream)
Load both the vertex and fragment shaders from custom streams.
sf::Shader::setParameter
void setParameter(const std::string &name, float x)
Change a float parameter of the shader.
sf::Shader::~Shader
~Shader()
Destructor.
sf::Shader::setParameter
void setParameter(const std::string &name, float x, float y, float z)
Change a 3-components vector parameter of the shader.
sf::Shader::setParameter
void setParameter(const std::string &name, const Texture &texture)
Change a texture parameter of the shader.
sf::Shader::setParameter
void setParameter(const std::string &name, const Transform &transform)
Change a matrix parameter of the shader.
sf::Shader::setParameter
void setParameter(const std::string &name, const Vector3f &vector)
Change a 3-components vector parameter of the shader.
sf::Shader::setParameter
void setParameter(const std::string &name, const Color &color)
Change a color parameter of the shader.
sf::Shader::setParameter
void setParameter(const std::string &name, float x, float y)
Change a 2-components vector parameter of the shader.
sf::Shader::getNativeHandle
unsigned int getNativeHandle() const
Get the underlying OpenGL handle of the shader.
sf::Shader::CurrentTexture
static CurrentTextureType CurrentTexture
Represents the texture of the object being drawn.
Definition Shader.hpp:80
sf::Shader::loadFromMemory
bool loadFromMemory(const std::string &shader, Type type)
Load either the vertex or fragment shader from a source code in memory.
sf::Shader::loadFromFile
bool loadFromFile(const std::string &vertexShaderFilename, const std::string &fragmentShaderFilename)
Load both the vertex and fragment shaders from files.
sf::Shader::isAvailable
static bool isAvailable()
Tell whether or not the system supports shaders.
sf::Shader::loadFromMemory
bool loadFromMemory(const std::string &vertexShader, const std::string &fragmentShader)
Load both the vertex and fragment shaders from source codes in memory.
sf::Shader::setParameter
void setParameter(const std::string &name, float x, float y, float z, float w)
Change a 4-components vector parameter of the shader.
sf::Shader::setParameter
void setParameter(const std::string &name, CurrentTextureType)
Change a texture parameter of the shader.
sf::Shader::Type
Type
Types of shaders.
Definition Shader.hpp:60
sf::Shader::Vertex
@ Vertex
Vertex shader.
Definition Shader.hpp:61
sf::Shader::Fragment
@ Fragment
Fragment (pixel) shader.
Definition Shader.hpp:62
sf::Texture
Image living on the graphics card that can be used for drawing.
Definition Texture.hpp:48
sf::Transform
Define a 3x3 transform matrix.
Definition Transform.hpp:43
sf::Vector2f
Vector2< float > Vector2f
Definition Vector2.hpp:255
sf::Vector3f
Vector3< float > Vector3f
Definition Vector3.hpp:256
sf::Shader::CurrentTextureType
Special type that can be passed to setParameter, and that represents the texture of the object being ...
Definition Shader.hpp:72