Bug 854296, part 2 - Document Moz2D's JoinStyle::MITER to note that its behavior is backend dependant. r=Bas
authorJonathan Watt <jwatt@jwatt.org>
Tue, 16 Dec 2014 15:40:59 +0000
changeset 220185 83d940ea14917590f31278f63cae7c759902604b
parent 220184 91928ad7ef735af8898d6e00e658cbea62b21a9e
child 220186 23c386e2acdc8414a900604b3f484f9d6ed7434f
push id10457
push userryanvm@gmail.com
push dateThu, 18 Dec 2014 01:54:25 +0000
treeherderfx-team@0e441ff66c5e [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersBas
bugs854296
milestone37.0a1
Bug 854296, part 2 - Document Moz2D's JoinStyle::MITER to note that its behavior is backend dependant. r=Bas
gfx/2d/Types.h
--- a/gfx/2d/Types.h
+++ b/gfx/2d/Types.h
@@ -201,18 +201,20 @@ MOZ_BEGIN_ENUM_CLASS(PatternType, int8_t
   SURFACE,
   LINEAR_GRADIENT,
   RADIAL_GRADIENT
 MOZ_END_ENUM_CLASS(PatternType)
 
 MOZ_BEGIN_ENUM_CLASS(JoinStyle, int8_t)
   BEVEL,
   ROUND,
-  MITER,
-  MITER_OR_BEVEL
+  MITER, //!< Mitered if within the miter limit, else, if the backed supports
+         //!< it (D2D), the miter is clamped. If the backend does not support
+         //!< miter clamping the behavior is as for MITER_OR_BEVEL.
+  MITER_OR_BEVEL //!< Mitered if within the miter limit, else beveled.
 MOZ_END_ENUM_CLASS(JoinStyle)
 
 MOZ_BEGIN_ENUM_CLASS(CapStyle, int8_t)
   BUTT,
   ROUND,
   SQUARE
 MOZ_END_ENUM_CLASS(CapStyle)