
Classes | |
class | File |
class | GDI |
Public Types | |
enum | BackgroundPreference : uint { BackgroundPreference.UseBackgroundColor = 0x00000000, BackgroundPreference.ForceSolidWhite = 0x00000001 } |
The Hardcopy.BackgroundPreference class is used to decide what the Hardcopy background looks like. More... | |
enum | RenderingAlgorithm : uint { RenderingAlgorithm.TwoPassPrint = 0x00000000, RenderingAlgorithm.SinglePassPrint = 0x00000001 } |
The Hardcopy.RenderingOptions class is used to decide how the Hardcopy export will be conducted. More... | |
enum | ResolutionUnits : uint { ResolutionUnits.DPCM = 0x00000000, ResolutionUnits.DPI = 0x00000001, ResolutionUnits.DotsPerCentimeter = 0x00000000, ResolutionUnits.DotsPerInch = 0x00000001 } |
The Hardcopy.Resolution class is a concept class for hardcopy output-resolution-related enum classes. More... | |
enum | SizeUnits : uint { SizeUnits.Centimeters = 0x00000000, SizeUnits.Inches = 0x00000001 } |
The Hardcopy.Size class is a concept class for hardcopy output-size-related enum classes. More... | |
Public Member Functions | |
virtual void | Dispose () |
Hardcopy (HPS.Hardcopy in_that) | |
Protected Member Functions | |
virtual void | deleteCptr () |
Protected Attributes | |
bool | cMemOwn |
HandleRef | cptr |
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
enum HPS.Hardcopy.BackgroundPreference : uint |
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. |
enum HPS.Hardcopy.RenderingAlgorithm : uint |
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. |
enum HPS.Hardcopy.ResolutionUnits : uint |
enum HPS.Hardcopy.SizeUnits : uint |
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.Hardcopy.cs