From 23826183309ccf84e7b20798e3662aeadde43f37 Mon Sep 17 00:00:00 2001 From: kgv Date: Wed, 15 Aug 2018 21:08:00 +0300 Subject: [PATCH] 0030068: Documentation - V3d_View::ToPixMap() description should clarify that method will redraw the View content before dump --- src/V3d/V3d_View.hxx | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/src/V3d/V3d_View.hxx b/src/V3d/V3d_View.hxx index b705bee015..d0ec47a448 100644 --- a/src/V3d/V3d_View.hxx +++ b/src/V3d/V3d_View.hxx @@ -805,17 +805,21 @@ public: //! grid in Standard_EXPORT void SetGridActivity (const Standard_Boolean aFlag); - //! dump the full contents of the view at the same - //! scale in the file . The file name - //! extension must be one of ".png",".bmp",".jpg",".gif". - //! Returns FALSE when the dump has failed + //! Dumps the full contents of the View into the image file. This is an alias for ToPixMap() with Image_AlienPixMap. + //! @param theFile destination image file (image format is determined by file extension like .png, .bmp, .jpg) + //! @param theBufferType buffer to dump + //! @return FALSE when the dump has failed Standard_EXPORT Standard_Boolean Dump (const Standard_CString theFile, const Graphic3d_BufferType& theBufferType = Graphic3d_BT_RGB); //! Dumps the full contents of the view to a pixmap with specified parameters. + //! Internally this method calls Redraw() with an offscreen render buffer of requested target size (theWidth x theHeight), + //! so that there is no need resizing a window control for making a dump of different size. Standard_EXPORT Standard_Boolean ToPixMap (Image_PixMap& theImage, const V3d_ImageDumpOptions& theParams); //! Dumps the full contents of the view to a pixmap. + //! Internally this method calls Redraw() with an offscreen render buffer of requested target size (theWidth x theHeight), + //! so that there is no need resizing a window control for making a dump of different size. //! @param theImage target image, will be re-allocated to match theWidth x theHeight //! @param theWidth target image width //! @param theHeight target image height -- 2.20.1