From aaf5c60aaa96715e86e72b00bd93e429768528e8 Mon Sep 17 00:00:00 2001
From: Manolo Gouy <Manolo>
Date: Tue, 20 Mar 2018 17:23:08 +0000
Subject: Extend the doc of Fl_Image::scale() member function.

git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12780 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
---
 src/Fl_Image.cxx | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'src')

diff --git a/src/Fl_Image.cxx b/src/Fl_Image.cxx
index 8669d74f1..67dab574c 100644
--- a/src/Fl_Image.cxx
+++ b/src/Fl_Image.cxx
@@ -243,6 +243,8 @@ Fl_RGB_Scaling Fl_Image::RGB_scaling() {
  \param width,height   maximum width and height (in FLTK units) to use when drawing the image
  \param proportional   if not null, keep the width and height of the image proportional to those of the original size
  \param can_expand  if null, the width and height of the image will not exceed those of the original size
+ \note This function may change the values returned by the w() and h() member functions. In contrast,
+ the values returned by pixel_w() and pixel_h() remain unchanged after scale() was called.
  \version 1.4 (1.3.4 and FL_ABI_VERSION for Fl_Shared_Image only)
  
  Example code: scale an image to fit in a box
-- 
cgit v1.2.3