Open CASCADE Technology  7.3.0
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...
 

Detailed Description

The structure defines options for image dump functionality.

Constructor & Destructor Documentation

◆ V3d_ImageDumpOptions()

V3d_ImageDumpOptions::V3d_ImageDumpOptions ( )
inline

Default constructor.

Field Documentation

◆ BufferType

Graphic3d_BufferType V3d_ImageDumpOptions::BufferType

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

◆ Height

Standard_Integer V3d_ImageDumpOptions::Height

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

◆ StereoOptions

V3d_StereoDumpOptions V3d_ImageDumpOptions::StereoOptions

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

◆ TileSize

Standard_Integer V3d_ImageDumpOptions::TileSize

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

◆ ToAdjustAspect

Standard_Boolean V3d_ImageDumpOptions::ToAdjustAspect

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

◆ Width

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: