PTTiffOutputOptions

@interface PTTiffOutputOptions : NSObject

A class containing options for ToTiff functions

  • Creates an TiffOutputOptions object with default settings

    Declaration

    Objective-C

    - (instancetype)init;

    Swift

    init!()

  • Specifies the page box/region to rasterize. Possible values are media, crop, trim, bleed, and art. By default, page crop region will be rasterized.

    Declaration

    Objective-C

    - (void)SetBox:(PTBox)type;

    Swift

    func setBox(_ type: PTBox)

  • Rotates all pages by a given number of degrees counterclockwise. The allowed values are 0, 90, 180, and 270. The default value is 0.

    Declaration

    Objective-C

    - (void)SetRotate:(PTRotate)rotation;

    Swift

    func setRotate(_ rotation: PTRotate)

  • User definable clip box. By default, the clip region is identical to current page ‘box’.

    Declaration

    Objective-C

    - (void)SetClip:(double)x1 y1:(double)y1 x2:(double)x2 y2:(double)y2;

    Swift

    func setClip(_ x1: Double, y1: Double, x2: Double, y2: Double)

  • Specifies the list of pages to convert. “1” for only the first page. “1-5” for pages 1 to 5. “1, 5, 7” for pages 1, 5, and 7. “odd” for all odd pages. “even” for all even pages. By default, all pages are converted.

    Declaration

    Objective-C

    - (void)SetPages:(NSString *)page_desc;

    Swift

    func setPages(_ page_desc: String!)

  • Enable or disable support for overprint and overprint simulation. Overprint is a device dependent feature and the results will vary depending on the output color space and supported colorants (i.e. CMYK, CMYK+spot, RGB, etc). Default is e_op_pdfx_on.

    Declaration

    Objective-C

    - (void)SetOverprint:(PTOverprintPreviewMode)mode;

    Swift

    func setOverprint(_ mode: PTOverprintPreviewMode)

    Parameters

    op

    e_op_on: always enabled; e_op_off: always disabled; e_op_pdfx_on: enabled for PDF/X files only.

  • Render and export the image in CMYK mode. By default, the image is rendered and exported in RGB color space.

    Declaration

    Objective-C

    - (void)SetCMYK:(BOOL)enable;

    Swift

    func setCMYK(_ enable: Bool)

  • Enables dithering when the image is exported in palletized or monochrome mode.

    This option is disabled by default.

    Declaration

    Objective-C

    - (void)SetDither:(BOOL)enable;

    Swift

    func setDither(_ enable: Bool)

  • Render and export the image in grayscale mode. Sets pixel format to 8 bits per pixel grayscale. By default, the image is rendered and exported in RGB color space.

    Declaration

    Objective-C

    - (void)SetGray:(BOOL)enable;

    Swift

    func setGray(_ enable: Bool)

  • Export the rendered image as 1 bit per pixel (monochrome) image. The image will be compressed using G4 CCITT compression algorithm. By default, the image is not dithered. To enable dithering use ‘SetDither’ option. This option is disabled by default.

    Declaration

    Objective-C

    - (void)SetMono:(BOOL)enable;

    Swift

    func setMono(_ enable: Bool)

  • Enables or disables drawing of annotations.

    This option is enabled by default.

    Declaration

    Objective-C

    - (void)SetAnnots:(BOOL)enable;

    Swift

    func setAnnots(_ enable: Bool)

  • Enables or disables image smoothing (default: enabled).

    Declaration

    Objective-C

    - (void)SetSmooth:(BOOL)enable;

    Swift

    func setSmooth(_ enable: Bool)

  • Renders annotations in the print mode. This option can be used to render ‘Print Only’ annotations and to hide ‘Screen Only’ annotations.

    This option is disabled by default.

    Declaration

    Objective-C

    - (void)SetPrintmode:(BOOL)enable;

    Swift

    func setPrintmode(_ enable: Bool)

  • Sets the page color to transparent. By default, Convert assumes that the page is drawn directly on an opaque white surface. Some applications may need to draw the page on a different backdrop. In this case any pixels that are not covered during rendering will be transparent.

    This option is disabled by default.

    Declaration

    Objective-C

    - (void)SetTransparentPage:(BOOL)enable;

    Swift

    func setTransparentPage(_ enable: Bool)

  • Enabled the output of palettized TIFFs.

    This option is disabled by default.

    Declaration

    Objective-C

    - (void)SetPalettized:(BOOL)enable;

    Swift

    func setPalettized(_ enable: Bool)

  • The output resolution, from 1 to 1000, in Dots Per Inch (DPI). The higher the DPI, the larger the image. Resolutions larger than 1000 DPI can be achieved by rendering image in tiles or stripes. The default resolution is 92 DPI.

    Declaration

    Objective-C

    - (void)SetDPI:(double)dpi;

    Swift

    func setDPI(_ dpi: Double)

  • Sets the gamma factor used for anti-aliased rendering. Typical values are in the range from 0.1 to 3. Gamma correction can be used to improve the quality of anti-aliased image output and can (to some extent) decrease the appearance common anti-aliasing artifacts (such as pixel width lines between polygons). The default gamma is 0.

    Declaration

    Objective-C

    - (void)SetGamma:(double)gamma;

    Swift

    func setGamma(_ gamma: Double)

  • Sets the width of the output image, in pixels.

    Declaration

    Objective-C

    - (void)SetHRes:(int)hres;

    Swift

    func setHRes(_ hres: Int32)

  • Sets the height of the output image, in pixels.

    Declaration

    Objective-C

    - (void)SetVRes:(int)vres;

    Swift

    func setVRes(_ vres: Int32)