fitz/separation.h

Index

typedef

• fz_separations

enum

• fz_separation_behavior

macro

• FZ_MAX_SEPARATIONS

function

• fz_add_separation
• fz_add_separation_equivalents
• fz_clone_separations_for_overprint
• fz_compare_separations
• fz_convert_separation_colors
• fz_count_active_separations
• fz_count_separations
• fz_drop_separations
• fz_keep_separations
• fz_new_separations
• fz_separation_current_behavior
• fz_separation_equivalent
• fz_separation_name
• fz_set_separation_behavior

Separation

macro FZ_MAX_SEPARATIONS

#define FZ_MAX_SEPARATIONS 64

A fz_separation structure holds details of a set of separations (such as might be used on within a page of the document).

The app might control the separations by enabling/disabling them, and subsequent renders would take this into account.

typedef fz_separations

typedef struct fz_separations fz_separations

enum fz_separation_behavior

enum fz_separation_behavior
{
        /* "Composite" separations are rendered using process
         * colors using the equivalent colors */
        FZ_SEPARATION_COMPOSITE = 0,
        /* Spot colors are rendered into their own spot plane. */
        FZ_SEPARATION_SPOT = 1,
        /* Disabled colors are not rendered at all in the final
         * output. */
        FZ_SEPARATION_DISABLED = 2
}

function fz_new_separations

fz_separations *
fz_new_separations (
        fz_context *ctx,
        int controllable
)

Create a new separations structure (initially empty)

function fz_keep_separations

fz_separations *
fz_keep_separations (
        fz_context *ctx,
        fz_separations *sep
)

Increment the reference count for a separations structure. Returns the same pointer.

Never throws exceptions.

function fz_drop_separations

void
fz_drop_separations (
        fz_context *ctx,
        fz_separations *sep
)

Decrement the reference count for a separations structure. When the reference count hits zero, the separations structure is freed.

Never throws exceptions.

function fz_add_separation

void
fz_add_separation (
        fz_context *ctx,
        fz_separations *sep,
        const char *name,
        fz_colorspace *cs,
        int cs_channel
)

Add a separation (null terminated name, colorspace)

function fz_add_separation_equivalents

void
fz_add_separation_equivalents (
        fz_context *ctx,
        fz_separations *sep,
        uint32_t rgba,
        uint32_t cmyk,
        const char *name
)

Add a separation with equivalents (null terminated name, colorspace)

(old, deprecated)

function fz_set_separation_behavior

void
fz_set_separation_behavior (
        fz_context *ctx,
        fz_separations *sep,
        int separation,
        fz_separation_behavior behavior
)

Control the rendering of a given separation.

function fz_separation_current_behavior

fz_separation_behavior
fz_separation_current_behavior (
        fz_context *ctx,
        const fz_separations *sep,
        int separation
)

Test for the current behavior of a separation.

function fz_separation_name

const char *
fz_separation_name (
        fz_context *ctx,
        const fz_separations *sep,
        int separation
)

function fz_count_separations

int
fz_count_separations (
        fz_context *ctx,
        const fz_separations *sep
)

function fz_count_active_separations

int
fz_count_active_separations (
        fz_context *ctx,
        const fz_separations *seps
)

Return the number of active separations.

function fz_compare_separations

int
fz_compare_separations (
        fz_context *ctx,
        const fz_separations *sep1,
        const fz_separations *sep2
)

Compare 2 separations structures (or NULLs).

Return 0 if identical, non-zero if not identical.

function fz_clone_separations_for_overprint

fz_separations *
fz_clone_separations_for_overprint (
        fz_context *ctx,
        fz_separations *seps
)

Return a separations object with all the spots in the input separations object that are set to composite, reset to be enabled. If there ARE no spots in the object, this returns NULL. If the object already has all its spots enabled, then just returns another handle on the same object.

function fz_convert_separation_colors

void
fz_convert_separation_colors (
        fz_context *ctx,
        fz_colorspace *src_cs,
        const float *src_color,
        fz_separations *dst_seps,
        fz_colorspace *dst_cs,
        float *dst_color,
        fz_color_params color_params
)

Convert a color given in terms of one colorspace, to a color in terms of another colorspace/separations.

function fz_separation_equivalent

void
fz_separation_equivalent (
        fz_context *ctx,
        const fz_separations *seps,
        int idx,
        fz_colorspace *dst_cs,
        float *dst_color,
        fz_colorspace *prf,
        fz_color_params color_params
)

Get the equivalent separation color in a given colorspace.