include/opencascade/V3d_ImageDumpOptions.hxx

0001 // Copyright (c) 2016 OPEN CASCADE SAS
0002 //
0003 // This file is part of Open CASCADE Technology software library.
0004 //
0005 // This library is free software; you can redistribute it and/or modify it under
0006 // the terms of the GNU Lesser General Public License version 2.1 as published
0007 // by the Free Software Foundation, with special exception defined in the file
0008 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0009 // distribution for complete text of the license and disclaimer of any warranty.
0010 //
0011 // Alternatively, this file may be used under the terms of Open CASCADE
0012 // commercial license or contractual agreement.
0013
0014 #ifndef _V3d_ImageDumpOptions_HeaderFile
0015 #define _V3d_ImageDumpOptions_HeaderFile
0016
0017 #include <Graphic3d_BufferType.hxx>
0018 #include <V3d_StereoDumpOptions.hxx>
0019
0020 //! The structure defines options for image dump functionality.
0021 struct V3d_ImageDumpOptions
0022 {
0023
0024   Standard_Integer      Width;          //!< width  of image dump to allocate an image, 0 by default (meaning that image should be already allocated)
0025   Standard_Integer      Height;         //!< height of image dump to allocate an image, 0 by default (meaning that image should be already allocated)
0026   Graphic3d_BufferType  BufferType;     //!< which buffer to dump (color / depth), Graphic3d_BT_RGB by default
0027   V3d_StereoDumpOptions StereoOptions;  //!< dumping stereoscopic camera, V3d_SDO_MONO by default (middle-point monographic projection)
0028   Standard_Integer      TileSize;       //!< the view dimension limited for tiled dump, 0 by default (automatic tiling depending on hardware capabilities)
0029   Standard_Boolean      ToAdjustAspect; //!< flag to override active view aspect ratio by (Width / Height) defined for image dump (TRUE by default)
0030
0031 public:
0032
0033   //! Default constructor.
0034   V3d_ImageDumpOptions()
0035   : Width         (0),
0036     Height        (0),
0037     BufferType    (Graphic3d_BT_RGB),
0038     StereoOptions (V3d_SDO_MONO),
0039     TileSize      (0),
0040     ToAdjustAspect(Standard_True) {}
0041
0042 };
0043
0044 #endif // _V3d_ImageDumpOptions_HeaderFile