CAPS Universe documentation  1.0.4
All you need to know to be successful
Data Structures | Macros | Enumerations | Functions
libcapsraster-api.h File Reference

API declaration to render documents page by page. More...

Go to the source code of this file.

Data Structures

struct  caps_rstr_page_desc
 
struct  caps_rstr_page_limits
 Limits the rasterizer has when rasterizing the current document. More...
 
struct  caps_rstr_page
 Physical print medium description. More...
 
struct  caps_rstr_raster
 

Macros

#define LIBCAPSRASTER_MAJOR   1
 
#define LIBCAPSRASTER_MINOR   1
 
#define LIBCAPSRASTER_MICRO   0
 
#define FAV_ROTATION_NONE   (0)
 
#define FAV_ROTATION_COUNTERCLOCKWISE   (-90)
 
#define FAV_ROTATION_CLOCKWISE   (+90)
 

Enumerations

enum  caps_rstr_feature {
  CAPS_RSTR_NOTHING = 0 ,
  CAPS_RSTR_HW_COPY
}
 

Functions

void caps_libraster_version_get (unsigned *major, unsigned *minor, unsigned *micro)
 
const struct caps_supported_mime_listcaps_rstr_mime_list_get (void)
 
void caps_librstr_init (void)
 
struct caps_rasterizercaps_rstr_create (void)
 
void caps_rstr_destroy (struct caps_rasterizer *rstr)
 
int caps_rstr_job_attach (struct caps_rasterizer *rstr, int fd, struct caps_ppd_options_table *ppd_options, const char *params)
 
void caps_rstr_job_detach (struct caps_rasterizer *rstr)
 
struct caps_rstr_page_limits caps_rstr_limits_get (struct caps_rasterizer *rstr)
 
void caps_rstr_printer_feature_set (struct caps_rasterizer *rstr, enum caps_rstr_feature feature)
 
int caps_rstr_page_get_next (struct caps_rasterizer *rstr, const struct caps_rstr_page_desc **pg_desc)
 
int caps_rstr_page_rasterize (struct caps_rasterizer *rstr, const struct caps_rstr_page *pg)
 
int caps_rstr_raster_get (struct caps_rasterizer *rstr, struct caps_rstr_raster *desc)
 
const void * caps_rstr_line_get (struct caps_rasterizer *rstr, const struct caps_rstr_raster *desc, unsigned line_no)
 
const char * caps_rstr_job_mime_get (const struct caps_rasterizer *rstr)
 
bool caps_rstr_job_is_duplex (struct caps_rasterizer *rstr)
 
bool caps_rstr_job_is_collating (struct caps_rasterizer *rstr)
 
enum caps_ppd_color_formats caps_rstr_job_color_mode_get (struct caps_rasterizer *rstr)
 
const char * caps_rstr_job_medium_format_name_get (struct caps_rasterizer *rstr)
 
const struct caps_ppd_resolutioncaps_rstr_job_resolution_get (struct caps_rasterizer *rstr)
 
enum caps_ppd_paper_leading_edges caps_rstr_job_medium_orientation_get (struct caps_rasterizer *rstr)
 
struct caps_rect caps_rstr_job_medium_size_get (struct caps_rasterizer *rstr)
 
struct caps_area caps_rstr_job_medium_imageable_get (struct caps_rasterizer *rstr)
 
struct caps_area caps_rstr_job_medium_margins_get (struct caps_rasterizer *rstr)
 
unsigned caps_rstr_job_copies_get (struct caps_rasterizer *rstr)
 
const char * caps_rstr_job_value_get (struct caps_rasterizer *rstr, const char *keyword, const char *name)
 
const char * caps_rstr_job_choice_get (struct caps_rasterizer *rstr, const char *keyword)
 
const struct caps_job_progressioncaps_rstr_job_progression_get (struct caps_rasterizer *rstr)
 
const char * caps_rstr_format_name_get (const struct caps_rect *size)
 
struct caps_rect caps_rstr_format_size_get (const char *format_name)
 
int caps_rstr_format_validate (const char *format_name)
 
int caps_rstr_page_default_setup (struct caps_rasterizer *rstr, struct caps_rstr_page *pg)
 
int caps_rstr_predictive_size_get (struct caps_rasterizer *rstr, struct caps_rect size, struct caps_rect *psize)
 

Detailed Description

Author
Jürgen Borleis
Version
1.0.0
Warning
Use as experimental

Raw API to raster pages of a document and access the result. Used by the printer drivers or other convenience libraries.