# ifndef Magnum_Shaders_MeshVisualizerGL_h
# define Magnum_Shaders_MeshVisualizerGL_h
/*
This file is part of Magnum .
Copyright © 2010 , 2011 , 2012 , 2013 , 2014 , 2015 , 2016 , 2017 , 2018 , 2019 ,
2020 , 2021 , 2022 Vladimír Vondruš < mosra @ centrum . cz >
Copyright © 2022 Vladislav Oleshko < vladislav . oleshko @ gmail . com >
Permission is hereby granted , free of charge , to any person obtaining a
copy of this software and associated documentation files ( the " Software " ) ,
to deal in the Software without restriction , including without limitation
the rights to use , copy , modify , merge , publish , distribute , sublicense ,
and / or sell copies of the Software , and to permit persons to whom the
Software is furnished to do so , subject to the following conditions :
The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software .
THE SOFTWARE IS PROVIDED " AS IS " , WITHOUT WARRANTY OF ANY KIND , EXPRESS OR
IMPLIED , INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY ,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT . IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM , DAMAGES OR OTHER
LIABILITY , WHETHER IN AN ACTION OF CONTRACT , TORT OR OTHERWISE , ARISING
FROM , OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE .
*/
/** @file
* @ brief Class @ ref Magnum : : Shaders : : MeshVisualizerGL2D , @ ref Magnum : : Shaders : : MeshVisualizerGL3D
* @ m_since_latest
*/
# include <Corrade/Utility/Utility.h>
# include "Magnum/DimensionTraits.h"
# include "Magnum/GL/AbstractShaderProgram.h"
# include "Magnum/Shaders/GenericGL.h"
# include "Magnum/Shaders/glShaderWrapper.h"
# include "Magnum/Shaders/visibility.h"
namespace Magnum { namespace Shaders {
namespace Implementation {
class MAGNUM_SHADERS_EXPORT MeshVisualizerGLBase : public GL : : AbstractShaderProgram {
protected :
enum class FlagBase : UnsignedInt {
/* Unlike the public Wireframe flag, this one doesn't include
NoGeometryShader on ES2 as that would make the checks too
complex */
Wireframe = 1 < < 0 ,
NoGeometryShader = 1 < < 1 ,
InstancedTransformation = 1 < < 13 ,
# ifndef MAGNUM_TARGET_GLES2
ObjectId = 1 < < 12 ,
InstancedObjectId = ( 1 < < 2 ) | ObjectId ,
ObjectIdTexture = 1 < < 14 ,
TextureTransformation = 1 < < 15 ,
InstancedTextureOffset = ( 1 < < 16 ) | TextureTransformation ,
VertexId = 1 < < 3 ,
PrimitiveId = 1 < < 4 ,
PrimitiveIdFromVertexId = ( 1 < < 5 ) | PrimitiveId ,
/* bit 6, 7, 8, 9 used by 3D-specific TBN visualization */
UniformBuffers = 1 < < 10 ,
MultiDraw = UniformBuffers | ( 1 < < 11 ) ,
TextureArrays = 1 < < 17 ,
# endif
} ;
typedef Containers : : EnumSet < FlagBase > FlagsBase ;
CORRADE_ENUMSET_FRIEND_OPERATORS ( FlagsBase )
explicit MeshVisualizerGLBase ( NoInitT ) { }
explicit MeshVisualizerGLBase ( NoCreateT ) noexcept : GL : : AbstractShaderProgram { NoCreate } { }
static MAGNUM_SHADERS_LOCAL void assertExtensions ( const FlagsBase flags ) ;
static MAGNUM_SHADERS_LOCAL GL : : Version setupShaders ( GL : : Shader & vert , GL : : Shader & frag , const Utility : : Resource & rs , const FlagsBase flags
# ifndef MAGNUM_TARGET_GLES2
, UnsignedInt materialCount , UnsignedInt drawCount
# endif
) ;
# ifndef MAGNUM_TARGET_GLES2
MeshVisualizerGLBase & setTextureMatrix ( const Matrix3 & matrix ) ;
MeshVisualizerGLBase & setTextureLayer ( UnsignedInt layer ) ;
MeshVisualizerGLBase & setObjectId ( UnsignedInt id ) ;
# endif
MeshVisualizerGLBase & setColor ( const Color4 & color ) ;
MeshVisualizerGLBase & setWireframeColor ( const Color4 & color ) ;
MeshVisualizerGLBase & setWireframeWidth ( Float width ) ;
# ifndef MAGNUM_TARGET_GLES2
MeshVisualizerGLBase & setColorMapTransformation ( Float offset , Float scale ) ;
MeshVisualizerGLBase & bindColorMapTexture ( GL : : Texture2D & texture ) ;
MeshVisualizerGLBase & bindObjectIdTexture ( GL : : Texture2D & texture ) ;
MeshVisualizerGLBase & bindObjectIdTexture ( GL : : Texture2DArray & texture ) ;
# endif
# ifndef MAGNUM_TARGET_GLES2
MeshVisualizerGLBase & setDrawOffset ( UnsignedInt offset ) ;
MeshVisualizerGLBase & bindTextureTransformationBuffer ( GL : : Buffer & buffer ) ;
MeshVisualizerGLBase & bindTextureTransformationBuffer ( GL : : Buffer & buffer , GLintptr offset , GLsizeiptr size ) ;
MeshVisualizerGLBase & bindMaterialBuffer ( GL : : Buffer & buffer ) ;
MeshVisualizerGLBase & bindMaterialBuffer ( GL : : Buffer & buffer , GLintptr offset , GLsizeiptr size ) ;
# endif
FlagsBase _flags ;
# ifndef MAGNUM_TARGET_GLES2
UnsignedInt _materialCount { } , _drawCount { } ;
# endif
Int _viewportSizeUniform { 0 } ,
_colorUniform { 1 } ,
_wireframeColorUniform { 2 } ,
_wireframeWidthUniform { 3 } ,
_smoothnessUniform { 4 } ;
# ifndef MAGNUM_TARGET_GLES2
Int _colorMapOffsetScaleUniform { 5 } ,
_objectIdUniform { 6 } ,
_textureMatrixUniform { 7 } ,
_textureLayerUniform { 8 } ;
/* Used instead of all other uniforms except viewportSize when
Flag : : UniformBuffers is set , so it can alias them */
Int _drawOffsetUniform { 1 } ;
# endif
} ;
}
/**
@ brief 2 D mesh visualization OpenGL shader
@ m_since_latest
Visualizes wireframe , per - vertex / per - instance object ID or primitive ID of 2 D
meshes . You need to provide the @ ref Position attribute in your triangle mesh .
Use @ ref setTransformationProjectionMatrix ( ) , @ ref setColor ( ) and others to
configure the shader .
@ m_class { m - row }
@ parblock
@ m_div { m - col - m - 4 m - col - t - 6 m - push - m - 2 m - nopadt m - nopadx }
@ image html shaders - meshvisualizer2d . png width = 256 px
@ m_enddiv
@ m_div { m - col - m - 4 m - col - t - 6 m - push - m - 2 m - nopadt m - nopadx }
@ image html shaders - meshvisualizer2d - primitiveid . png width = 256 px
@ m_enddiv
@ endparblock
The shader expects that you enable wireframe visualization by passing an
appropriate @ ref Flag to the constructor - - - there ' s no default behavior with
nothing enabled . The shader is a 2 D variant of @ ref MeshVisualizerGL3D with
mostly identical workflow . See its documentation for more information ,
workflows that differ are shown below .
@ section Shaders - MeshVisualizerGL2D - instancing Instanced rendering
Enabling @ ref Flag : : InstancedTransformation will turn the shader into an
instanced one . It ' ll take per - instance transformation from the
@ ref TransformationMatrix attribute , applying it before the matrix set by
@ ref setTransformationProjectionMatrix ( ) . The snippet below shows adding a
buffer with per - instance transformation to a mesh :
@ snippet MagnumShaders - gl . cpp MeshVisualizerGL2D - usage - instancing
If @ ref Flag : : ObjectIdTexture is used and @ ref Flag : : InstancedTextureOffset is
enabled , the @ ref TextureOffset attribute ( or @ ref TextureOffsetLayer in case
@ ref Flag : : TextureArrays is enabled as well ) then can supply per - instance
texture offset ( or offset and layer ) .
@ requires_gl33 Extension @ gl_extension { ARB , instanced_arrays }
@ requires_gles30 Extension @ gl_extension { ANGLE , instanced_arrays } ,
@ gl_extension { EXT , instanced_arrays } or @ gl_extension { NV , instanced_arrays }
in OpenGL ES 2.0 .
@ requires_webgl20 Extension @ webgl_extension { ANGLE , instanced_arrays } in WebGL
1.0 .
*/
class MAGNUM_SHADERS_EXPORT MeshVisualizerGL2D : public Implementation : : MeshVisualizerGLBase {
public :
class Configuration ;
class CompileState ;
/**
* @ brief Vertex position
*
* @ ref shaders - generic " Generic attribute " ,
* @ ref Magnum : : Vector2 " Vector2 " .
*/
typedef typename GenericGL2D : : Position Position ;
# ifndef MAGNUM_TARGET_GLES2
/** @copydoc MeshVisualizerGL3D::TextureCoordinates */
typedef GenericGL2D : : TextureCoordinates TextureCoordinates ;
# endif
/**
* @ brief Vertex index
*
* See @ ref MeshVisualizerGL3D : : VertexIndex for more information .
*/
typedef GL : : Attribute < 4 , Float > VertexIndex ;
# ifndef MAGNUM_TARGET_GLES2
/**
* @ brief ( Instanced ) object ID
* @ m_since { 2020 , 06 }
*
* @ ref shaders - generic " Generic attribute " , @ ref Magnum : : UnsignedInt .
* Used only if @ ref Flag : : InstancedObjectId is set .
* @ requires_gl30 Extension @ gl_extension { EXT , gpu_shader4 }
* @ requires_gles30 Object ID output requires integer support in
* shaders , which is not available in OpenGL ES 2.0 .
* @ requires_webgl20 Object ID output requires integer support in
* shaders , which is not available in WebGL 1.0 .
*/
typedef GenericGL2D : : ObjectId ObjectId ;
# endif
/**
* @ brief ( Instanced ) transformation matrix
* @ m_since_latest
*
* @ ref shaders - generic " Generic attribute " , @ ref Magnum : : Matrix3 .
* Used only if @ ref Flag : : InstancedTransformation is set .
* @ requires_gl33 Extension @ gl_extension { ARB , instanced_arrays }
* @ requires_gles30 Extension @ gl_extension { ANGLE , instanced_arrays } ,
* @ gl_extension { EXT , instanced_arrays } or
* @ gl_extension { NV , instanced_arrays } in OpenGL ES 2.0 .
* @ requires_webgl20 Extension @ webgl_extension { ANGLE , instanced_arrays }
* in WebGL 1.0 .
*/
typedef GenericGL2D : : TransformationMatrix TransformationMatrix ;
# ifndef MAGNUM_TARGET_GLES2
/** @copydoc MeshVisualizerGL3D::TextureOffset */
typedef typename GenericGL2D : : TextureOffset TextureOffset ;
/** @copydoc MeshVisualizerGL3D::TextureOffsetLayer */
typedef typename GenericGL2D : : TextureOffsetLayer TextureOffsetLayer ;
# endif
enum : UnsignedInt {
/**
* Color shader output . @ ref shaders - generic " Generic output " ,
* present always . Expects three - or four - component floating - point
* or normalized buffer attachment .
*/
ColorOutput = GenericGL2D : : ColorOutput
} ;
/**
* @ brief Flag
*
* @ see @ ref Flags , @ ref MeshVisualizerGL2D ( )
*/
enum class Flag : UnsignedInt {
/**
* Visualize wireframe . On OpenGL ES 2.0 and WebGL this also
* enables @ ref Flag : : NoGeometryShader .
*/
# if !defined(MAGNUM_TARGET_GLES2) && !defined(MAGNUM_TARGET_WEBGL)
Wireframe = 1 < < 0 ,
# else
Wireframe = ( 1 < < 0 ) | ( 1 < < 1 ) ,
# endif
/**
* Don ' t use a geometry shader for wireframe visualization . If
* enabled , you might need to provide also the @ ref VertexIndex
* attribute in the mesh . On OpenGL ES 2.0 and WebGL enabled
* alongside @ ref Flag : : Wireframe .
*/
NoGeometryShader = 1 < < 1 ,
# ifndef MAGNUM_TARGET_GLES2
/**
* Visualize object ID set via @ ref setObjectId ( ) or
* @ ref MeshVisualizerDrawUniform2D : : objectId . Since the ID is
* uniform for the whole draw , this feature is mainly useful in
* multidraw scenarios or when combined with
* @ ref Flag : : InstancedObjectId . Mutually exclusive with
* @ ref Flag : : VertexId and @ ref Flag : : PrimitiveId .
* @ requires_gl30 Extension @ gl_extension { EXT , gpu_shader4 }
* @ requires_gles30 Object ID input requires integer support in
* shaders , which is not available in OpenGL ES 2.0 .
* @ requires_webgl20 Object ID input requires integer support in
* shaders , which is not available in WebGL 1.0 .
* @ m_since_latest
*/
ObjectId = 1 < < 12 ,
/**
* Visualize instanced object ID . You need to provide the
* @ ref ObjectId attribute in the mesh , which then gets summed with
* the ID coming from @ ref setObjectId ( ) or
* @ ref MeshVisualizerDrawUniform2D : : objectId . Implicitly enables
* @ ref Flag : : ObjectId . Mutually exclusive with @ ref Flag : : VertexId
* and @ ref Flag : : PrimitiveId .
* @ requires_gl30 Extension @ gl_extension { EXT , gpu_shader4 }
* @ requires_gles30 Object ID input requires integer support in
* shaders , which is not available in OpenGL ES 2.0 .
* @ requires_webgl20 Object ID input requires integer support in
* shaders , which is not available in WebGL 1.0 .
* @ m_since { 2020 , 06 }
*/
InstancedObjectId = ( 1 < < 2 ) | ObjectId ,
/**
* Object ID texture . Retrieves object IDs from a texture bound
* with @ ref bindObjectIdTexture ( ) , outputting a sum of the object
* ID texture , the ID coming from @ ref setObjectId ( ) or
* @ ref MeshVisualizerDrawUniform2D : : objectId and possibly also the
* per - vertex ID , if @ ref Flag : : InstancedObjectId is enabled as
* well . Implicitly enables @ ref Flag : : ObjectId .
* @ requires_gl30 Extension @ gl_extension { EXT , gpu_shader4 }
* @ requires_gles30 Object ID input requires integer support in
* shaders , which is not available in OpenGL ES 2.0 .
* @ requires_webgl20 Object ID input requires integer support in
* shaders , which is not available in WebGL 1.0 .
* @ m_since_latest
*/
ObjectIdTexture = ( 1 < < 14 ) | ObjectId ,
/** @copydoc MeshVisualizerGL3D::Flag::VertexId */
VertexId = 1 < < 3 ,
# ifndef MAGNUM_TARGET_WEBGL
/** @copydoc MeshVisualizerGL3D::Flag::PrimitiveId */
PrimitiveId = 1 < < 4 ,
# endif
/** @copydoc MeshVisualizerGL3D::Flag::PrimitiveIdFromVertexId */
# ifndef MAGNUM_TARGET_WEBGL
PrimitiveIdFromVertexId = ( 1 < < 5 ) | PrimitiveId ,
# else
PrimitiveIdFromVertexId = ( 1 < < 5 ) | ( 1 < < 4 ) ,
# endif
# endif
/**
* Instanced transformation . Retrieves a per - instance
* transformation matrix from the @ ref TransformationMatrix
* attribute and uses it together with the matrix coming from
* @ ref setTransformationProjectionMatrix ( ) or
* @ ref TransformationProjectionUniform2D : : transformationProjectionMatrix
* ( first the per - instance , then the uniform matrix ) . See
* @ ref Shaders - MeshVisualizerGL2D - instancing for more information .
* @ requires_gl33 Extension @ gl_extension { ARB , instanced_arrays }
* @ requires_gles30 Extension @ gl_extension { ANGLE , instanced_arrays } ,
* @ gl_extension { EXT , instanced_arrays } or
* @ gl_extension { NV , instanced_arrays } in OpenGL ES 2.0 .
* @ requires_webgl20 Extension @ webgl_extension { ANGLE , instanced_arrays }
* in WebGL 1.0 .
* @ m_since_latest
*/
InstancedTransformation = 1 < < 13 ,
# ifndef MAGNUM_TARGET_GLES2
/** @copydoc MeshVisualizerGL3D::Flag::TextureTransformation */
TextureTransformation = 1 < < 15 ,
/**
* Instanced texture offset for an object ID texture . Retrieves a
* per - instance offset vector from the @ ref TextureOffset attribute
* and uses it together with the matrix coming from
* @ ref setTextureMatrix ( ) or
* @ ref TextureTransformationUniform : : rotationScaling and
* @ ref TextureTransformationUniform : : offset ( first the
* per - instance vector , then the uniform matrix ) . Instanced texture
* scaling and rotation is not supported at the moment , you can
* specify that only via the uniform @ ref setTextureMatrix ( ) .
* Implicitly enables @ ref Flag : : TextureTransformation . See
* @ ref Shaders - MeshVisualizerGL3D - instancing for more information .
*
* If @ ref Flag : : TextureArrays is set as well , a three - component
* @ ref TextureOffsetLayer attribute can be used instead of
* @ ref TextureOffset to specify per - instance texture layer , which
* gets added to the uniform layer numbers set by
* @ ref setTextureLayer ( ) or
* @ ref TextureTransformationUniform : : layer .
* @ requires_gl33 Extension @ gl_extension { EXT , gpu_shader4 } and
* @ gl_extension { ARB , instanced_arrays }
* @ requires_gles30 Object ID input requires integer support in
* shaders , which is not available in OpenGL ES 2.0 .
* @ requires_webgl20 Object ID input requires integer support in
* shaders , which is not available in WebGL 1.0 .
* @ m_since_latest
* @ todoc rewrite the ext requirements once we have more textures
*/
InstancedTextureOffset = ( 1 < < 16 ) | TextureTransformation ,
# endif
# ifndef MAGNUM_TARGET_GLES2
/**
* Use uniform buffers . Expects that uniform data are supplied via
* @ ref bindTransformationProjectionBuffer ( ) , @ ref bindDrawBuffer ( )
* and @ ref bindMaterialBuffer ( ) instead of direct uniform setters .
* @ requires_gl31 Extension @ gl_extension { ARB , uniform_buffer_object }
* @ requires_gles30 Uniform buffers are not available in OpenGL ES
* 2.0 .
* @ requires_webgl20 Uniform buffers are not available in WebGL
* 1.0 .
* @ m_since_latest
*/
UniformBuffers = 1 < < 10 ,
/**
* Enable multidraw functionality . Implies @ ref Flag : : UniformBuffers
* and combines the value from @ ref setDrawOffset ( ) with the
* @ glsl gl_DrawID @ ce builtin , which makes draws submitted via
* @ ref GL : : AbstractShaderProgram : : draw ( const Containers : : Iterable < MeshView > & )
* pick up per - draw parameters directly , without having to rebind
* the uniform buffers or specify @ ref setDrawOffset ( ) before each
* draw . In a non - multidraw scenario , @ glsl gl_DrawID @ ce is
* @ cpp 0 @ ce , which means a shader with this flag enabled can be
* used for regular draws as well .
* @ requires_gl46 Extension @ gl_extension { ARB , uniform_buffer_object }
* and @ gl_extension { ARB , shader_draw_parameters }
* @ requires_es_extension OpenGL ES 3.0 and extension
* @ m_class { m - doc - external } [ ANGLE_multi_draw ] ( https : //chromium.googlesource.com/angle/angle/+/master/extensions/ANGLE_multi_draw.txt)
* ( unlisted ) . While the extension alone needs only OpenGL ES
* 2.0 , the shader implementation relies on uniform buffers ,
* which require OpenGL ES 3.0 .
* @ requires_webgl_extension WebGL 2.0 and extension
* @ webgl_extension { ANGLE , multi_draw } . While the extension
* alone needs only WebGL 1.0 , the shader implementation
* relies on uniform buffers , which require WebGL 2.0 .
* @ m_since_latest
*/
MultiDraw = UniformBuffers | ( 1 < < 11 ) ,
/** @copydoc MeshVisualizerGL3D::Flag::TextureArrays */
TextureArrays = 1 < < 17 ,
# endif
} ;
/** @brief Flags */
typedef Containers : : EnumSet < Flag > Flags ;
/**
* @ brief Compile asynchronously
* @ m_since_latest
*
* Compared to @ ref MeshVisualizerGL2D ( const Configuration & ) can
* perform an asynchronous compilation and linking . See
* @ ref shaders - async for more information .
* @ see @ ref MeshVisualizerGL2D ( CompileState & & )
*/
/* No default value, consistently with MeshVisualizerGL2D(Configuration) */
static CompileState compile ( const Configuration & configuration ) ;
# ifdef MAGNUM_BUILD_DEPRECATED
/**
* @ brief Compile asynchronously
* @ m_deprecated_since_latest Use @ ref compile ( const Configuration & )
* instead .
*/
CORRADE_DEPRECATED ( " use compile(const Configuration& instead " ) static CompileState compile ( Flags flags ) ;
# ifndef MAGNUM_TARGET_GLES2
/**
* @ brief Compile for a multi - draw scenario asynchronously
* @ m_deprecated_since_latest Use @ ref compile ( const Configuration & )
* instead .
* @ requires_gl31 Extension @ gl_extension { ARB , uniform_buffer_object }
* @ requires_gles30 Uniform buffers are not available in OpenGL ES 2.0 .
* @ requires_webgl20 Uniform buffers are not available in WebGL 1.0 .
*/
CORRADE_DEPRECATED ( " use compile(const Configuration& instead " ) static CompileState compile ( Flags flags , UnsignedInt materialCount , UnsignedInt drawCount ) ;
# endif
# endif
/**
* @ brief Constructor
* @ m_since_latest
*/
/* No default value, as at least one Flag has to be set */
explicit MeshVisualizerGL2D ( const Configuration & configuration ) ;
# ifdef MAGNUM_BUILD_DEPRECATED
/**
* @ brief Constructor
* @ m_deprecated_since_latest Use @ ref MeshVisualizerGL2D ( const Configuration & )
* instead .
*/
explicit CORRADE_DEPRECATED ( " use MeshVisualizerGL2D(const Configuration& instead " ) MeshVisualizerGL2D ( Flags flags ) ;
# ifndef MAGNUM_TARGET_GLES2
/**
* @ brief Construct for a multi - draw scenario
* @ m_deprecated_since_latest Use @ ref MeshVisualizerGL2D ( const Configuration & )
* instead .
* @ requires_gl31 Extension @ gl_extension { ARB , uniform_buffer_object }
* @ requires_gles30 Uniform buffers are not available in OpenGL ES 2.0 .
* @ requires_webgl20 Uniform buffers are not available in WebGL 1.0 .
*/
explicit CORRADE_DEPRECATED ( " use MeshVisualizerGL2D(const Configuration& instead " ) MeshVisualizerGL2D ( Flags flags , UnsignedInt materialCount , UnsignedInt drawCount ) ;
# endif
# endif
/**
* @ brief Finalize an asynchronous compilation
* @ m_since_latest
*
* Takes an asynchronous compilation state returned by @ ref compile ( )
* and forms a ready - to - use shader object . See @ ref shaders - async for
* more information .
*/
explicit MeshVisualizerGL2D ( CompileState & & state ) ;
/**
* @ brief Construct without creating the underlying OpenGL object
*
* The constructed instance is equivalent to a 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 .
* However note that this is a low - level and a potentially dangerous
* API , see the documentation of @ ref NoCreate for alternatives .
*/
explicit MeshVisualizerGL2D ( NoCreateT ) noexcept : Implementation : : MeshVisualizerGLBase { NoCreate } { }
/** @brief Copying is not allowed */
MeshVisualizerGL2D ( const MeshVisualizerGL2D & ) = delete ;
/** @brief Move constructor */
MeshVisualizerGL2D ( MeshVisualizerGL2D & & ) noexcept = default ;
/** @brief Copying is not allowed */
MeshVisualizerGL2D & operator = ( const MeshVisualizerGL2D & ) = delete ;
/** @brief Move assignment */
MeshVisualizerGL2D & operator = ( MeshVisualizerGL2D & & ) noexcept = default ;
/** @brief Flags */
Flags flags ( ) const {
return Flag ( UnsignedInt ( Implementation : : MeshVisualizerGLBase : : _flags ) ) ;
}
# ifndef MAGNUM_TARGET_GLES2
/**
* @ brief Material count
* @ m_since_latest
*
* Statically defined size of the @ ref MeshVisualizerMaterialUniform
* uniform buffer . Has use only if @ ref Flag : : UniformBuffers is set .
* @ see @ ref bindMaterialBuffer ( )
* @ requires_gles30 Not defined on OpenGL ES 2.0 builds .
* @ requires_webgl20 Not defined on WebGL 1.0 builds .
*/
UnsignedInt materialCount ( ) const { return _materialCount ; }
/**
* @ brief Draw count
* @ m_since_latest
*
* Statically defined size of each of the
* @ ref TransformationProjectionUniform2D and
* @ ref MeshVisualizerDrawUniform2D uniform buffers . Has use only if
* @ ref Flag : : UniformBuffers is set .
* @ requires_gles30 Not defined on OpenGL ES 2.0 builds .
* @ requires_webgl20 Not defined on WebGL 1.0 builds .
*/
UnsignedInt drawCount ( ) const { return _drawCount ; }
# endif
/** @{
* @ name Uniform setters
*
* Used only if @ ref Flag : : UniformBuffers is not set .
*/
/**
* @ brief Set transformation and projection matrix
* @ return Reference to self ( for method chaining )
*
* Initial value is an identity matrix . If
* @ ref Flag : : InstancedTransformation is set , the per - instance
* transformation matrix coming from the @ ref TransformationMatrix
* attribute is applied first , before this one .
*
* Expects that @ ref Flag : : UniformBuffers is not set , in that case fill
* @ ref TransformationProjectionUniform2D : : transformationProjectionMatrix
* and call @ ref bindTransformationProjectionBuffer ( ) instead .
*/
MeshVisualizerGL2D & setTransformationProjectionMatrix ( const Matrix3 & matrix ) ;
# ifndef MAGNUM_TARGET_GLES2
/** @copydoc MeshVisualizerGL3D::setTextureMatrix() */
MeshVisualizerGL2D & setTextureMatrix ( const Matrix3 & matrix ) {
return static_cast < MeshVisualizerGL2D & > ( Implementation : : MeshVisualizerGLBase : : setTextureMatrix ( matrix ) ) ;
}
/** @copydoc MeshVisualizerGL3D::setTextureLayer() */
MeshVisualizerGL2D & setTextureLayer ( UnsignedInt layer ) {
return static_cast < MeshVisualizerGL2D & > ( Implementation : : MeshVisualizerGLBase : : setTextureLayer ( layer ) ) ;
}
# endif
/**
* @ brief Set viewport size
* @ return Reference to self ( for method chaining )
*
* Has effect only if @ ref Flag : : Wireframe is enabled and geometry
* shaders are used , otherwise it does nothing . Initial value is a zero
* vector .
*/
MeshVisualizerGL2D & setViewportSize ( const Vector2 & size ) ;
# ifndef MAGNUM_TARGET_GLES2
/**
* @ brief Set object ID
* @ return Reference to self ( for method chaining )
* @ m_since_latest
*
* Expects that @ ref Flag : : ObjectId is enabled . Default is
* @ cpp 0 @ ce . If @ ref Flag : : InstancedObjectId is enabled as well , this
* value is added to the ID coming from the @ ref ObjectId attribute .
*
* Expects that @ ref Flag : : UniformBuffers is not set , in that case fill
* @ ref MeshVisualizerDrawUniform2D : : objectId and call
* @ ref bindDrawBuffer ( ) instead .
* @ requires_gl30 Extension @ gl_extension { EXT , gpu_shader4 }
* @ requires_gles30 Object ID input requires integer support in
* shaders , which is not available in OpenGL ES 2.0 .
* @ requires_webgl20 Object ID input requires integer support in
* shaders , which is not available in WebGL 1.0 .
*/
MeshVisualizerGL2D & setObjectId ( UnsignedInt id ) {
return static_cast < MeshVisualizerGL2D & > ( Implementation : : MeshVisualizerGLBase : : setObjectId ( id ) ) ;
}
# endif
/**
* @ brief Set base object color
* @ return Reference to self ( for method chaining )
*
* Initial value is @ cpp 0xffffffff _rgbaf @ ce . Expects that either
* @ ref Flag : : Wireframe or @ ref Flag : : InstancedObjectId /
* @ ref Flag : : PrimitiveId / @ ref Flag : : PrimitiveIdFromVertexId is
* enabled . In case of the latter , the color is multiplied with the
* color map coming from @ ref bindColorMapTexture ( ) .
*
* Expects that @ ref Flag : : UniformBuffers is not set , in that case fill
* @ ref MeshVisualizerMaterialUniform : : color and call
* @ ref bindMaterialBuffer ( ) instead .
*/
MeshVisualizerGL2D & setColor ( const Color4 & color ) {
return static_cast < MeshVisualizerGL2D & > ( Implementation : : MeshVisualizerGLBase : : setColor ( color ) ) ;
}
/**
* @ brief Set wireframe color
* @ return Reference to self ( for method chaining )
*
* Initial value is @ cpp 0x000000ff _rgbaf @ ce . Expects that
* @ ref Flag : : Wireframe is enabled .
*
* Expects that @ ref Flag : : UniformBuffers is not set , in that case fill
* @ ref MeshVisualizerMaterialUniform : : wireframeColor and call
* @ ref bindMaterialBuffer ( ) instead .
*/
MeshVisualizerGL2D & setWireframeColor ( const Color4 & color ) {
return static_cast < MeshVisualizerGL2D & > ( Implementation : : MeshVisualizerGLBase : : setWireframeColor ( color ) ) ;
}
/**
* @ brief Set wireframe width
* @ return Reference to self ( for method chaining )
*
* The value is in screen space ( depending on @ ref setViewportSize ( ) ) ,
* initial value is @ cpp 1.0f @ ce . Expects that @ ref Flag : : Wireframe is
* enabled .
*
* Expects that @ ref Flag : : UniformBuffers is not set , in that case fill
* @ ref MeshVisualizerMaterialUniform : : wireframeWidth and call
* @ ref bindMaterialBuffer ( ) instead .
*/
MeshVisualizerGL2D & setWireframeWidth ( Float width ) {
return static_cast < MeshVisualizerGL2D & > ( Implementation : : MeshVisualizerGLBase : : setWireframeWidth ( width ) ) ;
}
# ifndef MAGNUM_TARGET_GLES2
/** @copydoc MeshVisualizerGL3D::setColorMapTransformation() */
MeshVisualizerGL2D & setColorMapTransformation ( Float offset , Float scale ) {
return static_cast < MeshVisualizerGL2D & > ( Implementation : : MeshVisualizerGLBase : : setColorMapTransformation ( offset , scale ) ) ;
}
# endif
/**
* @ brief Set line smoothness
* @ return Reference to self ( for method chaining )
*
* Value is in screen space ( depending on @ ref setViewportSize ( ) ) ,
* initial value is @ cpp 2.0f @ ce . Expects that @ ref Flag : : Wireframe is
* enabled .
*
* Expects that @ ref Flag : : UniformBuffers is not set , in that case fill
* @ ref MeshVisualizerMaterialUniform : : smoothness and call
* @ ref bindMaterialBuffer ( ) instead .
*/
MeshVisualizerGL2D & setSmoothness ( Float smoothness ) ;
/**
* @ }
*/
# ifndef MAGNUM_TARGET_GLES2
/** @{
* @ name Uniform buffer binding and related uniform setters
*
* Used if @ ref Flag : : UniformBuffers is set .
*/
/**
* @ brief Set a draw offset
* @ return Reference to self ( for method chaining )
* @ m_since_latest
*
* Specifies which item in the @ ref TransformationProjectionUniform2D
* and @ ref MeshVisualizerDrawUniform2D buffers bound with
* @ ref bindTransformationProjectionBuffer ( ) and @ ref bindDrawBuffer ( )
* should be used for current draw . Expects that
* @ ref Flag : : UniformBuffers is set and @ p offset is less than
* @ ref drawCount ( ) . Initial value is @ cpp 0 @ ce , if @ ref drawCount ( )
* is @ cpp 1 @ ce , the function is a no - op as the shader assumes draw
* offset to be always zero .
*
* If @ ref Flag : : MultiDraw is set , @ glsl gl_DrawID @ ce is added to this
* value , which makes each draw submitted via
* @ ref GL : : AbstractShaderProgram : : draw ( const Containers : : Iterable < MeshView > & )
* pick up its own per - draw parameters .
* @ requires_gl31 Extension @ gl_extension { ARB , uniform_buffer_object }
* @ requires_gles30 Uniform buffers are not available in OpenGL ES 2.0 .
* @ requires_webgl20 Uniform buffers are not available in WebGL 1.0 .
*/
MeshVisualizerGL2D & setDrawOffset ( UnsignedInt offset ) {
return static_cast < MeshVisualizerGL2D & > ( Implementation : : MeshVisualizerGLBase : : setDrawOffset ( offset ) ) ;
}
/**
* @ brief Set a transformation and projection uniform buffer
* @ return Reference to self ( for method chaining )
* @ m_since_latest
*
* Expects that @ ref Flag : : UniformBuffers is set . The buffer is
* expected to contain @ ref drawCount ( ) instances of
* @ ref TransformationUniform3D . At the very least you need to call
* also @ ref bindDrawBuffer ( ) and @ ref bindMaterialBuffer ( ) .
* @ requires_gl31 Extension @ gl_extension { ARB , uniform_buffer_object }
* @ requires_gles30 Uniform buffers are not available in OpenGL ES 2.0 .
* @ requires_webgl20 Uniform buffers are not available in WebGL 1.0 .
*/
MeshVisualizerGL2D & bindTransformationProjectionBuffer ( GL : : Buffer & buffer ) ;
/**
* @ overload
* @ m_since_latest
*/
MeshVisualizerGL2D & bindTransformationProjectionBuffer ( GL : : Buffer & buffer , GLintptr offset , GLsizeiptr size ) ;
/**
* @ brief Set a draw uniform buffer
* @ return Reference to self ( for method chaining )
* @ m_since_latest
*
* Expects that @ ref Flag : : UniformBuffers is set . The buffer is
* expected to contain @ ref drawCount ( ) instances of
* @ ref MeshVisualizerDrawUniform2D . At the very least you need to call
* also @ ref bindTransformationProjectionBuffer ( ) and
* @ ref bindMaterialBuffer ( ) .
* @ requires_gl31 Extension @ gl_extension { ARB , uniform_buffer_object }
* @ requires_gles30 Uniform buffers are not available in OpenGL ES 2.0 .
* @ requires_webgl20 Uniform buffers are not available in WebGL 1.0 .
*/
MeshVisualizerGL2D & bindDrawBuffer ( GL : : Buffer & buffer ) ;
/**
* @ overload
* @ m_since_latest
*/
MeshVisualizerGL2D & bindDrawBuffer ( GL : : Buffer & buffer , GLintptr offset , GLsizeiptr size ) ;
/** @copydoc MeshVisualizerGL3D::bindTextureTransformationBuffer(GL::Buffer&) */
MeshVisualizerGL2D & bindTextureTransformationBuffer ( GL : : Buffer & buffer ) {
return static_cast < MeshVisualizerGL2D & > ( Implementation : : MeshVisualizerGLBase : : bindTextureTransformationBuffer ( buffer ) ) ;
}
/** @copydoc MeshVisualizerGL3D::bindTextureTransformationBuffer(GL::Buffer&, GLintptr, GLsizeiptr) */
MeshVisualizerGL2D & bindTextureTransformationBuffer ( GL : : Buffer & buffer , GLintptr offset , GLsizeiptr size ) {
return static_cast < MeshVisualizerGL2D & > ( Implementation : : MeshVisualizerGLBase : : bindTextureTransformationBuffer ( buffer , offset , size ) ) ;
}
/**
* @ brief Set a material uniform buffer
* @ return Reference to self ( for method chaining )
* @ m_since_latest
*
* Expects that @ ref Flag : : UniformBuffers is set . The buffer is
* expected to contain @ ref materialCount ( ) instances of
* @ ref MeshVisualizerMaterialUniform . At the very least you need to
* call also @ ref bindTransformationProjectionBuffer ( ) and
* @ ref bindDrawBuffer ( ) .
* @ requires_gl31 Extension @ gl_extension { ARB , uniform_buffer_object }
* @ requires_gles30 Uniform buffers are not available in OpenGL ES 2.0 .
* @ requires_webgl20 Uniform buffers are not available in WebGL 1.0 .
*/
MeshVisualizerGL2D & bindMaterialBuffer ( GL : : Buffer & buffer ) {
return static_cast < MeshVisualizerGL2D & > ( Implementation : : MeshVisualizerGLBase : : bindMaterialBuffer ( buffer ) ) ;
}
/**
* @ overload
* @ m_since_latest
*/
MeshVisualizerGL2D & bindMaterialBuffer ( GL : : Buffer & buffer , GLintptr offset , GLsizeiptr size ) {
return static_cast < MeshVisualizerGL2D & > ( Implementation : : MeshVisualizerGLBase : : bindMaterialBuffer ( buffer , offset , size ) ) ;
}
/**
* @ }
*/
# endif
/** @{
* @ name Texture binding
*/
# ifndef MAGNUM_TARGET_GLES2
/** @copydoc MeshVisualizerGL3D::bindColorMapTexture() */
MeshVisualizerGL2D & bindColorMapTexture ( GL : : Texture2D & texture ) {
return static_cast < MeshVisualizerGL2D & > ( Implementation : : MeshVisualizerGLBase : : bindColorMapTexture ( texture ) ) ;
}
/** @copydoc MeshVisualizerGL3D::bindObjectIdTexture(GL::Texture2D&) */
MeshVisualizerGL2D & bindObjectIdTexture ( GL : : Texture2D & texture ) {
return static_cast < MeshVisualizerGL2D & > ( Implementation : : MeshVisualizerGLBase : : bindObjectIdTexture ( texture ) ) ;
}
/** @copydoc MeshVisualizerGL3D::bindObjectIdTexture(GL::Texture2DArray&) */
MeshVisualizerGL2D & bindObjectIdTexture ( GL : : Texture2DArray & texture ) {
return static_cast < MeshVisualizerGL2D & > ( Implementation : : MeshVisualizerGLBase : : bindObjectIdTexture ( texture ) ) ;
}
# endif
/**
* @ }
*/
MAGNUM_GL_ABSTRACTSHADERPROGRAM_SUBCLASS_DRAW_IMPLEMENTATION ( MeshVisualizerGL2D )
private :
/* Creates the GL shader program object but does nothing else.
Internal , used by compile ( ) . */
explicit MeshVisualizerGL2D ( NoInitT ) : Implementation : : MeshVisualizerGLBase { NoInit } { }
Int _transformationProjectionMatrixUniform { 9 } ;
} ;
/**
@ brief Configuration
@ m_since_latest
@ see @ ref MeshVisualizerGL2D ( const Configuration & ) ,
@ ref compile ( const Configuration & )
*/
class MeshVisualizerGL2D : : Configuration {
public :
explicit Configuration ( ) = default ;
/** @brief Flags */
Flags flags ( ) const { return _flags ; }
/**
* @ brief Set flags
*
* At least one of @ ref Flag : : Wireframe , @ ref Flag : : ObjectId ,
* @ ref Flag : : VertexId , @ ref Flag : : PrimitiveId or
* @ ref Flag : : PrimitiveIdFromVertexId is expected to be enabled . No
* flags are set by default .
*/
Configuration & setFlags ( Flags flags ) {
_flags = flags ;
return * this ;
}
# ifndef MAGNUM_TARGET_GLES2
/** @brief Material count */
UnsignedInt materialCount ( ) const { return _materialCount ; }
/**
* @ brief Set material count
*
* If @ ref Flag : : UniformBuffers is set , describes size of a
* @ ref MeshVisualizerMaterialUniform buffer bound with
* @ ref bindMaterialBuffer ( ) ; as uniform buffers are required to have a
* statically defined size . The per - draw materials are then specified
* via @ ref MeshVisualizerDrawUniform2D : : materialId . Default value is
* @ cpp 1 @ ce .
*
* If @ ref Flag : : UniformBuffers isn ' t set , this value is ignored .
* @ see @ ref setFlags ( ) , @ ref setDrawCount ( )
* @ requires_gl31 Extension @ gl_extension { ARB , uniform_buffer_object }
* @ requires_gles30 Uniform buffers are not available in OpenGL ES 2.0 .
* @ requires_webgl20 Uniform buffers are not available in WebGL 1.0 .
*/
Configuration & setMaterialCount ( UnsignedInt materialCount ) {
_materialCount = materialCount ;
return * this ;
}
/** @brief Draw count */
UnsignedInt drawCount ( ) const { return _drawCount ; }
/**
* @ brief Set draw count
*
* If @ ref Flag : : UniformBuffers is set , describes size of a
* @ ref TransformationProjectionUniform2D /
* @ ref MeshVisualizerDrawUniform2D / @ ref TextureTransformationUniform
* buffer bound with @ ref bindTransformationProjectionBuffer ( ) ,
* @ ref bindDrawBuffer ( ) and @ ref bindTextureTransformationBuffer ( ) ; as
* uniform buffers are required to have a statically defined size . The
* draw offset is then set via @ ref setDrawOffset ( ) . Default value is
* @ cpp 1 @ ce .
*
* If @ ref Flag : : UniformBuffers isn ' t set , this value is ignored .
* @ see @ ref setFlags ( ) , @ ref setMaterialCount ( )
* @ requires_gl31 Extension @ gl_extension { ARB , uniform_buffer_object }
* @ requires_gles30 Uniform buffers are not available in OpenGL ES 2.0 .
* @ requires_webgl20 Uniform buffers are not available in WebGL 1.0 .
*/
Configuration & setDrawCount ( UnsignedInt drawCount ) {
_drawCount = drawCount ;
return * this ;
}
# endif
private :
Flags _flags ;
# ifndef MAGNUM_TARGET_GLES2
UnsignedInt _materialCount = 1 ;
UnsignedInt _drawCount = 1 ;
# endif
} ;
/**
@ brief Asynchronous compilation state
@ m_since_latest
Returned by @ ref compile ( ) . See @ ref shaders - async for more information .
*/
class MeshVisualizerGL2D : : CompileState : public MeshVisualizerGL2D {
/* Everything deliberately private except for the inheritance */
friend class MeshVisualizerGL2D ;
explicit CompileState ( NoCreateT ) : MeshVisualizerGL2D { NoCreate } , _vert { NoCreate } , _frag { NoCreate } , _geom { NoCreate } { }
explicit CompileState ( MeshVisualizerGL2D & & shader , GL : : Shader & & vert , GL : : Shader & & frag , GL : : Shader * geom , GL : : Version version ) : MeshVisualizerGL2D { std : : move ( shader ) } , _vert { std : : move ( vert ) } , _frag { std : : move ( frag ) } , _geom { NoCreate } , _version { version } {
if ( geom ) _geom = Implementation : : GLShaderWrapper { std : : move ( * geom ) } ;
}
Implementation : : GLShaderWrapper _vert , _frag , _geom ;
GL : : Version _version ;
} ;
/**
@ brief 3 D mesh visualization OpenGL shader
@ m_since_latest
Visualizes wireframe , per - vertex / per - instance object ID , primitive ID or
tangent space of 3 D meshes . You need to provide the @ ref Position attribute in
your triangle mesh at the very least . Use @ ref setTransformationProjectionMatrix ( ) ,
@ ref setColor ( ) and others to configure the shader .
@ m_class { m - row }
@ parblock
@ m_div { m - col - m - 4 m - col - t - 6 m - push - m - 2 m - text - center m - nopadt m - nopadx }
@ image html shaders - meshvisualizer3d . png width = 256 px
@ ref Shaders - MeshVisualizerGL3D - wireframe , \ n
@ ref Shaders - MeshVisualizerGL3D - tbn
@ m_enddiv
@ m_div { m - col - m - 4 m - col - t - 6 m - push - m - 2 m - text - center m - nopadt m - nopadx }
@ image html shaders - meshvisualizer3d - primitiveid . png width = 256 px
@ ref Shaders - MeshVisualizerGL3D - object - id
@ m_enddiv
@ endparblock
The shader expects that you enable wireframe visualization , tangent space
visualization or object / primitive ID visualization by passing an appropriate
@ ref Flag to the constructor - - - there ' s no default behavior with nothing
enabled .
@ section Shaders - MeshVisualizerGL3D - wireframe Wireframe visualization
Wireframe visualization is done by enabling @ ref Flag : : Wireframe . It is done
either using geometry shaders or with help of additional vertex information . If
you have geometry shaders available , you don ' t need to do anything else except
calling @ ref setViewportSize ( ) to correctly size the wireframe - - - without
this , the mesh will be rendered in a single color .
@ requires_gl32 Extension @ gl_extension { ARB , geometry_shader4 } for wireframe
rendering using geometry shaders .
@ requires_es_extension Extension @ gl_extension { EXT , geometry_shader } for
wireframe rendering using geometry shaders .
If you don ' t have geometry shaders , you need to enable @ ref Flag : : NoGeometryShader
( done by default in OpenGL ES 2.0 ) and use only * * non - indexed * * triangle meshes
( see @ ref MeshTools : : duplicate ( ) for a possible solution ) . Additionally , if you
have OpenGL < 3.1 or OpenGL ES 2.0 , you need to provide also the
@ ref VertexIndex attribute .
@ requires_gles30 Extension @ gl_extension { OES , standard_derivatives } for
wireframe rendering without geometry shaders .
If using geometry shaders on OpenGL ES , @ gl_extension { NV , shader_noperspective_interpolation }
is optionally used for improving line appearance . On desktop OpenGL this is
done implicitly .
If you want to render just the wireframe on top of an existing mesh , call
@ ref setColor ( ) with @ cpp 0x00000000 _rgbaf @ ce . Alpha / transparency is
supported by the shader implicitly , but to have it working on the framebuffer ,
you need to enable @ ref GL : : Renderer : : Feature : : Blending and set up the blending
function . See @ ref GL : : Renderer : : setBlendFunction ( ) for details .
@ subsection Shaders - MeshVisualizerGL3D - wireframe - geom Example setup with a geometry shader ( desktop GL , OpenGL ES 3.2 )
Common mesh setup :
@ snippet MagnumShaders - gl . cpp MeshVisualizerGL3D - usage - geom1
Common rendering setup :
@ snippet MagnumShaders - gl . cpp MeshVisualizerGL3D - usage - geom2
@ subsection Shaders - MeshVisualizerGL3D - wireframe - no - geom Example setup for indexed meshes without a geometry shader
The vertices have to be converted to a non - indexed array first . Mesh setup :
@ snippet MagnumShaders - gl . cpp MeshVisualizerGL3D - usage - no - geom1
Rendering setup :
@ snippet MagnumShaders - gl . cpp MeshVisualizerGL3D - usage - no - geom2
@ subsection Shaders - MeshVisualizerGL3D - usage - wireframe - no - geom - old Wireframe visualization of non - indexed meshes without a geometry shader on older hardware
You need to provide also the @ ref VertexIndex attribute . Mesh setup * in
addition to the above * :
@ snippet MagnumShaders - gl . cpp MeshVisualizerGL3D - usage - no - geom - old
Rendering setup the same as above .
@ section Shaders - MeshVisualizerGL3D - tbn Tangent space visualization
On platforms with geometry shaders ( desktop GL , OpenGL ES 3.2 ) , the shader is
able to visualize tangent , bitangent and normal direction via colored lines
coming out of vertices ( red , green and blue for tangent , bitangent and normal , respectively ) . This can be enabled together with wireframe , object ID ,
vertex ID or primitive ID visualization , however note that when both are
enabled , the lines are not antialiased to avoid depth ordering artifacts
between faces and lines .
For tangents and normals , you need to provide the @ ref Tangent and @ ref Normal
attributes and enable @ ref Flag : : TangentDirection and
@ ref Flag : : NormalDirection , respectively . If any of the attributes isn ' t
present , its data are implicitly zero and thus the direction isn ' t shown - - -
which means you don ' t need to worry about having two active variants of the
shader and switching between either depending on whether tangents are present
or not .
For bitangents however , there are two possible representations - - - the more
efficient one is via a fourth component in the tangent attribute that
indicates tangent space handedness , in which case you ' ll be using the
@ ref Tangent4 attribute instead of @ ref Tangent , and enable
@ ref Flag : : BitangentFromTangentDirection . The other , more obvious but less
efficient representation , is a dedicated @ ref Bitangent attribute ( in which
case you ' ll enable @ ref Flag : : BitangentDirection ) . Note that these two are
mutually exclusive , so you need to choose either of them based on what given
mesh contains . Example for the first case :
@ snippet MagnumShaders - gl . cpp MeshVisualizerGL3D - usage - tbn1
Rendering setup :
@ snippet MagnumShaders - gl . cpp MeshVisualizerGL3D - usage - tbn2
@ section Shaders - MeshVisualizerGL3D - object - id Object , vertex and primitive ID visualization
If the mesh contains a per - vertex ( or instanced ) @ ref ObjectId , it can be
visualized by enabling @ ref Flag : : InstancedObjectId . For the actual
visualization you need to provide a color map using @ ref bindColorMapTexture ( )
and use @ ref setColorMapTransformation ( ) to map given range of discrete IDs to
the @ f $ [ 0 , 1 ] @ f $ texture range . Various colormap presets are in the
@ ref DebugTools : : ColorMap namespace . Example usage :
@ snippet MagnumShaders - gl . cpp MeshVisualizerGL3D - usage - object - id
Consistently with the other shaders , textured object ID is also supported if
@ ref Flag : : ObjectIdTexture is enabled . In that case you need to provide also
the @ ref TextureCoordinates attribute and bind an integer texture via
@ ref bindObjectIdTexture ( ) . @ ref Flag : : TextureTransformation then enables
texture transformation and @ ref Flag : : TextureArrays texture arrays for the
object ID texture .
If you enable @ ref Flag : : VertexId , the shader will use the color map to
visualize how are vertices shared among primitives . That ' s useful for
inspecting mesh connectivity - - - primitives sharing vertices will have a smooth
color map transition while duplicated vertices will cause a sharp edge . This
relies on the @ glsl gl_VertexID @ ce GLSL builtin .
The @ ref Flag : : PrimitiveId then visualizes the order in which primitives are
drawn . That ' s useful for example to see to see how well is the mesh optimized
for a post - transform vertex cache . This by default relies on the @ glsl gl_PrimitiveID @ ce GLSL builtin ; with @ ref Flag : : PrimitiveIdFromVertexId it ' s
emulated using @ glsl gl_VertexID @ ce , expecting you to draw a non - indexed
triangle mesh . You can use @ ref MeshTools : : duplicate ( ) ( and potentially
@ ref MeshTools : : generateIndices ( ) ) to conveniently convert the mesh to a
non - indexed @ ref MeshPrimitive : : Triangles .
@ requires_gl30 Extension @ gl_extension { EXT , gpu_shader4 } for object ID input ,
@ gl_extension { EXT , texture_array } for object ID texture arrays
@ requires_gl30 The ` gl_VertexID ` shader variable is not available on OpenGL
2.1 .
@ requires_gl32 The ` gl_PrimitiveID ` shader variable is not available on OpenGL
3.1 and lower .
@ requires_gles32 The ` gl_PrimitiveID ` shader variable is not available on
OpenGL ES 3.1 and lower .
@ requires_gles30 Object ID input requires integer support in shaders , which
is not available in OpenGL ES 2.0 . Texture arrays for object ID texture
arrays are not available in OpenGL ES 2.0 .
@ requires_gles30 The ` gl_VertexID ` shader variable is not available on OpenGL
ES 2.0 .
@ requires_gles ` gl_PrimitiveID ` is not available in WebGL .
@ requires_webgl20 Object ID input requires integer support in shaders , which
is not available in WebGL 1.0 . Texture arrays for object ID texture
arrays are not available in WebGL 1.0 .
@ requires_webgl20 ` gl_VertexID ` is not available in WebGL 1.0 .
@ section Shaders - MeshVisualizerGL3D - instancing Instanced rendering
Enabling @ ref Flag : : InstancedTransformation will turn the shader into an
instanced one . It ' ll take per - instance transformation from the
@ ref TransformationMatrix attribute , applying it before the matrix set by
@ ref setTransformationMatrix ( ) . If one of @ ref Flag : : TangentDirection ,
@ ref Flag : : BitangentDirection or @ ref Flag : : NormalDirection is set ,
additionally also a normal matrix from the @ ref NormalMatrix attribute is
taken , applied before the matrix set by @ ref setNormalMatrix ( ) . The snippet
below shows adding a buffer with per - instance transformation to a mesh ,
including a normal matrix attribute for correct TBN visualization :
@ snippet MagnumShaders - gl . cpp MeshVisualizerGL3D - usage - instancing
If @ ref Flag : : ObjectIdTexture is used and @ ref Flag : : InstancedTextureOffset is
enabled , the @ ref TextureOffset attribute ( or @ ref TextureOffsetLayer in case
@ ref Flag : : TextureArrays is enabled as well ) then can supply per - instance
texture offset ( or offset and layer ) .
@ requires_gl33 Extension @ gl_extension { ARB , instanced_arrays }
@ requires_gles30 Extension @ gl_extension { ANGLE , instanced_arrays } ,
@ gl_extension { EXT , instanced_arrays } or @ gl_extension { NV , instanced_arrays }
in OpenGL ES 2.0 .
@ requires_webgl20 Extension @ webgl_extension { ANGLE , instanced_arrays } in WebGL
1.0 .
@ section Shaders - MeshVisualizerGL3D - ubo Uniform buffers
See @ ref shaders - usage - ubo for a high - level overview that applies to all
shaders . In this particular case , the shader needs a separate
@ ref ProjectionUniform3D and @ ref TransformationUniform3D buffer . To maximize
use of the limited uniform buffer memory , materials are supplied separately in
a @ ref MeshVisualizerMaterialUniform and then referenced via
@ relativeref { MeshVisualizerDrawUniform3D , materialId } from a
@ ref MeshVisualizerDrawUniform3D . A uniform buffer setup equivalent to the
@ ref Shaders - MeshVisualizerGL3D - wireframe " wireframe case at the top " would
look like this - - - note that @ ref setViewportSize ( ) is an immediate uniform
here as well , as it ' s assumed to be set globally and rarely changed :
@ snippet MagnumShaders - gl . cpp MeshVisualizerGL3D - ubo
For a multidraw workflow enable @ ref Flag : : MultiDraw , supply desired material
and draw count in the @ ref MeshVisualizerGL3D ( Flags , UnsignedInt , UnsignedInt )
constructor and specify material references for every draw . The usage is
similar for all shaders , see @ ref shaders - usage - multidraw for an example .
@ requires_gl31 Extension @ gl_extension { ARB , uniform_buffer_object } for uniform
buffers .
@ requires_gl46 Extension @ gl_extension { ARB , shader_draw_parameters } for
multidraw .
@ requires_gles30 Uniform buffers are not available in OpenGL ES 2.0 .
@ requires_webgl20 Uniform buffers are not available in WebGL 1.0 .
@ requires_es_extension Extension @ m_class { m - doc - external } [ ANGLE_multi_draw ] ( https : //chromium.googlesource.com/angle/angle/+/master/extensions/ANGLE_multi_draw.txt)
( unlisted ) for multidraw .
@ requires_webgl_extension Extension @ webgl_extension { ANGLE , multi_draw } for
multidraw .
@ see @ ref shaders , @ ref MeshVisualizerGL2D
@ todo Understand and add support wireframe width / smoothness without GS
*/
class MAGNUM_SHADERS_EXPORT MeshVisualizerGL3D : public Implementation : : MeshVisualizerGLBase {
public :
class Configuration ;
class CompileState ;
/**
* @ brief Vertex position
*
* @ ref shaders - generic " Generic attribute " ,
* @ ref Magnum : : Vector3 " Vector3 " .
*/
typedef typename GenericGL3D : : Position Position ;
/**
* @ brief Tangent direction
* @ m_since { 2020 , 06 }
*
* @ ref shaders - generic " Generic attribute " ,
* @ ref Magnum : : Vector3 " Vector3 " . Use either this or the @ ref Tangent4
* attribute . Used only if @ ref Flag : : TangentDirection is enabled .
*/
typedef typename GenericGL3D : : Tangent Tangent ;
/**
* @ brief Tangent direction with a bitangent sign
* @ m_since { 2020 , 06 }
*
* @ ref shaders - generic " Generic attribute " ,
* @ ref Magnum : : Vector4 " Vector4 " . Use either this or the @ ref Tangent
* attribute . Used only if @ ref Flag : : TangentDirection or
* @ ref Flag : : BitangentFromTangentDirection is enabled .
*/
typedef typename GenericGL3D : : Tangent4 Tangent4 ;
/**
* @ brief Bitangent direction
* @ m_since { 2020 , 06 }
*
* @ ref shaders - generic " Generic attribute " ,
* @ ref Magnum : : Vector3 " Vector3 " . Use either this or the @ ref Tangent4
* attribute . Used only if @ ref Flag : : BitangentDirection is enabled .
*/
typedef typename GenericGL3D : : Bitangent Bitangent ;
/**
* @ brief Normal direction
* @ m_since { 2020 , 06 }
*
* @ ref shaders - generic " Generic attribute " ,
* @ ref Magnum : : Vector3 " Vector3 " . Used only if
* @ ref Flag : : NormalDirection is enabled .
*/
typedef typename GenericGL3D : : Normal Normal ;
# ifndef MAGNUM_TARGET_GLES2
/**
* @ brief 2 D texture coordinates
* @ m_since_latest
*
* @ ref shaders - generic " Generic attribute " ,
* @ ref Magnum : : Vector2 " Vector2 " . Used only if
* @ ref Flag : : ObjectIdTexture is enabled .
* @ requires_gl33 Extension @ gl_extension { EXT , gpu_shader4 }
* @ requires_gles30 Object ID input requires integer support in
* shaders , which is not available in OpenGL ES 2.0 .
* @ requires_webgl20 Object ID input requires integer support in
* shaders , which is not available in WebGL 1.0 .
*/
typedef GenericGL3D : : TextureCoordinates TextureCoordinates ;
# endif
/**
* @ brief Vertex index
*
* @ ref Magnum : : Float " Float " , used only in OpenGL < 3.1 and OpenGL ES
* 2.0 if @ ref Flag : : Wireframe is enabled . This attribute ( modulo 3 )
* specifies index of given vertex in triangle , i . e . @ cpp 0.0f @ ce for
* first , @ cpp 1.0f @ ce for second , @ cpp 2.0f @ ce for third . In OpenGL
* 3.1 , OpenGL ES 3.0 and newer this value is provided via the
* @ cb { . glsl } gl_VertexID @ ce shader builtin , so the attribute is not
* needed .
*
* @ note This attribute uses the same slot as @ ref GenericGL : : ObjectId ,
* but since Object ID is available only on ES3 + and vertex index
* is used only on ES2 contexts without @ glsl gl_VertexID @ ce ,
* there should be no conflict between these two .
*/
typedef GL : : Attribute < 4 , Float > VertexIndex ;
# ifndef MAGNUM_TARGET_GLES2
/**
* @ brief ( Instanced ) object ID
* @ m_since { 2020 , 06 }
*
* @ ref shaders - generic " Generic attribute " , @ ref Magnum : : UnsignedInt .
* Used only if @ ref Flag : : InstancedObjectId is set .
* @ requires_gl30 Extension @ gl_extension { EXT , gpu_shader4 }
* @ requires_gles30 Object ID output requires integer support in
* shaders , which is not available in OpenGL ES 2.0 .
* @ requires_webgl20 Object ID output requires integer support in
* shaders , which is not available in WebGL 1.0 .
*/
typedef GenericGL3D : : ObjectId ObjectId ;
# endif
/**
* @ brief ( Instanced ) transformation matrix
* @ m_since_latest
*
* @ ref shaders - generic " Generic attribute " , @ ref Magnum : : Matrix4 .
* Used only if @ ref Flag : : InstancedTransformation is set .
* @ requires_gl33 Extension @ gl_extension { ARB , instanced_arrays }
* @ requires_gles30 Extension @ gl_extension { ANGLE , instanced_arrays } ,
* @ gl_extension { EXT , instanced_arrays } or
* @ gl_extension { NV , instanced_arrays } in OpenGL ES 2.0 .
* @ requires_webgl20 Extension @ webgl_extension { ANGLE , instanced_arrays }
* in WebGL 1.0 .
*/
typedef GenericGL3D : : TransformationMatrix TransformationMatrix ;
# if !defined(MAGNUM_TARGET_GLES2) && !defined(MAGNUM_TARGET_WEBGL)
/**
* @ brief ( Instanced ) normal matrix
* @ m_since_latest
*
* @ ref shaders - generic " Generic attribute " , @ ref Magnum : : Matrix3x3 .
* Used only if @ ref Flag : : InstancedTransformation and at least one of
* @ ref Flag : : TangentDirection , @ ref Flag : : BitangentDirection or
* @ ref Flag : : NormalDirection is set .
* @ requires_gl33 Extension @ gl_extension { ARB , geometry_shader4 } and
* @ gl_extension { ARB , instanced_arrays }
* @ requires_gles30 Not defined in OpenGL ES 2.0 .
* @ requires_gles32 Extension @ gl_extension { ANDROID , extension_pack_es31a }
* / @ gl_extension { EXT , geometry_shader }
* @ requires_gles Geometry shaders are not available in WebGL .
*/
typedef GenericGL3D : : NormalMatrix NormalMatrix ;
# endif
# ifndef MAGNUM_TARGET_GLES2
/**
* @ brief ( Instanced ) texture offset for an object ID texture
* @ m_since_latest
*
* @ ref shaders - generic " Generic attribute " , @ ref Magnum : : Vector2 . Used
* only if @ ref Flag : : InstancedTextureOffset is set .
* @ requires_gl33 Extension @ gl_extension { EXT , gpu_shader4 } and
* @ gl_extension { ARB , instanced_arrays }
* @ requires_gles30 Object ID input requires integer support in
* shaders , which is not available in OpenGL ES 2.0 .
* @ requires_webgl20 Object ID input requires integer support in
* shaders , which is not available in WebGL 1.0 .
*/
typedef typename GenericGL3D : : TextureOffset TextureOffset ;
/**
* @ brief ( Instanced ) texture offset and layer for an object ID texture
* @ m_since_latest
*
* @ ref shaders - generic " Generic attribute " , @ ref Magnum : : Vector3 , with
* the last component interpreted as an integer . Use either this or the
* @ ref TextureOffset attribute . First two components used only if
* @ ref Flag : : InstancedTextureOffset is set , third component only if
* @ ref Flag : : TextureArrays is set .
* @ requires_gl33 Extension @ gl_extension { EXT , gpu_shader4 } ,
* @ gl_extension { EXT , texture_array } and
* @ gl_extension { ARB , instanced_arrays }
* @ requires_gles30 Object ID input requires integer support in
* shaders , which is not available in OpenGL ES 2.0 . Texture
* arrays are not available in OpenGL ES 2.0 .
* @ requires_webgl20 Object ID input requires integer support in
* shaders , which is not available in WebGL 1.0 . Texture arrays
* are not available in WebGL 1.0 .
*/
typedef typename GenericGL3D : : TextureOffsetLayer TextureOffsetLayer ;
# endif
enum : UnsignedInt {
/**
* Color shader output . @ ref shaders - generic " Generic output " ,
* present always . Expects three - or four - component floating - point
* or normalized buffer attachment .
*/
ColorOutput = GenericGL3D : : ColorOutput
} ;
/**
* @ brief Flag
*
* @ see @ ref Flags , @ ref MeshVisualizer ( )
*/
enum class Flag : UnsignedInt {
/**
* Visualize wireframe . On OpenGL ES 2.0 and WebGL this also
* enables @ ref Flag : : NoGeometryShader .
*/
# if !defined(MAGNUM_TARGET_GLES2) && !defined(MAGNUM_TARGET_WEBGL)
Wireframe = 1 < < 0 ,
# else
Wireframe = ( 1 < < 0 ) | ( 1 < < 1 ) ,
# endif
/**
* Don ' t use a geometry shader for wireframe visualization . If
* enabled , you might need to provide also the @ ref VertexIndex
* attribute in the mesh . On OpenGL ES 2.0 and WebGL enabled
* alongside @ ref Flag : : Wireframe .
*
* Mutually exclusive with @ ref Flag : : TangentDirection ,
* @ ref Flag : : BitangentFromTangentDirection ,
* @ ref Flag : : BitangentDirection and @ ref Flag : : NormalDirection - - -
* those need a geometry shader always .
*/
NoGeometryShader = 1 < < 1 ,
# ifndef MAGNUM_TARGET_GLES2
/**
* Visualize object ID set via @ ref setObjectId ( ) or
* @ ref MeshVisualizerDrawUniform3D : : objectId . Since the ID is
* uniform for the whole draw , this feature is mainly useful in
* multidraw scenarios or when combined with
* @ ref Flag : : InstancedObjectId . Mutually exclusive with
* @ ref Flag : : VertexId and @ ref Flag : : PrimitiveId .
* @ requires_gl30 Extension @ gl_extension { EXT , gpu_shader4 }
* @ requires_gles30 Object ID input requires integer support in
* shaders , which is not available in OpenGL ES 2.0 .
* @ requires_webgl20 Object ID input requires integer support in
* shaders , which is not available in WebGL 1.0 .
* @ m_since_latest
*/
ObjectId = 1 < < 12 ,
/**
* Visualize instanced object ID . You need to provide the
* @ ref ObjectId attribute in the mesh , which then gets summed with
* the ID coming from @ ref setObjectId ( ) or
* @ ref MeshVisualizerDrawUniform3D : : objectId . Implicitly enables
* @ ref Flag : : ObjectId . Mutually exclusive with @ ref Flag : : VertexId
* and @ ref Flag : : PrimitiveId .
* @ requires_gl30 Extension @ gl_extension { EXT , gpu_shader4 }
* @ requires_gles30 Object ID input requires integer support in
* shaders , which is not available in OpenGL ES 2.0 .
* @ requires_webgl20 Object ID input requires integer support in
* shaders , which is not available in WebGL 1.0 .
* @ m_since { 2020 , 06 }
*/
InstancedObjectId = ( 1 < < 2 ) | ObjectId ,
/**
* Object ID texture . Retrieves object IDs from a texture bound
* with @ ref bindObjectIdTexture ( ) , outputting a sum of the object
* ID texture , the ID coming from @ ref setObjectId ( ) or
* @ ref MeshVisualizerDrawUniform3D : : objectId and possibly also the
* per - vertex ID , if @ ref Flag : : InstancedObjectId is enabled as
* well . Implicitly enables @ ref Flag : : ObjectId .
* @ requires_gl30 Extension @ gl_extension { EXT , gpu_shader4 }
* @ requires_gles30 Object ID input requires integer support in
* shaders , which is not available in OpenGL ES 2.0 .
* @ requires_webgl20 Object ID input requires integer support in
* shaders , which is not available in WebGL 1.0 .
* @ m_since_latest
*/
ObjectIdTexture = ( 1 < < 14 ) | ObjectId ,
/**
* Visualize vertex ID ( @ cpp gl_VertexID @ ce ) . Useful for
* visualizing mesh connectivity - - - primitives sharing vertices
* will have a smooth color map transition while duplicated
* vertices will cause a sharp edge . Mutually exclusive with
* @ ref Flag : : InstancedObjectId and @ ref Flag : : PrimitiveId .
* @ requires_gl30 The ` gl_VertexID ` shader variable is not
* available on OpenGL 2.1 .
* @ requires_gles30 The ` gl_VertexID ` shader variable is not
* available on OpenGL ES 2.0 .
* @ requires_webgl20 ` gl_VertexID ` is not available in WebGL 1.0 .
* @ m_since { 2020 , 06 }
*/
VertexId = 1 < < 3 ,
# ifndef MAGNUM_TARGET_WEBGL
/**
* Visualize primitive ID ( @ cpp gl_PrimitiveID @ ce ) . Useful for
* visualizing how well is the mesh optimized for a post - transform
* vertex cache . Mutually exclusive with
* @ ref Flag : : InstancedObjectId and @ ref Flag : : VertexId . See also
* @ ref Flag : : PrimitiveIdFromVertexId .
* @ requires_gl32 The ` gl_PrimitiveID ` shader variable is not
* available on OpenGL 3.1 and lower .
* @ requires_gles30 Not defined in OpenGL ES 2.0 .
* @ requires_gles32 The ` gl_PrimitiveID ` shader variable is not
* available on OpenGL ES 3.1 and lower .
* @ requires_gles ` gl_PrimitiveID ` is not available in WebGL .
* @ m_since { 2020 , 06 }
*/
PrimitiveId = 1 < < 4 ,
# endif
/**
* Visualize primitive ID on a non - indexed triangle mesh using
* @ cpp gl_VertexID / 3 @ ce . Implicitly enables
* @ ref Flag : : PrimitiveId , mutually exclusive with
* @ ref Flag : : InstancedObjectId . Usable on OpenGL < 3.2 ,
* OpenGL ES < 3.2 and WebGL where @ cpp gl_PrimitiveID @ ce is not
* available .
* @ requires_gl30 The ` gl_VertexID ` shader variable is not
* available on OpenGL 2.1 .
* @ requires_gles30 The ` gl_VertexID ` shader variable is not
* available on OpenGL ES 2.0 .
* @ requires_webgl20 ` gl_VertexID ` is not available in WebGL 1.0 .
* @ m_since { 2020 , 06 }
*/
# ifndef MAGNUM_TARGET_WEBGL
PrimitiveIdFromVertexId = ( 1 < < 5 ) | PrimitiveId ,
# else
PrimitiveIdFromVertexId = ( 1 < < 5 ) | ( 1 < < 4 ) ,
# endif
# endif
# if !defined(MAGNUM_TARGET_GLES2) && !defined(MAGNUM_TARGET_WEBGL)
/**
* Visualize tangent direction with red lines pointing out of
* vertices . You need to provide the @ ref Tangent or @ ref Tangent4
* attribute in the mesh . Mutually exclusive with
* @ ref Flag : : NoGeometryShader ( as this needs a geometry shader
* always ) .
* @ requires_gl32 Extension @ gl_extension { ARB , geometry_shader4 }
* @ requires_gles30 Not defined in OpenGL ES 2.0 .
* @ requires_gles32 Extension @ gl_extension { ANDROID , extension_pack_es31a } /
* @ gl_extension { EXT , geometry_shader }
* @ requires_gles Geometry shaders are not available in WebGL .
* @ m_since { 2020 , 06 }
*/
TangentDirection = 1 < < 6 ,
/**
* Visualize bitangent direction with green lines pointing out of
* vertices . You need to provide both @ ref Normal and @ ref Tangent4
* attributes in the mesh , alternatively you can provide the
* @ ref Bitangent attribute and enable
* @ ref Flag : : BitangentDirection instead . Mutually exclusive with
* @ ref Flag : : NoGeometryShader ( as this needs a geometry shader
* always ) .
* @ requires_gl32 Extension @ gl_extension { ARB , geometry_shader4 }
* @ requires_gles30 Not defined in OpenGL ES 2.0 .
* @ requires_gles32 Extension @ gl_extension { ANDROID , extension_pack_es31a } /
* @ gl_extension { EXT , geometry_shader }
* @ requires_gles Geometry shaders are not available in WebGL .
* @ m_since { 2020 , 06 }
*/
BitangentFromTangentDirection = 1 < < 7 ,
/**
* Visualize bitangent direction with green lines pointing out of
* vertices . You need to provide the @ ref Bitangent attribute in
* the mesh , alternatively you can provide both @ ref Normal and
* @ ref Tangent4 attributes and enable
* @ ref Flag : : BitangentFromTangentDirection instead . Mutually
* exclusive with @ ref Flag : : NoGeometryShader ( as this needs a
* geometry shader always ) .
* @ requires_gl32 Extension @ gl_extension { ARB , geometry_shader4 }
* @ requires_gles30 Not defined in OpenGL ES 2.0 .
* @ requires_gles32 Extension @ gl_extension { ANDROID , extension_pack_es31a } /
* @ gl_extension { EXT , geometry_shader }
* @ requires_gles Geometry shaders are not available in WebGL .
* @ m_since { 2020 , 06 }
*/
BitangentDirection = 1 < < 8 ,
/**
* Visualize normal direction with blue lines pointing out of
* vertices . You need to provide the @ ref Normal attribute in the
* mesh . Mutually exclusive with @ ref Flag : : NoGeometryShader ( as
* this needs a geometry shader always ) .
* @ requires_gl32 Extension @ gl_extension { ARB , geometry_shader4 }
* @ requires_gles30 Not defined in OpenGL ES 2.0 .
* @ requires_gles32 Extension @ gl_extension { ANDROID , extension_pack_es31a } /
* @ gl_extension { EXT , geometry_shader }
* @ requires_gles Geometry shaders are not available in WebGL .
* @ m_since { 2020 , 06 }
*/
NormalDirection = 1 < < 9 ,
# endif
/**
* Instanced transformation . Retrieves a per - instance
* transformation and normal matrix from the
* @ ref TransformationMatrix / @ ref NormalMatrix attributes and
* uses them together with matrices coming from
* @ ref setTransformationMatrix ( ) and @ ref setNormalMatrix ( ) or
* @ ref TransformationUniform3D : : transformationMatrix and
* @ ref MeshVisualizerDrawUniform3D : : normalMatrix ( first the
* per - instance , then the uniform matrix ) . See
* @ ref Shaders - MeshVisualizerGL3D - instancing for more information .
* @ requires_gl33 Extension @ gl_extension { ARB , instanced_arrays }
* @ requires_gles30 Extension @ gl_extension { ANGLE , instanced_arrays } ,
* @ gl_extension { EXT , instanced_arrays } or
* @ gl_extension { NV , instanced_arrays } in OpenGL ES 2.0 .
* @ requires_webgl20 Extension @ webgl_extension { ANGLE , instanced_arrays }
* in WebGL 1.0 .
* @ m_since_latest
*/
InstancedTransformation = 1 < < 13 ,
# ifndef MAGNUM_TARGET_GLES2
/**
* Enable texture coordinate transformation for an object ID
* texture . If this flag is set , the shader expects that
* @ ref Flag : : ObjectIdTexture is enabled as well .
* @ see @ ref setTextureMatrix ( )
* @ requires_gl30 Extension @ gl_extension { EXT , gpu_shader4 }
* @ requires_gles30 Object ID input requires integer support in
* shaders , which is not available in OpenGL ES 2.0 .
* @ requires_webgl20 Object ID input requires integer support in
* shaders , which is not available in WebGL 1.0 .
* @ m_since_latest
* @ todoc rewrite the ext requirements once we have more textures
*/
TextureTransformation = 1 < < 15 ,
/**
* Instanced texture offset for an object ID texture . Retrieves a
* per - instance offset vector from the @ ref TextureOffset attribute
* and uses it together with the matrix coming from
* @ ref setTextureMatrix ( ) or
* @ ref TextureTransformationUniform : : rotationScaling and
* @ ref TextureTransformationUniform : : offset ( first the
* per - instance vector , then the uniform matrix ) . Instanced texture
* scaling and rotation is not supported at the moment , you can
* specify that only via the uniform @ ref setTextureMatrix ( ) .
* Implicitly enables @ ref Flag : : TextureTransformation . See
* @ ref Shaders - MeshVisualizerGL2D - instancing for more information .
*
* If @ ref Flag : : TextureArrays is set as well , a three - component
* @ ref TextureOffsetLayer attribute can be used instead of
* @ ref TextureOffset to specify per - instance texture layer , which
* gets added to the uniform layer numbers set by
* @ ref setTextureLayer ( ) or
* @ ref TextureTransformationUniform : : layer .
* @ requires_gl30 Extension
* @ requires_gl33 Extension @ gl_extension { EXT , gpu_shader4 } and
* @ gl_extension { ARB , instanced_arrays }
* @ requires_gles30 Object ID input requires integer support in
* shaders , which is not available in OpenGL ES 2.0 .
* @ requires_webgl20 Object ID input requires integer support in
* shaders , which is not available in WebGL 1.0 .
* @ m_since_latest
* @ todoc rewrite the ext requirements once we have more textures
*/
InstancedTextureOffset = ( 1 < < 16 ) | TextureTransformation ,
# endif
# ifndef MAGNUM_TARGET_GLES2
/**
* Use uniform buffers . Expects that uniform data are supplied via
* @ ref bindProjectionBuffer ( ) , @ ref bindTransformationBuffer ( ) ,
* @ ref bindDrawBuffer ( ) and @ ref bindMaterialBuffer ( ) instead of
* direct uniform setters .
* @ requires_gl31 Extension @ gl_extension { ARB , uniform_buffer_object }
* @ requires_gles30 Uniform buffers are not available in OpenGL ES
* 2.0 .
* @ requires_webgl20 Uniform buffers are not available in WebGL
* 1.0 .
* @ m_since_latest
*/
UniformBuffers = 1 < < 10 ,
/**
* Enable multidraw functionality . Implies @ ref Flag : : UniformBuffers
* and combines the value from @ ref setDrawOffset ( ) with the
* @ glsl gl_DrawID @ ce builtin , which makes draws submitted via
* @ ref GL : : AbstractShaderProgram : : draw ( const Containers : : Iterable < MeshView > & )
* pick up per - draw parameters directly , without having to rebind
* the uniform buffers or specify @ ref setDrawOffset ( ) before each
* draw . In a non - multidraw scenario , @ glsl gl_DrawID @ ce is
* @ cpp 0 @ ce , which means a shader with this flag enabled can be
* used for regular draws as well .
* @ requires_gl46 Extension @ gl_extension { ARB , uniform_buffer_object }
* and @ gl_extension { ARB , shader_draw_parameters }
* @ requires_es_extension OpenGL ES 3.0 and extension
* @ m_class { m - doc - external } [ ANGLE_multi_draw ] ( https : //chromium.googlesource.com/angle/angle/+/master/extensions/ANGLE_multi_draw.txt)
* ( unlisted ) . While the extension alone needs only OpenGL ES
* 2.0 , the shader implementation relies on uniform buffers ,
* which require OpenGL ES 3.0 .
* @ requires_webgl_extension WebGL 2.0 and extension
* @ webgl_extension { ANGLE , multi_draw } . While the extension
* alone needs only WebGL 1.0 , the shader implementation
* relies on uniform buffers , which require WebGL 2.0 .
* @ m_since_latest
*/
MultiDraw = UniformBuffers | ( 1 < < 11 ) ,
/**
* Use 2 D texture arrays for an object ID texture . Expects that the
* texture is supplied via
* @ ref bindObjectIdTexture ( GL : : Texture2DArray & ) and the layer
* is set via @ ref setTextureLayer ( ) or
* @ ref TextureTransformationUniform : : layer . If
* @ ref Flag : : InstancedTextureOffset is set as well and a
* three - component @ ref TextureOffsetLayer attribute is used
* instead of @ ref TextureOffset , the per - instance and uniform
* layer numbers are added together .
* @ requires_gl30 Extension @ gl_extension { EXT , gpu_shader4 } and
* @ gl_extension { EXT , texture_array }
* @ requires_gles30 Object ID input requires integer support in
* shaders , which is not available in OpenGL ES 2.0 . Texture
* arrays are not available in OpenGL ES 2.0 .
* @ requires_webgl20 Object ID input requires integer support in
* shaders , which is not available in WebGL 1.0 . Texture
* arrays are not available in WebGL 1.0 .
* @ m_since_latest
* @ todoc rewrite the ext requirements once we have more textures
*/
TextureArrays = 1 < < 17
# endif
} ;
/** @brief Flags */
typedef Containers : : EnumSet < Flag > Flags ;
/**
* @ brief Compile asynchronously
* @ m_since_latest
*
* Compared to @ ref MeshVisualizerGL3D ( const Configuration & ) can
* perform an asynchronous compilation and linking . See
* @ ref shaders - async for more information .
* @ see @ ref MeshVisualizerGL3D ( CompileState & & )
*/
/* No default value, consistently with MeshVisualizerGL3D(Configuration) */
static CompileState compile ( const Configuration & configuration ) ;
# ifdef MAGNUM_BUILD_DEPRECATED
/**
* @ brief Compile asynchronously
* @ m_deprecated_since_latest Use @ ref compile ( const Configuration & )
* instead .
*/
CORRADE_DEPRECATED ( " use compile(const Configuration& instead " ) static CompileState compile ( Flags flags ) ;
# ifndef MAGNUM_TARGET_GLES2
/**
* @ brief Compile for a multi - draw scenario asynchronously
* @ m_deprecated_since_latest Use @ ref compile ( const Configuration & )
* instead .
* @ requires_gl31 Extension @ gl_extension { ARB , uniform_buffer_object }
* @ requires_gles30 Uniform buffers are not available in OpenGL ES 2.0 .
* @ requires_webgl20 Uniform buffers are not available in WebGL 1.0 .
*/
CORRADE_DEPRECATED ( " use compile(const Configuration& instead " ) static CompileState compile ( Flags flags , UnsignedInt materialCount , UnsignedInt drawCount ) ;
# endif
# endif
/**
* @ brief Constructor
* @ m_since_latest
*/
/* No default value, as at least one Flag has to be set. There's a
deprecated default - value overload below , though . */
explicit MeshVisualizerGL3D ( const Configuration & configuration ) ;
# ifdef MAGNUM_BUILD_DEPRECATED
/**
* @ brief Constructor
* @ m_deprecated_since { 2020 , 06 } Use @ ref MeshVisualizerGL3D ( const Configuration & )
* instead .
*/
explicit CORRADE_DEPRECATED ( " use MeshVisualizerGL3D(Configuration) instead " ) MeshVisualizerGL3D() ;
/**
* @ brief Constructor
* @ m_deprecated_since_latest Use @ ref MeshVisualizerGL3D ( const Configuration & )
* instead .
*/
explicit CORRADE_DEPRECATED ( " use MeshVisualizerGL3D(const Configuration& instead " ) MeshVisualizerGL3D ( Flags flags ) ;
# ifndef MAGNUM_TARGET_GLES2
/**
* @ brief Construct for a multi - draw scenario
* @ m_deprecated_since_latest Use @ ref MeshVisualizerGL3D ( const Configuration & )
* instead .
* @ requires_gl31 Extension @ gl_extension { ARB , uniform_buffer_object }
* @ requires_gles30 Uniform buffers are not available in OpenGL ES 2.0 .
* @ requires_webgl20 Uniform buffers are not available in WebGL 1.0 .
*/
explicit CORRADE_DEPRECATED ( " use MeshVisualizerGL3D(const Configuration& instead " ) MeshVisualizerGL3D ( Flags flags , UnsignedInt materialCount , UnsignedInt drawCount ) ;
# endif
# endif
/**
* @ brief Finalize an asynchronous compilation
* @ m_since_latest
*
* Takes an asynchronous compilation state returned by @ ref compile ( )
* and forms a ready - to - use shader object . See @ ref shaders - async for
* more information .
*/
explicit MeshVisualizerGL3D ( CompileState & & state ) ;
/**
* @ brief Construct without creating the underlying OpenGL object
*
* The constructed instance is equivalent to a 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 .
* However note that this is a low - level and a potentially dangerous
* API , see the documentation of @ ref NoCreate for alternatives .
*/
explicit MeshVisualizerGL3D ( NoCreateT ) noexcept : Implementation : : MeshVisualizerGLBase { NoCreate } { }
/** @brief Copying is not allowed */
MeshVisualizerGL3D ( const MeshVisualizerGL3D & ) = delete ;
/** @brief Move constructor */
MeshVisualizerGL3D ( MeshVisualizerGL3D & & ) noexcept = default ;
/** @brief Copying is not allowed */
MeshVisualizerGL3D & operator = ( const MeshVisualizerGL3D & ) = delete ;
/** @brief Move assignment */
MeshVisualizerGL3D & operator = ( MeshVisualizerGL3D & & ) noexcept = default ;
/** @brief Flags */
Flags flags ( ) const {
return Flag ( UnsignedInt ( Implementation : : MeshVisualizerGLBase : : _flags ) ) ;
}
# ifndef MAGNUM_TARGET_GLES2
/**
* @ brief Material count
* @ m_since_latest
*
* Statically defined size of the @ ref MeshVisualizerMaterialUniform
* uniform buffer . Has use only if @ ref Flag : : UniformBuffers is set .
* @ see @ ref bindMaterialBuffer ( )
* @ requires_gles30 Not defined on OpenGL ES 2.0 builds .
* @ requires_webgl20 Not defined on WebGL 1.0 builds .
*/
UnsignedInt materialCount ( ) const { return _materialCount ; }
/**
* @ brief Draw count
* @ m_since_latest
*
* Statically defined size of each of the
* @ ref TransformationProjectionUniform3D and
* @ ref MeshVisualizerDrawUniform3D uniform buffers . Has use only if
* @ ref Flag : : UniformBuffers is set .
* @ requires_gles30 Not defined on OpenGL ES 2.0 builds .
* @ requires_webgl20 Not defined on WebGL 1.0 builds .
*/
UnsignedInt drawCount ( ) const { return _drawCount ; }
# endif
/** @{
* @ name Uniform setters
*
* Used only if @ ref Flag : : UniformBuffers is not set .
*/
# ifdef MAGNUM_BUILD_DEPRECATED
/**
* @ brief Set transformation and projection matrix
* @ m_deprecated_since { 2020 , 06 } Use @ ref setTransformationMatrix ( ) and
* @ ref setProjectionMatrix ( ) instead .
*/
CORRADE_DEPRECATED ( " use setTransformationMatrix() and setProjectionMatrix() instead " ) MeshVisualizerGL3D & setTransformationProjectionMatrix ( const Matrix4 & matrix ) {
/* Keep projection at identity, which should still work for
wireframe ( but of course not for TBN visualization ) */
return setTransformationMatrix ( matrix ) ;
}
# endif
/**
* @ brief Set transformation matrix
* @ return Reference to self ( for method chaining )
*
* Initial value is an identity matrix . If
* @ ref Flag : : InstancedTransformation is set , the per - instance
* transformation coming from the @ ref TransformationMatrix attribute
* is applied first , before this one .
*
* Expects that @ ref Flag : : UniformBuffers is not set , in that case fill
* @ ref TransformationUniform3D : : transformationMatrix and call
* @ ref bindTransformationBuffer ( ) instead .
*/
MeshVisualizerGL3D & setTransformationMatrix ( const Matrix4 & matrix ) ;
/**
* @ brief Set projection matrix
* @ return Reference to self ( for method chaining )
*
* Initial value is an identity matrix . ( i . e . , an orthographic
* projection of the default @ f $ [ - \ boldsymbol { 1 } ; \ boldsymbol { 1 } ] @ f $
* cube ) .
*
* Expects that @ ref Flag : : UniformBuffers is not set , in that case fill
* @ ref ProjectionUniform3D : : projectionMatrix and call
* @ ref bindProjectionBuffer ( ) instead .
*/
MeshVisualizerGL3D & setProjectionMatrix ( const Matrix4 & matrix ) ;
# if !defined(MAGNUM_TARGET_GLES2) && !defined(MAGNUM_TARGET_WEBGL)
/**
* @ brief Set transformation matrix
* @ return Reference to self ( for method chaining )
* @ m_since { 2020 , 06 }
*
* Expects that @ ref Flag : : TangentDirection ,
* @ ref Flag : : BitangentDirection or @ ref Flag : : NormalDirection is
* enabled . The matrix doesn ' t need to be normalized , as
* renormalization is done per - fragment anyway .
* Initial value is an identity matrix . If
* @ ref Flag : : InstancedTransformation is set , the per - instance normal
* matrix coming from the @ ref NormalMatrix attribute is applied first ,
* before this one .
*
* Expects that @ ref Flag : : UniformBuffers is not set , in that case fill
* @ ref MeshVisualizerDrawUniform3D : : normalMatrix and call
* @ ref bindDrawBuffer ( ) instead .
* @ requires_gl32 Extension @ gl_extension { ARB , geometry_shader4 }
* @ requires_gles30 Not defined in OpenGL ES 2.0 .
* @ requires_gles32 Extension @ gl_extension { ANDROID , extension_pack_es31a } /
* @ gl_extension { EXT , geometry_shader }
* @ requires_gles Geometry shaders are not available in WebGL .
*/
MeshVisualizerGL3D & setNormalMatrix ( const Matrix3x3 & matrix ) ;
# endif
# ifndef MAGNUM_TARGET_GLES2
/**
* @ brief Set texture coordinate transformation matrix for an object ID texture
* @ return Reference to self ( for method chaining )
* @ m_since_latest
*
* Expects that the shader was created with
* @ ref Flag : : TextureTransformation enabled . Initial value is an
* identity matrix . If @ ref Flag : : InstancedTextureOffset is set , the
* per - instance offset coming from the @ ref TextureOffset attribute is
* applied first , before this matrix .
*
* Expects that @ ref Flag : : UniformBuffers is not set , in that case fill
* @ ref TextureTransformationUniform : : rotationScaling and
* @ ref TextureTransformationUniform : : offset and call
* @ ref bindTextureTransformationBuffer ( ) instead .
* @ requires_gl33 Extension @ gl_extension { EXT , gpu_shader4 } and
* @ gl_extension { ARB , instanced_arrays }
* @ requires_gles30 Object ID input requires integer support in
* shaders , which is not available in OpenGL ES 2.0 .
* @ requires_webgl20 Object ID input requires integer support in
* shaders , which is not available in WebGL 1.0 .
* @ todoc rewrite the ext requirements once we have more textures
*/
MeshVisualizerGL3D & setTextureMatrix ( const Matrix3 & matrix ) {
return static_cast < MeshVisualizerGL3D & > ( Implementation : : MeshVisualizerGLBase : : setTextureMatrix ( matrix ) ) ;
}
/**
* @ brief Set texture array layer for an object ID texture
* @ return Reference to self ( for method chaining )
* @ m_since_latest
*
* Expects that the shader was created with @ ref Flag : : TextureArrays
* enabled . Initial value is @ cpp 0 @ ce . If
* @ ref Flag : : InstancedTextureOffset is set and a three - component
* @ ref TextureOffsetLayer attribute is used instead of
* @ ref TextureOffset , this value is added to the layer coming from the
* third component .
*
* Expects that @ ref Flag : : UniformBuffers is not set , in that case fill
* @ ref TextureTransformationUniform : : layer and call
* @ ref bindTextureTransformationBuffer ( ) instead .
* @ requires_gl33 Extension @ gl_extension { EXT , gpu_shader4 } and
* @ gl_extension { EXT , texture_array }
* @ requires_gles30 Object ID input requires integer support in
* shaders , which is not available in OpenGL ES 2.0 . Texture
* arrays are not available in OpenGL ES 2.0 .
* @ requires_webgl20 Object ID input requires integer support in
* shaders , which is not available in WebGL 1.0 . Texture arrays are
* not available in WebGL 1.0 .
* @ todoc rewrite the ext requirements once we have more textures
*/
MeshVisualizerGL3D & setTextureLayer ( UnsignedInt layer ) {
return static_cast < MeshVisualizerGL3D & > ( Implementation : : MeshVisualizerGLBase : : setTextureLayer ( layer ) ) ;
}
# endif
/**
* @ brief Set viewport size
* @ return Reference to self ( for method chaining )
*
* Has effect only if @ ref Flag : : Wireframe is enabled and geometry
* shaders are used ; or if @ ref Flag : : TangentDirection ,
* @ ref Flag : : BitangentDirection or @ ref Flag : : NormalDirection is
* enabled , otherwise it does nothing . Initial value is a zero vector .
*/
MeshVisualizerGL3D & setViewportSize ( const Vector2 & size ) ;
# ifndef MAGNUM_TARGET_GLES2
/**
* @ brief Set object ID
* @ return Reference to self ( for method chaining )
* @ m_since_latest
*
* Expects that @ ref Flag : : ObjectId is enabled . Default is
* @ cpp 0 @ ce . If @ ref Flag : : InstancedObjectId is enabled as well , this
* value is added to the ID coming from the @ ref ObjectId attribute .
*
* Expects that @ ref Flag : : UniformBuffers is not set , in that case fill
* @ ref MeshVisualizerDrawUniform3D : : objectId and call
* @ ref bindDrawBuffer ( ) instead .
* @ requires_gl30 Extension @ gl_extension { EXT , gpu_shader4 }
* @ requires_gles30 Object ID input requires integer support in
* shaders , which is not available in OpenGL ES 2.0 .
* @ requires_webgl20 Object ID input requires integer support in
* shaders , which is not available in WebGL 1.0 .
*/
MeshVisualizerGL3D & setObjectId ( UnsignedInt id ) {
return static_cast < MeshVisualizerGL3D & > ( Implementation : : MeshVisualizerGLBase : : setObjectId ( id ) ) ;
}
# endif
/**
* @ brief Set base object color
* @ return Reference to self ( for method chaining )
*
* Initial value is @ cpp 0xffffffff _rgbaf @ ce . Expects that either
* @ ref Flag : : Wireframe or @ ref Flag : : InstancedObjectId /
* @ ref Flag : : PrimitiveId / @ ref Flag : : PrimitiveIdFromVertexId is
* enabled . In case of the latter , the color is multiplied with the
* color map coming from @ ref bindColorMapTexture ( ) .
*
* Expects that @ ref Flag : : UniformBuffers is not set , in that case fill
* @ ref MeshVisualizerMaterialUniform : : color and call
* @ ref bindMaterialBuffer ( ) instead .
*/
MeshVisualizerGL3D & setColor ( const Color4 & color ) {
return static_cast < MeshVisualizerGL3D & > ( Implementation : : MeshVisualizerGLBase : : setColor ( color ) ) ;
}
/**
* @ brief Set wireframe color
* @ return Reference to self ( for method chaining )
*
* Initial value is @ cpp 0x000000ff _rgbaf @ ce . Expects that
* @ ref Flag : : Wireframe is enabled .
*
* Expects that @ ref Flag : : UniformBuffers is not set , in that case fill
* @ ref MeshVisualizerMaterialUniform : : wireframeColor and call
* @ ref bindMaterialBuffer ( ) instead .
*/
MeshVisualizerGL3D & setWireframeColor ( const Color4 & color ) {
return static_cast < MeshVisualizerGL3D & > ( Implementation : : MeshVisualizerGLBase : : setWireframeColor ( color ) ) ;
}
/**
* @ brief Set wireframe width
* @ return Reference to self ( for method chaining )
*
* The value is in screen space ( depending on @ ref setViewportSize ( ) ) ,
* initial value is @ cpp 1.0f @ ce . Expects that @ ref Flag : : Wireframe is
* enabled .
*
* Expects that @ ref Flag : : UniformBuffers is not set , in that case fill
* @ ref MeshVisualizerMaterialUniform : : wireframeWidth and call
* @ ref bindMaterialBuffer ( ) instead .
*/
MeshVisualizerGL3D & setWireframeWidth ( Float width ) {
return static_cast < MeshVisualizerGL3D & > ( Implementation : : MeshVisualizerGLBase : : setWireframeWidth ( width ) ) ;
}
# ifndef MAGNUM_TARGET_GLES2
/**
* @ brief Set color map transformation
* @ return Reference to self ( for method chaining )
* @ m_since { 2020 , 06 }
*
* Offset and scale applied to the input value coming either from the
* @ ref ObjectId attribute or @ glsl gl_PrimitiveID @ ce , resulting value
* is then used to fetch a color from a color map bound with
* @ ref bindColorMapTexture ( ) . Initial value is @ cpp 1.0f / 512.0f @ ce
* and @ cpp 1.0 / 256.0f @ ce , meaning that for a 256 - entry colormap the
* first 256 values get an exact color from it and the next values will
* be either clamped to last color or repeated depending on the color
* map texture wrapping mode . Expects that either
* @ ref Flag : : InstancedObjectId or @ ref Flag : : PrimitiveId /
* @ ref Flag : : PrimitiveIdFromVertexId is enabled .
*
* Expects that @ ref Flag : : UniformBuffers is not set , in that case fill
* @ ref MeshVisualizerMaterialUniform : : colorMapOffset and
* @ ref MeshVisualizerMaterialUniform : : colorMapScale and call
* @ ref bindMaterialBuffer ( ) instead .
* @ requires_gles30 Object ID visualization requires integer attributes
* while primitive ID visualization requires the ` gl_VertexID ` /
* ` gl_PrimitiveID ` builtins , neither of which is available in
* OpenGL ES 2.0 .
* @ requires_webgl20 Object ID visualization requires integer
* attributes while primitive ID visualization requires at least
* the ` gl_VertexID ` builtin , neither of which is available in
* WebGL 1.
*/
MeshVisualizerGL3D & setColorMapTransformation ( Float offset , Float scale ) {
return static_cast < MeshVisualizerGL3D & > ( Implementation : : MeshVisualizerGLBase : : setColorMapTransformation ( offset , scale ) ) ;
}
# endif
# if !defined(MAGNUM_TARGET_GLES2) && !defined(MAGNUM_TARGET_WEBGL)
/**
* @ brief Set line width
* @ return Reference to self ( for method chaining )
* @ m_since { 2020 , 06 }
*
* The value is in screen space ( depending on @ ref setViewportSize ( ) ) ,
* initial value is @ cpp 1.0f @ ce . Expects that
* @ ref Flag : : TangentDirection ,
* @ ref Flag : : BitangentFromTangentDirection ,
* @ ref Flag : : BitangentDirection or @ ref Flag : : NormalDirection is
* enabled .
*
* Expects that @ ref Flag : : UniformBuffers is not set , in that case fill
* @ ref MeshVisualizerMaterialUniform : : lineWidth and call
* @ ref bindMaterialBuffer ( ) instead .
* @ requires_gl32 Extension @ gl_extension { ARB , geometry_shader4 }
* @ requires_gles30 Not defined in OpenGL ES 2.0 .
* @ requires_gles32 Extension @ gl_extension { ANDROID , extension_pack_es31a } /
* @ gl_extension { EXT , geometry_shader }
* @ requires_gles Geometry shaders are not available in WebGL .
*/
MeshVisualizerGL3D & setLineWidth ( Float width ) ;
/**
* @ brief Set line length
* @ return Reference to self ( for method chaining )
* @ m_since { 2020 , 06 }
*
* The value is in object space , initial value is @ cpp 1.0f @ ce .
* Expects that @ ref Flag : : TangentDirection ,
* @ ref Flag : : BitangentFromTangentDirection ,
* @ ref Flag : : BitangentDirection or @ ref Flag : : NormalDirection is
* enabled .
*
* Expects that @ ref Flag : : UniformBuffers is not set , in that case fill
* @ ref MeshVisualizerMaterialUniform : : lineLength and call
* @ ref bindMaterialBuffer ( ) instead .
* @ requires_gl32 Extension @ gl_extension { ARB , geometry_shader4 }
* @ requires_gles30 Not defined in OpenGL ES 2.0 .
* @ requires_gles32 Extension @ gl_extension { ANDROID , extension_pack_es31a } /
* @ gl_extension { EXT , geometry_shader }
* @ requires_gles Geometry shaders are not available in WebGL .
*/
MeshVisualizerGL3D & setLineLength ( Float length ) ;
# endif
/**
* @ brief Set line smoothness
* @ return Reference to self ( for method chaining )
*
* The value is in screen space ( depending on @ ref setViewportSize ( ) ) ,
* initial value is @ cpp 2.0f @ ce . Expects that @ ref Flag : : Wireframe ,
* @ ref Flag : : TangentDirection ,
* @ ref Flag : : BitangentFromTangentDirection ,
* @ ref Flag : : BitangentDirection or @ ref Flag : : NormalDirection is
* enabled .
*
* Expects that @ ref Flag : : UniformBuffers is not set , in that case fill
* @ ref MeshVisualizerMaterialUniform : : smoothness and call
* @ ref bindMaterialBuffer ( ) instead .
*/
MeshVisualizerGL3D & setSmoothness ( Float smoothness ) ;
/**
* @ }
*/
# ifndef MAGNUM_TARGET_GLES2
/** @{
* @ name Uniform buffer binding and related uniform setters
*
* Used if @ ref Flag : : UniformBuffers is set .
*/
/**
* @ brief Set a draw offset
* @ return Reference to self ( for method chaining )
* @ m_since_latest
*
* Specifies which item in the @ ref TransformationUniform3D and
* @ ref MeshVisualizerDrawUniform3D buffers bound with
* @ ref bindTransformationBuffer ( ) and @ ref bindDrawBuffer ( ) should be
* used for current draw . Expects that @ ref Flag : : UniformBuffers is set
* and @ p offset is less than @ ref drawCount ( ) . Initial value is
* @ cpp 0 @ ce , if @ ref drawCount ( ) is @ cpp 1 @ ce , the function is a
* no - op as the shader assumes draw offset to be always zero .
*
* If @ ref Flag : : MultiDraw is set , @ glsl gl_DrawID @ ce is added to this
* value , which makes each draw submitted via
* @ ref GL : : AbstractShaderProgram : : draw ( const Containers : : Iterable < MeshView > & )
* pick up its own per - draw parameters .
* @ requires_gl31 Extension @ gl_extension { ARB , uniform_buffer_object }
* @ requires_gles30 Uniform buffers are not available in OpenGL ES 2.0 .
* @ requires_webgl20 Uniform buffers are not available in WebGL 1.0 .
*/
MeshVisualizerGL3D & setDrawOffset ( UnsignedInt offset ) {
return static_cast < MeshVisualizerGL3D & > ( Implementation : : MeshVisualizerGLBase : : setDrawOffset ( offset ) ) ;
}
/**
* @ brief Set a projection uniform buffer
* @ return Reference to self ( for method chaining )
* @ m_since_latest
*
* Expects that @ ref Flag : : UniformBuffers is set . The buffer is
* expected to contain at least one instance of
* @ ref ProjectionUniform3D . At the very least you need to call also
* @ ref bindTransformationBuffer ( ) , @ ref bindDrawBuffer ( ) and
* @ ref bindMaterialBuffer ( ) .
* @ requires_gl31 Extension @ gl_extension { ARB , uniform_buffer_object }
* @ requires_gles30 Uniform buffers are not available in OpenGL ES 2.0 .
* @ requires_webgl20 Uniform buffers are not available in WebGL 1.0 .
*/
MeshVisualizerGL3D & bindProjectionBuffer ( GL : : Buffer & buffer ) ;
/**
* @ overload
* @ m_since_latest
*/
MeshVisualizerGL3D & bindProjectionBuffer ( GL : : Buffer & buffer , GLintptr offset , GLsizeiptr size ) ;
/**
* @ brief Set a transformation uniform buffer
* @ return Reference to self ( for method chaining )
* @ m_since_latest
*
* Expects that @ ref Flag : : UniformBuffers is set . The buffer is
* expected to contain @ ref drawCount ( ) instances of
* @ ref TransformationUniform3D . At the very least you need to call
* also @ ref bindDrawBuffer ( ) and @ ref bindMaterialBuffer ( ) .
* @ requires_gl31 Extension @ gl_extension { ARB , uniform_buffer_object }
* @ requires_gles30 Uniform buffers are not available in OpenGL ES 2.0 .
* @ requires_webgl20 Uniform buffers are not available in WebGL 1.0 .
*/
MeshVisualizerGL3D & bindTransformationBuffer ( GL : : Buffer & buffer ) ;
/**
* @ overload
* @ m_since_latest
*/
MeshVisualizerGL3D & bindTransformationBuffer ( GL : : Buffer & buffer , GLintptr offset , GLsizeiptr size ) ;
/**
* @ brief Set a draw uniform buffer
* @ return Reference to self ( for method chaining )
* @ m_since_latest
*
* Expects that @ ref Flag : : UniformBuffers is set . The buffer is
* expected to contain @ ref drawCount ( ) instances of
* @ ref MeshVisualizerDrawUniform3D . At the very least you need to call
* also @ ref bindProjectionBuffer ( ) , @ ref bindTransformationBuffer ( )
* and @ ref bindMaterialBuffer ( ) .
* @ requires_gl31 Extension @ gl_extension { ARB , uniform_buffer_object }
* @ requires_gles30 Uniform buffers are not available in OpenGL ES 2.0 .
* @ requires_webgl20 Uniform buffers are not available in WebGL 1.0 .
*/
MeshVisualizerGL3D & bindDrawBuffer ( GL : : Buffer & buffer ) ;
/**
* @ overload
* @ m_since_latest
*/
MeshVisualizerGL3D & bindDrawBuffer ( GL : : Buffer & buffer , GLintptr offset , GLsizeiptr size ) ;
/**
* @ brief Set a texture transformation uniform buffer for an object ID texture
* @ return Reference to self ( for method chaining )
* @ m_since_latest
*
* Expects that both @ ref Flag : : UniformBuffers and
* @ ref Flag : : TextureTransformation is set . The buffer is expected to
* contain @ ref drawCount ( ) instances of
* @ ref TextureTransformationUniform .
* @ requires_gl31 Extension @ gl_extension { ARB , uniform_buffer_object }
* @ requires_gles30 Uniform buffers are not available in OpenGL ES 2.0 .
* Object ID input requires integer support in shaders , which is
* not available in OpenGL ES 2.0 .
* @ requires_webgl20 Uniform buffers are not available in WebGL 1.0 .
* Object ID input requires integer support in shaders , which is
* not available in WebGL 1.0 .
*/
MeshVisualizerGL3D & bindTextureTransformationBuffer ( GL : : Buffer & buffer ) {
return static_cast < MeshVisualizerGL3D & > ( Implementation : : MeshVisualizerGLBase : : bindTextureTransformationBuffer ( buffer ) ) ;
}
/**
* @ overload
* @ m_since_latest
*/
MeshVisualizerGL3D & bindTextureTransformationBuffer ( GL : : Buffer & buffer , GLintptr offset , GLsizeiptr size ) {
return static_cast < MeshVisualizerGL3D & > ( Implementation : : MeshVisualizerGLBase : : bindTextureTransformationBuffer ( buffer , offset , size ) ) ;
}
/**
* @ brief Set a material uniform buffer
* @ return Reference to self ( for method chaining )
* @ m_since_latest
*
* Expects that @ ref Flag : : UniformBuffers is set . The buffer is
* expected to contain @ ref materialCount ( ) instances of
* @ ref MeshVisualizerMaterialUniform . At the very least you need to
* call also @ ref bindProjectionBuffer ( ) ,
* @ ref bindTransformationBuffer ( ) and @ ref bindDrawBuffer ( ) .
* @ requires_gl31 Extension @ gl_extension { ARB , uniform_buffer_object }
* @ requires_gles30 Uniform buffers are not available in OpenGL ES 2.0 .
* @ requires_webgl20 Uniform buffers are not available in WebGL 1.0 .
*/
MeshVisualizerGL3D & bindMaterialBuffer ( GL : : Buffer & buffer ) {
return static_cast < MeshVisualizerGL3D & > ( Implementation : : MeshVisualizerGLBase : : bindMaterialBuffer ( buffer ) ) ;
}
/**
* @ overload
* @ m_since_latest
*/
MeshVisualizerGL3D & bindMaterialBuffer ( GL : : Buffer & buffer , GLintptr offset , GLsizeiptr size ) {
return static_cast < MeshVisualizerGL3D & > ( Implementation : : MeshVisualizerGLBase : : bindMaterialBuffer ( buffer , offset , size ) ) ;
}
/**
* @ }
*/
# endif
/** @{
* @ name Texture binding
*/
# ifndef MAGNUM_TARGET_GLES2
/**
* @ brief Bind a color map texture
* @ return Reference to self ( for method chaining )
* @ m_since { 2020 , 06 }
*
* See also @ ref setColorMapTransformation ( ) . Expects that either
* @ ref Flag : : InstancedObjectId or @ ref Flag : : PrimitiveId /
* @ ref Flag : : PrimitiveIdFromVertexId is enabled .
* @ requires_gles30 Object ID visualization requires integer attributes
* while primitive ID visualization requires the ` gl_VertexID ` /
* ` gl_PrimitiveID ` builtins , neither of which is available in
* OpenGL ES 2.0 .
* @ requires_webgl20 Object ID visualization requires integer
* attributes while primitive ID visualization requires at least
* the ` gl_VertexID ` builtin , neither of which is available in
* WebGL 1.
*/
MeshVisualizerGL3D & bindColorMapTexture ( GL : : Texture2D & texture ) {
return static_cast < MeshVisualizerGL3D & > ( Implementation : : MeshVisualizerGLBase : : bindColorMapTexture ( texture ) ) ;
}
/**
* @ brief Bind an object ID texture
* @ return Reference to self ( for method chaining )
* @ m_since_latest
*
* Expects that the shader was created with @ ref Flag : : ObjectIdTexture
* enabled . If @ ref Flag : : TextureArrays is enabled as well , use
* @ ref bindObjectIdTexture ( GL : : Texture2DArray & ) instead . The texture
* needs to have an unsigned integer format .
* @ see @ ref setObjectId ( ) , @ ref Flag : : TextureTransformation ,
* @ ref setTextureMatrix ( )
* @ requires_gl30 Extension @ gl_extension { EXT , gpu_shader4 }
* @ requires_gles30 Object ID visualization requires integer support in
* shaders , which is not available in OpenGL ES 2.0 .
* @ requires_webgl20 Object ID visualization requires integer support
* in shaders , which is not available in WebGL 1.0 .
*/
MeshVisualizerGL3D & bindObjectIdTexture ( GL : : Texture2D & texture ) {
return static_cast < MeshVisualizerGL3D & > ( Implementation : : MeshVisualizerGLBase : : bindObjectIdTexture ( texture ) ) ;
}
/**
* @ brief Bind an object ID array texture
* @ return Reference to self ( for method chaining )
* @ m_since_latest
*
* Expects that the shader was created with both
* @ ref Flag : : ObjectIdTexture and @ ref Flag : : TextureArrays enabled . If
* @ ref Flag : : UniformBuffers is not enabled , the layer is set via
* @ ref setTextureLayer ( ) ; if @ ref Flag : : UniformBuffers is enabled ,
* @ ref Flag : : TextureTransformation has to be enabled as well and the
* layer is set via @ ref TextureTransformationUniform : : layer .
* @ see @ ref setObjectId ( ) , @ ref Flag : : TextureTransformation ,
* @ ref setTextureLayer ( )
* @ requires_gl30 Extension @ gl_extension { EXT , gpu_shader4 } and
* @ gl_extension { EXT , texture_array }
* @ requires_gles30 Object ID output requires integer support in
* shaders , which is not available in OpenGL ES 2.0 . Texture
* arrays are not available in OpenGL ES 2.0 .
* @ requires_webgl20 Object ID output requires integer support in
* shaders , which is not available in WebGL 1.0 . Texture arrays
* are not available in WebGL 1.0 .
*/
MeshVisualizerGL3D & bindObjectIdTexture ( GL : : Texture2DArray & texture ) {
return static_cast < MeshVisualizerGL3D & > ( Implementation : : MeshVisualizerGLBase : : bindObjectIdTexture ( texture ) ) ;
}
# endif
/**
* @ }
*/
MAGNUM_GL_ABSTRACTSHADERPROGRAM_SUBCLASS_DRAW_IMPLEMENTATION ( MeshVisualizerGL3D )
private :
/* Creates the GL shader program object but does nothing else.
Internal , used by compile ( ) . */
explicit MeshVisualizerGL3D ( NoInitT ) : Implementation : : MeshVisualizerGLBase { NoInit } { }
Int _transformationMatrixUniform { 9 } ,
_projectionMatrixUniform { 10 } ;
# if !defined(MAGNUM_TARGET_GLES2) && !defined(MAGNUM_TARGET_WEBGL)
Int _normalMatrixUniform { 11 } ,
_lineWidthUniform { 12 } ,
_lineLengthUniform { 13 } ;
# endif
} ;
/**
@ brief Configuration
@ m_since_latest
@ see @ ref MeshVisualizerGL3D ( const Configuration & ) ,
@ ref compile ( const Configuration & )
*/
class MeshVisualizerGL3D : : Configuration {
public :
explicit Configuration ( ) = default ;
/** @brief Flags */
Flags flags ( ) const { return _flags ; }
/**
* @ brief Set flags
*
* At least one of @ ref Flag : : Wireframe , @ ref Flag : : TangentDirection ,
* @ ref Flag : : BitangentFromTangentDirection ,
* @ ref Flag : : BitangentDirection , @ ref Flag : : NormalDirection ,
* @ ref Flag : : ObjectId , @ ref Flag : : VertexId , @ ref Flag : : PrimitiveId or
* @ ref Flag : : PrimitiveIdFromVertexId is expected to be enabled . No
* flags are set by default .
*/
Configuration & setFlags ( Flags flags ) {
_flags = flags ;
return * this ;
}
# ifndef MAGNUM_TARGET_GLES2
/** @brief Material count */
UnsignedInt materialCount ( ) const { return _materialCount ; }
/**
* @ brief Set material count
*
* If @ ref Flag : : UniformBuffers is set , describes size of a
* @ ref MeshVisualizerMaterialUniform buffer bound with
* @ ref bindMaterialBuffer ( ) ; as uniform buffers are required to have a
* statically defined size . The per - draw materials are then specified
* via @ ref MeshVisualizerDrawUniform3D : : materialId . Default value is
* @ cpp 1 @ ce .
*
* If @ ref Flag : : UniformBuffers isn ' t set , this value is ignored .
* @ see @ ref setFlags ( ) , @ ref setDrawCount ( )
* @ requires_gl31 Extension @ gl_extension { ARB , uniform_buffer_object }
* @ requires_gles30 Uniform buffers are not available in OpenGL ES 2.0 .
* @ requires_webgl20 Uniform buffers are not available in WebGL 1.0 .
*/
Configuration & setMaterialCount ( UnsignedInt materialCount ) {
_materialCount = materialCount ;
return * this ;
}
/** @brief Draw count */
UnsignedInt drawCount ( ) const { return _drawCount ; }
/**
* @ brief Set draw count
*
* If @ ref Flag : : UniformBuffers is set , describes size of a
* @ ref ProjectionUniform3D / @ ref TransformationUniform3D
* @ ref MeshVisualizerDrawUniform3D / @ ref TextureTransformationUniform
* buffer bound with @ ref bindProjectionBuffer ( ) ,
* @ ref bindTransformationBuffer ( ) , @ ref bindDrawBuffer ( ) and
* @ ref bindTextureTransformationBuffer ( ) ; as uniform buffers are
* required to have a statically defined size . The draw offset is then
* set via @ ref setDrawOffset ( ) . Default value is @ cpp 1 @ ce .
*
* If @ ref Flag : : UniformBuffers isn ' t set , this value is ignored .
* @ see @ ref setFlags ( ) , @ ref setMaterialCount ( )
* @ requires_gl31 Extension @ gl_extension { ARB , uniform_buffer_object }
* @ requires_gles30 Uniform buffers are not available in OpenGL ES 2.0 .
* @ requires_webgl20 Uniform buffers are not available in WebGL 1.0 .
*/
Configuration & setDrawCount ( UnsignedInt drawCount ) {
_drawCount = drawCount ;
return * this ;
}
# endif
private :
Flags _flags ;
# ifndef MAGNUM_TARGET_GLES2
UnsignedInt _materialCount = 1 ;
UnsignedInt _drawCount = 1 ;
# endif
} ;
/**
@ brief Asynchronous compilation state
@ m_since_latest
Returned by @ ref compile ( ) . See @ ref shaders - async for more information .
*/
class MeshVisualizerGL3D : : CompileState : public MeshVisualizerGL3D {
/* Everything deliberately private except for the inheritance */
friend class MeshVisualizerGL3D ;
explicit CompileState ( NoCreateT ) : MeshVisualizerGL3D { NoCreate } , _vert { NoCreate } , _frag { NoCreate } , _geom { NoCreate } { }
explicit CompileState ( MeshVisualizerGL3D & & shader , GL : : Shader & & vert , GL : : Shader & & frag , GL : : Shader * geom , GL : : Version version ) : MeshVisualizerGL3D { std : : move ( shader ) } , _vert { std : : move ( vert ) } , _frag { std : : move ( frag ) } , _geom { NoCreate } , _version { version } {
if ( geom ) _geom = Implementation : : GLShaderWrapper { std : : move ( * geom ) } ;
}
Implementation : : GLShaderWrapper _vert , _frag , _geom ;
GL : : Version _version ;
} ;
/** @debugoperatorclassenum{MeshVisualizerGL2D,MeshVisualizerGL2D::Flag} */
MAGNUM_SHADERS_EXPORT Debug & operator < < ( Debug & debug , MeshVisualizerGL2D : : Flag value ) ;
/** @debugoperatorclassenum{MeshVisualizerGL3D,MeshVisualizerGL3D::Flag} */
MAGNUM_SHADERS_EXPORT Debug & operator < < ( Debug & debug , MeshVisualizerGL3D : : Flag value ) ;
/** @debugoperatorclassenum{MeshVisualizerGL2D,MeshVisualizerGL2D::Flags} */
MAGNUM_SHADERS_EXPORT Debug & operator < < ( Debug & debug , MeshVisualizerGL2D : : Flags value ) ;
/** @debugoperatorclassenum{MeshVisualizerGL3D,MeshVisualizerGL3D::Flags} */
MAGNUM_SHADERS_EXPORT Debug & operator < < ( Debug & debug , MeshVisualizerGL3D : : Flags value ) ;
CORRADE_ENUMSET_OPERATORS ( MeshVisualizerGL2D : : Flags )
CORRADE_ENUMSET_OPERATORS ( MeshVisualizerGL3D : : Flags )
} }
# endif
