This is a snapshot of a work-in-progress documentation theme. If you feel lost, miss something, or want to see the original Doxygen docs instead, head over to the archived version of this documentation page.

template<UnsignedInt dimensions>
Magnum::Shaders::Flat class

Flat shader.

Draws whole mesh with given unshaded color or texture. For colored mesh you need to provide Position attribute in your triangle mesh and call at least setTransformationProjectionMatrix() and setColor().

If you want to use texture, you need to provide also TextureCoordinates attribute. Pass Flag::Textured to constructor and then at render time don't forget to set also the texture via setTexture(). The texture is multipled by the color, which is by default set to fully opaque white if texturing is enabled.

For coloring the texture based on intensity you can use the Vector shader.

Image

Example usage

Colored mesh

Common mesh setup:

struct Vertex {
    Vector3 position;
};
Vertex data[] = { ... };

Buffer vertices;
vertices.setData(data, BufferUsage::StaticDraw);

Mesh mesh;
mesh.addVertexBuffer(vertices, 0, Shaders::Flat3D::Position{});

Common rendering setup:

Matrix4 transformationMatrix = Matrix4::translation(Vector3::zAxis(-5.0f));
Matrix4 projectionMatrix = Matrix4::perspectiveProjection(35.0_degf, 1.0f, 0.001f, 100.0f);

Shaders::Flat3D shader;
shader.setColor(Color3::fromHSV(216.0_degf, 0.85f, 1.0f))
    .setTransformationProjectionMatrix(projectionMatrix*transformationMatrix);

mesh.draw(shader);

Textured mesh

Common mesh setup:

struct Vertex {
    Vector3 position;
    Vector2 textureCoordinates;
};
Vertex data[] = { ... };

Buffer vertices;
vertices.setData(data, BufferUsage::StaticDraw);

Mesh mesh;
mesh.addVertexBuffer(vertices, 0,
    Shaders::Flat3D::Position{},
    Shaders::Flat3D::TextureCoordinates{});

Common rendering setup:

Matrix4 transformationMatrix, projectionMatrix;
Texture2D texture;

Shaders::Flat3D shader{Shaders::Flat3D::Textured};
shader.setTransformationProjectionMatrix(projectionMatrix*transformationMatrix)
    .setTexture(texture);

mesh.draw(shader);

Base classes

class AbstractShaderProgram
Base for shader program implementations.

Public types

enum class Flag: UnsignedByte { Textured = 1 << 0 }
Flag.
using Position = Generic<dimensions>::Position
Vertex position.
using TextureCoordinates = Generic<dimensions>::TextureCoordinates
2D texture coordinates
using Flags = Containers::EnumSet<Flag>
Flags.

Constructors, destructors, conversion operators

Flat(Flags flags = {}) explicit
Constructor.
Flat(NoCreateT) explicit noexcept
Construct without creating the underlying OpenGL object.

Public functions

auto flags() const -> Flags
Flags.
auto setTransformationProjectionMatrix(const MatrixTypeFor<dimensions, Float>& matrix) -> Flat<dimensions>&
Set transformation and projection matrix.
auto setColor(const Color4& color) -> Flat<dimensions>&
Set color.
auto setTexture(Texture2D& texture) -> Flat<dimensions>&
Set texture.

Enum documentation

template<UnsignedInt dimensions>
enum class Magnum::Shaders::Flat<dimensions>::Flag: UnsignedByte

Flag.

Enumerators
Textured

The shader uses texture instead of color

Typedef documentation

template<UnsignedInt dimensions>
typedef Generic<dimensions>::Position Magnum::Shaders::Flat<dimensions>::Position

Vertex position.

Generic attribute, Vector2 in 2D, Vector3 in 3D.

template<UnsignedInt dimensions>
typedef Generic<dimensions>::TextureCoordinates Magnum::Shaders::Flat<dimensions>::TextureCoordinates

2D texture coordinates

Generic attribute, Vector2. Used only if Flag::Textured is set.

template<UnsignedInt dimensions>
typedef Containers::EnumSet<Flag> Magnum::Shaders::Flat<dimensions>::Flags

Flags.

Function documentation

template<UnsignedInt dimensions>
Magnum::Shaders::Flat<dimensions>::Flat(Flags flags = {}) explicit

Constructor.

Parameters
flags Flags

template<UnsignedInt dimensions>
Magnum::Shaders::Flat<dimensions>::Flat(NoCreateT) explicit noexcept

Construct without creating the underlying OpenGL object.

The constructed instance is equivalent to moved-from state. Useful in cases where you will overwrite the instance later anyway. Move another object over it to make it useful.

This function can be safely used for constructing (and later destructing) objects even without any OpenGL context being active.

template<UnsignedInt dimensions>
Flat<dimensions>& Magnum::Shaders::Flat<dimensions>::setTransformationProjectionMatrix(const MatrixTypeFor<dimensions, Float>& matrix)

Set transformation and projection matrix.

Returns Reference to self (for method chaining)

template<UnsignedInt dimensions>
Flat<dimensions>& Magnum::Shaders::Flat<dimensions>::setColor(const Color4& color)

Set color.

Returns Reference to self (for method chaining)

If Flag::Textured is set, default value is {1.0f, 1.0f, 1.0f} and the color will be multiplied with texture.

template<UnsignedInt dimensions>
Flat<dimensions>& Magnum::Shaders::Flat<dimensions>::setTexture(Texture2D& texture)

Set texture.

Returns Reference to self (for method chaining)

Has effect only if Flag::Textured is set.