1 // Copyright (c) 2016 OPEN CASCADE SAS
3 // This file is part of Open CASCADE Technology software library.
5 // This library is free software; you can redistribute it and/or modify it under
6 // the terms of the GNU Lesser General Public License version 2.1 as published
7 // by the Free Software Foundation, with special exception defined in the file
8 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
9 // distribution for complete text of the license and disclaimer of any warranty.
11 // Alternatively, this file may be used under the terms of Open CASCADE
12 // commercial license or contractual agreement.
14 #ifndef _V3d_ImageDumpOptions_HeaderFile
15 #define _V3d_ImageDumpOptions_HeaderFile
17 #include <Graphic3d_BufferType.hxx>
18 #include <V3d_StereoDumpOptions.hxx>
20 //! The structure defines options for image dump functionality.
21 struct V3d_ImageDumpOptions
24 Standard_Integer Width; //!< width of image dump to allocate an image, 0 by default (meaning that image should be already allocated)
25 Standard_Integer Height; //!< height of image dump to allocate an image, 0 by default (meaning that image should be already allocated)
26 Graphic3d_BufferType BufferType; //!< which buffer to dump (color / depth), Graphic3d_BT_RGB by default
27 V3d_StereoDumpOptions StereoOptions; //!< dumping stereoscopic camera, V3d_SDO_MONO by default (middle-point monographic projection)
28 Standard_Integer TileSize; //!< the view dimension limited for tiled dump, 0 by default (automatic tiling depending on hardware capabilities)
29 Standard_Boolean ToAdjustAspect; //!< flag to override active view aspect ratio by (Width / Height) defined for image dump (TRUE by default)
33 //! Default constructor.
34 V3d_ImageDumpOptions()
37 BufferType (Graphic3d_BT_RGB),
38 StereoOptions (V3d_SDO_MONO),
40 ToAdjustAspect(Standard_True) {}
44 #endif // _V3d_ImageDumpOptions_HeaderFile