HPS::Hardcopy Class Reference

#include <hps.h>

Classes

class  File
 
class  GDI
 

Public Types

enum  BackgroundPreference : uint32_t { BackgroundPreference::UseBackgroundColor, BackgroundPreference::ForceSolidWhite }
 
enum  RenderingAlgorithm : uint32_t { RenderingAlgorithm::TwoPassPrint, RenderingAlgorithm::SinglePassPrint }
 
enum  ResolutionUnits : uint32_t { ResolutionUnits::DPCM, ResolutionUnits::DPI, ResolutionUnits::DotsPerCentimeter = DPCM, ResolutionUnits::DotsPerInch = DPI }
 
enum  SizeUnits : uint32_t { SizeUnits::Centimeters, SizeUnits::Inches }
 

Detailed Description

The Hardcopy class attempts to reproduce the scene graph to each of its supported export types. This includes printing to physical paper and 2D PDF.

Default values for the various fields of the Hardcopy class can be found here.

Member Enumeration Documentation

◆ BackgroundPreference

enum HPS::Hardcopy::BackgroundPreference : uint32_t
strong

The Hardcopy::BackgroundPreference class is used to decide what the Hardcopy background looks like.

Enumerator
UseBackgroundColor 

The current scene background is exported to Hardcopy.

ForceSolidWhite 

The exported Hardcopy background will be white.

◆ RenderingAlgorithm

enum HPS::Hardcopy::RenderingAlgorithm : uint32_t
strong

The Hardcopy::RenderingOptions class is used to decide how the Hardcopy export will be conducted.

Enumerator
TwoPassPrint 

The default Hardcopy export. Two passes are used to ensure that vector data is as detailed as possible, while saving on file size by rendering non-vector data at lower resolution.

SinglePassPrint 

The Hardcopy export completes in a single pass. Non-vector data may take up large amount of space on disk. If your on-screen scene was rendered using the Priority HSRA, using SinglePassPrint is required in order for the Hardcopy export to be accurate.

◆ ResolutionUnits

enum HPS::Hardcopy::ResolutionUnits : uint32_t
strong

The Hardcopy::Resolution class is a concept class for hardcopy output-resolution-related enum classes.

Enumerator
DPCM 

Dots Per Centimeter.

DPI 

Dots Per Inch.

DotsPerCentimeter 

Dots Per Centimeter.

DotsPerInch 

Dots Per Inch.

◆ SizeUnits

enum HPS::Hardcopy::SizeUnits : uint32_t
strong

The Hardcopy::Size class is a concept class for hardcopy output-size-related enum classes.

Enumerator
Centimeters 

Centimeters.

Inches 

Inches.


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