Open CASCADE Technology  7.9.3
Public Member Functions | Data Fields
V3d_ImageDumpOptions Struct Reference

The structure defines options for image dump functionality. More...

#include <V3d_ImageDumpOptions.hxx>

Public Member Functions

 V3d_ImageDumpOptions ()
 Default constructor. More...
 

Data Fields

Standard_Integer Width
 Width of image dump to allocate an image, 0 by default (meaning that image should be already allocated). More...
 
Standard_Integer Height
 Height of image dump to allocate an image, 0 by default (meaning that image should be already allocated). More...
 
Graphic3d_BufferType BufferType
 Which buffer to dump (color / depth), Graphic3d_BT_RGB by default. More...
 
V3d_StereoDumpOptions StereoOptions
 Dumping stereoscopic camera, V3d_SDO_MONO by default (middle-point monographic projection). More...
 
Standard_Integer TileSize
 The view dimension limited for tiled dump, 0 by default (automatic tiling depending on hardware capabilities). More...
 
Standard_Boolean ToAdjustAspect
 Flag to override active view aspect ratio by (Width / Height) defined for image dump (TRUE by default). More...
 
Graphic3d_ZLayerId TargetZLayerId
 Target z layer id which defines the last layer to be drawn before image dump. More...
 
Standard_Boolean IsSingleLayer
 
Standard_CString LightName
 

Detailed Description

The structure defines options for image dump functionality.

Constructor & Destructor Documentation

V3d_ImageDumpOptions::V3d_ImageDumpOptions ( )
inline

Default constructor.

Field Documentation

Graphic3d_BufferType V3d_ImageDumpOptions::BufferType

Which buffer to dump (color / depth), Graphic3d_BT_RGB by default.

Standard_Integer V3d_ImageDumpOptions::Height

Height of image dump to allocate an image, 0 by default (meaning that image should be already allocated).

Standard_Boolean V3d_ImageDumpOptions::IsSingleLayer
Standard_CString V3d_ImageDumpOptions::LightName
V3d_StereoDumpOptions V3d_ImageDumpOptions::StereoOptions

Dumping stereoscopic camera, V3d_SDO_MONO by default (middle-point monographic projection).

Graphic3d_ZLayerId V3d_ImageDumpOptions::TargetZLayerId

Target z layer id which defines the last layer to be drawn before image dump.

Standard_Integer V3d_ImageDumpOptions::TileSize

The view dimension limited for tiled dump, 0 by default (automatic tiling depending on hardware capabilities).

Standard_Boolean V3d_ImageDumpOptions::ToAdjustAspect

Flag to override active view aspect ratio by (Width / Height) defined for image dump (TRUE by default).

Standard_Integer V3d_ImageDumpOptions::Width

Width of image dump to allocate an image, 0 by default (meaning that image should be already allocated).


The documentation for this struct was generated from the following file: