Mako 8.2.0 API
MakoCore SDK API Documentation
Loading...
Searching...
No Matches
JawsMako::CRenderSpec Class Reference

A base class that describes base rendering properties common to all rendering operations. Not intended to be used directly. Instead, use instances of one of the subclasses that matches the rendering need. More...

#include <jawsmako/renderspec.h>

Inheritance diagram for JawsMako::CRenderSpec:
[legend]

Public Types

enum  eBlackPreservation { eBPDefault = 0 , eBPOn = 1 , eBPOff = 2 }
 The possible types for enabling/controlling 100% black preservation. More...

Public Member Functions

 CRenderSpec ()
virtual ~CRenderSpec ()=default
void assignCommon (const CRenderSpec &other)

Public Attributes

IDOMColorSpacePtr processSpace
uint32 width
 The width, in pixels, of the result.
uint32 height
 The height, in pixels, of the result.
uint8 depth
 The depth, in bits (8 or 16), of the result.
FRect sourceRect
 The source area of the DOM that will be mapped to the output width and height.
uint8 aaFactor
 The aaFactor to be used. 1 means no anti-aliasing. The maximum value is 4.
bool alpha
 Whether or not alpha information should be produced.
CSpotColorNames retainedSpotColors
 Spot components to generate as distinct separations/channels.
CSpotColorNames ignoredSpotColors
 Spot components to ignore.
CSpotColorAliasVect aliasedSpotColors
 Spot colorant aliases. Please see CSpotColorAlias for further information.
CRenderPostProcessVect postProcesses
IOptionalContentPtr optionalContent
 The optional content object for the document.
eOptionalContentEvent optionalContentEvent
eRenderingIntent rgbImageRenderingIntent
eRenderingIntent cmykImageRenderingIntent
bool ignoreInputIccProfiles
CColorManagerConfigPtr overrideCmmConfig
 An optional CMM configuration override to apply to the given render.
bool use16BitInternalRendering
eBlackPreservation preserveBlackForText
 Whether or not to apply black preservation for text.
eBlackPreservation preserveBlackForOther
 Whether or not to apply black preservation for non-text objects.

Detailed Description

A base class that describes base rendering properties common to all rendering operations. Not intended to be used directly. Instead, use instances of one of the subclasses that matches the rendering need.

Member Enumeration Documentation

◆ eBlackPreservation

The possible types for enabling/controlling 100% black preservation.

100% black preservation preserves a 100% black output when rendering when enabled for certain solid colors.

A 100% black object is an object painted with one of the following colors:

  • 0 0 0 1 in any CMYK color space (including ICC)
  • 0 0 0 in any RGB color space (including ICC)
  • 0 in any Gray color space (including ICC)
  • 1 in a single channel DeviceN (aka Separation) Black color space
  • 1 in a multi-channel DeviceN color space where only the Black channel is set.

If black preservation applies then the resulting color will be either (depending on the target color space):

  • c m y 1 in any CMYK color space (including ICC)
  • 0 0 0 in any RGB color space (including ICC)
  • 0 in any Gray color space (including ICC)

Note that the CMY values in a CMYK result may not be zero if color managed white conversion would not produce pure white.

Note also that where transparency is involved this conversion only applies when converting to the blending color space, and has no further effect for further conversions.

May be enabled separately for text and vector art. Applies to only solid color brushes (IDOMSolidColorBrush) and uncolored tiling patterns only.

The default is set by IColorManager::setDefaultBlackPreservation(), which defaults to false.

Enumerator
eBPDefault 

Default behavior.

eBPOn 

Use black point compensation if applicable during color conversion.

eBPOff 

Do not use black point compensation during color conversion.

Constructor & Destructor Documentation

◆ CRenderSpec()

JawsMako::CRenderSpec::CRenderSpec ( )
inline

◆ ~CRenderSpec()

virtual JawsMako::CRenderSpec::~CRenderSpec ( )
virtualdefault

Member Function Documentation

◆ assignCommon()

void JawsMako::CRenderSpec::assignCommon ( const CRenderSpec & other)
inline

Member Data Documentation

◆ aaFactor

uint8 JawsMako::CRenderSpec::aaFactor

The aaFactor to be used. 1 means no anti-aliasing. The maximum value is 4.

◆ aliasedSpotColors

CSpotColorAliasVect JawsMako::CRenderSpec::aliasedSpotColors

Spot colorant aliases. Please see CSpotColorAlias for further information.

◆ alpha

bool JawsMako::CRenderSpec::alpha

Whether or not alpha information should be produced.

◆ cmykImageRenderingIntent

eRenderingIntent JawsMako::CRenderSpec::cmykImageRenderingIntent

The rendering intent to be used for cmyk images. If eRenderingIntentUnset, the DOM intent will be used.

◆ depth

uint8 JawsMako::CRenderSpec::depth

The depth, in bits (8 or 16), of the result.

◆ height

uint32 JawsMako::CRenderSpec::height

The height, in pixels, of the result.

◆ ignoredSpotColors

CSpotColorNames JawsMako::CRenderSpec::ignoredSpotColors

Spot components to ignore.

◆ ignoreInputIccProfiles

bool JawsMako::CRenderSpec::ignoreInputIccProfiles

If true, Gray, RGB and CMYK ICC profiles in the DOM will be ignored and instead be mapped to DeviceGray, DeviceRGB or DeviceCMYK as appropriate.

◆ optionalContent

IOptionalContentPtr JawsMako::CRenderSpec::optionalContent

The optional content object for the document.

◆ optionalContentEvent

eOptionalContentEvent JawsMako::CRenderSpec::optionalContentEvent

The type of optional content event to use when testing for the visibility of the optional content. If optionalContent is provided, this must not be eOCUnknown.

◆ overrideCmmConfig

CColorManagerConfigPtr JawsMako::CRenderSpec::overrideCmmConfig

An optional CMM configuration override to apply to the given render.

◆ postProcesses

CRenderPostProcessVect JawsMako::CRenderSpec::postProcesses

A chain of post processing operations to be performed once rendering to the process space is complete. This can include tone curves, device simulation, spot merging/spot overprint simulation and/or preview generation. Please see IPostProcessSpec for further information.

◆ preserveBlackForOther

eBlackPreservation JawsMako::CRenderSpec::preserveBlackForOther

Whether or not to apply black preservation for non-text objects.

◆ preserveBlackForText

eBlackPreservation JawsMako::CRenderSpec::preserveBlackForText

Whether or not to apply black preservation for text.

◆ processSpace

IDOMColorSpacePtr JawsMako::CRenderSpec::processSpace

The desired process color space for initial rendering. This describes the process space where compositing will occur

◆ retainedSpotColors

CSpotColorNames JawsMako::CRenderSpec::retainedSpotColors

Spot components to generate as distinct separations/channels.

◆ rgbImageRenderingIntent

eRenderingIntent JawsMako::CRenderSpec::rgbImageRenderingIntent

The rendering intent to be used for rgb images. If eRenderingIntentUnset, the DOM intent will be used.

◆ sourceRect

FRect JawsMako::CRenderSpec::sourceRect

The source area of the DOM that will be mapped to the output width and height.

◆ use16BitInternalRendering

bool JawsMako::CRenderSpec::use16BitInternalRendering

If true, Apex will use 16 bit buffers for all intermediate rendering, even if the final output depth is 8 bits per sample. This can be especially useful if there are many colour conversion steps or a significant amount of overdrawing transparency compositing required.

This has no effect for 16 bit rendering.

◆ width

uint32 JawsMako::CRenderSpec::width

The width, in pixels, of the result.


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