From 8bbbd4a99438c508f86718a046a4a640ad200df2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Fri, 4 Sep 2020 20:16:22 +0200 Subject: [PATCH] GL: document uselessness of certain polygon offsets for future me. I bet this is at least the fifth time I ran into this. And always immediately forgot after. --- src/Magnum/GL/Renderer.h | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/src/Magnum/GL/Renderer.h b/src/Magnum/GL/Renderer.h index af4d11fe5..434582b98 100644 --- a/src/Magnum/GL/Renderer.h +++ b/src/Magnum/GL/Renderer.h @@ -395,7 +395,9 @@ class MAGNUM_GL_EXPORT Renderer { #ifndef MAGNUM_TARGET_WEBGL /** - * Offset lines + * Offset lines. Note that this affects only filled polygons + * rendered with @ref setPolygonMode() set to + * @ref PolygonMode::Line, not actual line primitives. * @see @ref Feature::PolygonOffsetFill, @ref Feature::PolygonOffsetPoint, * @ref setPolygonOffset() * @requires_es_extension Extension @gl_extension{NV,polygon_offset} @@ -409,7 +411,9 @@ class MAGNUM_GL_EXPORT Renderer { #endif /** - * Offset points + * Offset points. Note that this affects only filled polygons + * rendered with @ref setPolygonMode() set to + * @ref PolygonMode::Point, not actual point primitives. * @see @ref Feature::PolygonOffsetFill, @ref Feature::PolygonOffsetLine, * @ref setPolygonOffset() * @requires_es_extension Extension @gl_extension{NV,polygon_offset}