OpenCascade/occt
1
0
Fork 0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-04-10 18:51:21 +03:00
Code

0030068: Documentation - V3d_View::ToPixMap() description should clarify that method will redraw the View content before dump

Browse Source
This commit is contained in:
kgv 2018-08-15 21:08:00 +03:00 committed by bugmaster
parent 343f7e4d34
commit 2382618330
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/V3d/V3d_View.hxx
View File

@ -805,17 +805,21 @@ public:
//! grid in <me>
Standard_EXPORT void SetGridActivity (const Standard_Boolean aFlag);
//! dump the full contents of the view at the same
//! scale in the file <theFile>. 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