summaryrefslogtreecommitdiff
path: root/FL/Fl_SVG_Image.H
diff options
context:
space:
mode:
authorManoloFLTK <41016272+ManoloFLTK@users.noreply.github.com>2026-01-15 19:12:56 +0100
committerManoloFLTK <41016272+ManoloFLTK@users.noreply.github.com>2026-01-15 19:12:56 +0100
commitfbc3f7a69f9c639135a7c4310b08eb5342d4f22c (patch)
tree086dbc47c36c5ba82b67b6be8a6799211efdb56c /FL/Fl_SVG_Image.H
parent81c965f8e29c7b9fb68e9914d4223ab5fe293d1f (diff)
Improve documentation of member variable Fl_SVG_Image::proportional (#1361)
Diffstat (limited to 'FL/Fl_SVG_Image.H')
-rw-r--r--FL/Fl_SVG_Image.H5
1 files changed, 3 insertions, 2 deletions
diff --git a/FL/Fl_SVG_Image.H b/FL/Fl_SVG_Image.H
index a8a505928..a7e706cac 100644
--- a/FL/Fl_SVG_Image.H
+++ b/FL/Fl_SVG_Image.H
@@ -24,7 +24,7 @@ struct NSVGimage;
/** The Fl_SVG_Image class supports loading, caching and drawing of scalable vector graphics (SVG) images.
The FLTK library performs parsing and rasterization of SVG data using a modified version
of the \c nanosvg software (https://github.com/memononen/nanosvg).
- The software modification allows the option to change the image ratio
+ The software modification allows the option to change the aspect ratio
while performing rasterization.
Use Fl_Image::fail() to check if the Fl_SVG_Image failed to load. fail() returns ERR_FILE_ACCESS
@@ -33,7 +33,8 @@ struct NSVGimage;
Rasterization is not done until the image is first drawn or resize() or normalize() is called. Therefore,
\ref array is NULL until then. The delayed rasterization ensures an Fl_SVG_Image is always rasterized
- to the exact screen resolution at which it is drawn.
+ to the exact screen resolution at which it is drawn. Member \ref proportional of an Fl_SVG_Image object
+ must be set to \c false to allow this image to be rasterized with an altered aspect ratio.
The Fl_SVG_Image class draws images computed by \c nanosvg with the following known limitations