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 #include <Graphic3d_ZLayerId.hxx>
0020
0021 //! The structure defines options for image dump functionality.
0022 struct V3d_ImageDumpOptions
0023 {
0024
0025   // clang-format off
0026   int      Width;          //!< Width  of image dump to allocate an image, 0 by default (meaning that image should be already allocated).
0027   int      Height;         //!< Height of image dump to allocate an image, 0 by default (meaning that image should be already allocated).
0028   Graphic3d_BufferType  BufferType;     //!< Which buffer to dump (color / depth), Graphic3d_BT_RGB by default.
0029   V3d_StereoDumpOptions StereoOptions;  //!< Dumping stereoscopic camera, V3d_SDO_MONO by default (middle-point monographic projection).
0030   int      TileSize;       //!< The view dimension limited for tiled dump, 0 by default (automatic tiling depending on hardware capabilities).
0031   bool      ToAdjustAspect; //!< Flag to override active view aspect ratio by (Width / Height) defined for image dump (TRUE by default).
0032   Graphic3d_ZLayerId    TargetZLayerId; //!< Target z layer id which defines the last layer to be drawn before image dump.
0033   bool      IsSingleLayer;  //<! Flags if dumping is to be done to a single or to multiple layers.
0034   const char*      LightName;      //<! Name of the target light whose shadowmap is to be dumped.
0035   // clang-format on
0036
0037 public:
0038   //! Default constructor.
0039   V3d_ImageDumpOptions()
0040       : Width(0),
0041         Height(0),
0042         BufferType(Graphic3d_BT_RGB),
0043         StereoOptions(V3d_SDO_MONO),
0044         TileSize(0),
0045         ToAdjustAspect(true),
0046         TargetZLayerId(Graphic3d_ZLayerId_BotOSD),
0047         IsSingleLayer(false),
0048         LightName("")
0049   {
0050   }
0051 };
0052
0053 #endif // _V3d_ImageDumpOptions_HeaderFile