ic
/
magnum
mirror of https://github.com/mosra/magnum.git
6
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Shaders: more convenient VertexColor::Color[34] attribute specifiers. 

Much easier to write (and explain!) than Shaders::VertexColor2D::Color{
Shaders::VertexColor2D::Color::Components::Three}. Ugh. Why again it
took me *years* to realize?
pull/255/head
Vladimír Vondruš 8 years ago
parent
53c6d763ae
commit
453fc0b3e7
8 changed files with 67 additions and 29 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 9
      doc/changelog.dox
  2. 4
      doc/generated/primitives.cpp
  3. 2
      doc/generated/shaders.cpp
  4. 2
      doc/snippets/MagnumShaders.cpp
  5. 2
      src/Magnum/DebugTools/ObjectRenderer.cpp
  6. 44
      src/Magnum/Shaders/Generic.h
  7. 2
      src/Magnum/Shaders/VertexColor.cpp
  8. 31
      src/Magnum/Shaders/VertexColor.h

9
doc/changelog.dox
Unescape View File

@ -92,6 +92,12 @@ See also:
- @ref Platform::GlfwApplication no longer stores a needless global window
pointer
@subsubsection changelog-latest-changes-shaders Shaders library
- New dedicated @ref Shaders::VertexColor::Color3 and
@ref Shaders::VertexColor::Color4 attribute specifiers for more convenient
distinction between three- and four-component vertex color attribute.
@subsubsection changelog-latest-changes-trade Trade library
- @ref Trade::PhongMaterialData now contains well-defined color values
@ -145,6 +151,9 @@ See also:
tuple was deprecated, use the simpler version taking just
@ref Trade::MeshData2D / @ref Trade::MeshData3D and directly returning a
@ref GL::Mesh instead
- `Shaders::VertexColor::Color` is deprecated, use the direct
@ref Shaders::VertexColor::Color3 or @ref Shaders::VertexColor::Color4
alternatives instead
@subsection changelog-latest-compatibility Potential compatibility breakages, removed APIs

4
doc/generated/primitives.cpp
Unescape View File

@ -176,7 +176,7 @@ int PrimitiveVisualizer::exec() {
vertices.setData(MeshTools::interleave(data->positions(0), data->colors(0)), GL::BufferUsage::StaticDraw);
indices.setData(data->indices(), GL::BufferUsage::StaticDraw);
GL::Mesh mesh;
mesh.addVertexBuffer(vertices, 0, Shaders::VertexColor2D::Position{}, Shaders::VertexColor2D::Color{Shaders::VertexColor2D::Color::Components::Four})
mesh.addVertexBuffer(vertices, 0, Shaders::VertexColor2D::Position{}, Shaders::VertexColor2D::Color4{})
.setIndexBuffer(indices, 0, GL::MeshIndexType::UnsignedInt)
.setCount(data->indices().size())
.setPrimitive(data->primitive());
@ -205,7 +205,7 @@ int PrimitiveVisualizer::exec() {
vertices.setData(MeshTools::interleave(data->positions(0), data->colors(0)), GL::BufferUsage::StaticDraw);
indices.setData(data->indices(), GL::BufferUsage::StaticDraw);
GL::Mesh mesh;
mesh.addVertexBuffer(vertices, 0, Shaders::VertexColor3D::Position{}, Shaders::VertexColor3D::Color{Shaders::VertexColor3D::Color::Components::Four})
mesh.addVertexBuffer(vertices, 0, Shaders::VertexColor3D::Position{}, Shaders::VertexColor3D::Color4{})
.setIndexBuffer(indices, 0, GL::MeshIndexType::UnsignedInt)
.setCount(data->indices().size())
.setPrimitive(data->primitive());

2
doc/generated/shaders.cpp
Unescape View File

@ -202,7 +202,7 @@ std::string ShaderVisualizer::vertexColor() {
.setCount(sphere.indices().size())
.addVertexBuffer(vertices, 0,
Shaders::VertexColor3D::Position{},
Shaders::VertexColor3D::Color{Shaders::VertexColor3D::Color::Components::Three})
Shaders::VertexColor3D::Color3{})
.setIndexBuffer(indices, 0, GL::MeshIndexType::UnsignedInt);
Shaders::VertexColor3D shader;

2
doc/snippets/MagnumShaders.cpp
Unescape View File

@ -414,7 +414,7 @@ vertices.setData(data, GL::BufferUsage::StaticDraw);
GL::Mesh mesh;
mesh.addVertexBuffer(vertices, 0,
Shaders::VertexColor3D::Position{},
Shaders::VertexColor3D::Color{Shaders::VertexColor3D::Color::Components::Three});
Shaders::VertexColor3D::Color3{});
/* [VertexColor-usage1] */
/* [VertexColor-usage2] */

2
src/Magnum/DebugTools/ObjectRenderer.cpp
Unescape View File

@ -89,7 +89,7 @@ template<UnsignedInt dimensions> ObjectRenderer<dimensions>::ObjectRenderer(Scen
.setCount(data.indices().size())
.addVertexBuffer(*vertexBuffer, 0,
typename Shaders::VertexColor<dimensions>::Position(),
typename Shaders::VertexColor<dimensions>::Color{Shaders::VertexColor<dimensions>::Color::Components::Four})
typename Shaders::VertexColor<dimensions>::Color4{})
.setIndexBuffer(*indexBuffer, 0, GL::MeshIndexType::UnsignedByte, 0, data.positions(0).size());
ResourceManager::instance().set<GL::Mesh>(_mesh.key(), mesh, ResourceDataState::Final, ResourcePolicy::Manual);
}

44
src/Magnum/Shaders/Generic.h
Unescape View File

@ -68,27 +68,41 @@ template<UnsignedInt dimensions> struct Generic {
typedef GL::Attribute<2, Vector3> Normal;
/**
* @brief Vertex color
* @brief Three-component vertex color.
*
* @ref Magnum::Color3. Use either this or the @ref Color4 attribute.
*/
typedef GL::Attribute<3, Magnum::Color3> Color3;
/**
* @brief Four-component vertex color.
*
* @ref Color4, however defaults to @ref Color3 if @ref MAGNUM_BUILD_DEPRECATED
* is defined. See the constructor documentation for more information.
* @ref Magnum::Color4. Use either this or the @ref Color3 attribute.
*/
typedef GL::Attribute<3, Magnum::Color4> Color4;
#ifdef MAGNUM_BUILD_DEPRECATED
/**
* @brief Vertex color
* @deprecated Use @ref Color3 or @ref Color4 instead.
*/
struct Color: GL::Attribute<3, Color4> {
struct Color: GL::Attribute<3, Magnum::Color4> {
/**
* @brief Constructor
* @param components Component count
* @param dataType Type of passed data
* @param dataOptions Data options
*
* @deprecated Use @ref Color3 or @ref Color4 instead.
*/
constexpr explicit Color(Components components, DataType dataType = DataType::Float, DataOptions dataOptions = {});
CORRADE_DEPRECATED("use Color3 or Color4 instead") constexpr explicit Color(Components components, DataType dataType = DataType::Float, DataOptions dataOptions = {});
#ifdef MAGNUM_BUILD_DEPRECATED
/** @brief @copybrief Color(Components, DataType, DataOptions)
* @deprecated Use @ref Color(Components, DataType, DataOptions) instead.
* @deprecated Use @ref Color3 or @ref Color4 instead.
*/
CORRADE_DEPRECATED("use Color(Components, DataType, DataOptions) instead") constexpr explicit Color(DataType dataType = DataType::Float, DataOptions dataOptions = {});
#endif
CORRADE_DEPRECATED("use Color3 or Color4 instead") constexpr explicit Color(DataType dataType = DataType::Float, DataOptions dataOptions = {});
};
#endif
};
#endif
@ -101,14 +115,16 @@ typedef Generic<3> Generic3D;
#ifndef DOXYGEN_GENERATING_OUTPUT
struct BaseGeneric {
typedef GL::Attribute<1, Vector2> TextureCoordinates;
typedef GL::Attribute<3, Magnum::Color3> Color3;
typedef GL::Attribute<3, Magnum::Color4> Color4;
struct Color: GL::Attribute<3, Color4> {
constexpr explicit Color(Components components, DataType dataType = DataType::Float, DataOptions dataOptions = DataOptions()): Attribute<3, Color4>{components, dataType, dataOptions} {}
#ifdef MAGNUM_BUILD_DEPRECATED
struct Color: GL::Attribute<3, Magnum::Color4> {
CORRADE_DEPRECATED("use Color3 or Color4 instead") constexpr explicit Color(Components components, DataType dataType = DataType::Float, DataOptions dataOptions = DataOptions()): Attribute<3, Magnum::Color4>{components, dataType, dataOptions} {}
#ifdef MAGNUM_BUILD_DEPRECATED
CORRADE_DEPRECATED("use Color(Components, DataType, DataOptions) instead") constexpr explicit Color(DataType dataType = DataType::Float, DataOptions dataOptions = DataOptions()): Attribute<3, Color4>{Components::Three, dataType, dataOptions} {}
#endif
CORRADE_DEPRECATED("use Color3 or Color4 instead") constexpr explicit Color(DataType dataType = DataType::Float, DataOptions dataOptions = DataOptions()): Attribute<3, Magnum::Color4>{Components::Three, dataType, dataOptions} {}
};
#endif
};
template<> struct Generic<2>: BaseGeneric {

2
src/Magnum/Shaders/VertexColor.cpp
Unescape View File

@ -73,7 +73,7 @@ template<UnsignedInt dimensions> VertexColor<dimensions>::VertexColor() {
#endif
{
bindAttributeLocation(Position::Location, "position");
bindAttributeLocation(Color::Location, "color");
bindAttributeLocation(Color3::Location, "color"); /* Color4 is the same */
}
CORRADE_INTERNAL_ASSERT_OUTPUT(link());

31
src/Magnum/Shaders/VertexColor.h
Unescape View File

@ -50,10 +50,8 @@ attributes in your triangle mesh and call at least
@section Shaders-VertexColor-example Example usage
Common mesh setup. Note the explicit specification of components for the color
attribute --- the shader accepts four-component color attribute but, similarly
to all other attributes, it's possible to supply also three-component colors if
alpha is not important.
Common mesh setup. The shader accepts either three- or four-component color
attribute, use either @ref Color3 or @ref Color4 to specify which one you use.
@snippet MagnumShaders.cpp VertexColor-usage1
@ -74,13 +72,28 @@ template<UnsignedInt dimensions> class MAGNUM_SHADERS_EXPORT VertexColor: public
typedef typename Generic<dimensions>::Position Position;
/**
* @brief Vertex color
* @brief Three-component vertex color.
*
* @ref shaders-generic "Generic attribute", @ref Magnum::Color3. Use
* either this or the @ref Color4 attribute.
*/
typedef typename Generic<dimensions>::Color3 Color3;
/**
* @brief Four-component vertex color.
*
* @ref shaders-generic "Generic attribute", @ref Color4, however
* defaults to @ref Color3 if @ref MAGNUM_BUILD_DEPRECATED is defined.
* See the @ref Generic::Color for more information.
* @ref shaders-generic "Generic attribute", @ref Magnum::Color4. Use
* either this or the @ref Color3 attribute.
*/
typedef typename Generic<dimensions>::Color4 Color4;
#ifdef MAGNUM_BUILD_DEPRECATED
/**
* @brief Vertex color
* @deprecated Use @ref Color3 or @ref Color4 instead.
*/
typedef typename Generic<dimensions>::Color Color;
typedef CORRADE_DEPRECATED("use Color3 or Color4 instead") typename Generic<dimensions>::Color Color;
#endif
explicit VertexColor();

Write Preview
Loading…
Cancel
Save