| spectre-document.h | | spectre-document.h | |
| | | | |
| skipping to change at line 130 | | skipping to change at line 130 | |
| unsigned int pag
e_index); | | unsigned int pag
e_index); | |
| | | | |
| /*! Returns a page of the document referenced by label. This function can f
ail | | /*! Returns a page of the document referenced by label. This function can f
ail | |
| @param document the document whose page will be returned | | @param document the document whose page will be returned | |
| @param label the label of the page to get. | | @param label the label of the page to get. | |
| @see spectre_document_status | | @see spectre_document_status | |
| */ | | */ | |
| SpectrePage *spectre_document_get_page_by_label (SpectreDocument *do
cument, | | SpectrePage *spectre_document_get_page_by_label (SpectreDocument *do
cument, | |
| const char *lab
el); | | const char *lab
el); | |
| | | | |
|
| | | /*! Convenient function for rendering documents with no pages, tipically ep | |
| | | s. | |
| | | When used with multi-page documents the first page will be rendered. | |
| | | @param document the document to render | |
| | | @rc the rendering context specifying how the document has to be rendere | |
| | | d | |
| | | @width the page width will be returned here, or NULL | |
| | | @height the page height will be returned here, or NULL | |
| | | @page_data a pointer that will point to the image data | |
| | | @row_length the length of an image row will be returned here | |
| | | @see spectre_document_render_full | |
| | | */ | |
| | | void spectre_document_render_full (SpectreDocument | |
| | | *document, | |
| | | SpectreRenderContext | |
| | | *rc, | |
| | | unsigned char | |
| | | **page_data, | |
| | | int | |
| | | *row_length); | |
| | | | |
| | | /*! Convenient function for rendering documents with no pages, tipically ep | |
| | | s. | |
| | | Document will be rendered with the default options, use spectre_documen | |
| | | t_render_full | |
| | | if you want to change any of them. | |
| | | When used with multi-page documents the first page will be rendered. | |
| | | @param document the document to render | |
| | | @width the page width will be returned here, or NULL | |
| | | @height the page height will be returned here, or NULL | |
| | | @page_data a pointer that will point to the image data | |
| | | @row_length the length of an image row will be returned here | |
| | | @see spectre_document_render_full | |
| | | */ | |
| | | void spectre_document_render (SpectreDocument | |
| | | *document, | |
| | | unsigned char | |
| | | **page_data, | |
| | | int | |
| | | *row_length); | |
| | | | |
| | | /* Convenient function for getting the page size of documents with no page | |
| | | s, tipically eps. | |
| | | When used with multi-page documents the size of the first page will be | |
| | | returned. | |
| | | @param document the document whose page will be returned | |
| | | @width the page width will be returned here, or NULL | |
| | | @height the page height will be returned here, or NULL | |
| | | */ | |
| | | void spectre_document_get_page_size (SpectreDocument | |
| | | *document, | |
| | | int | |
| | | *width, | |
| | | int | |
| | | *height); | |
| | | | |
| /*! Save document as filename. This function can fail | | /*! Save document as filename. This function can fail | |
| @param document the document that will be saved | | @param document the document that will be saved | |
| @param filename the path where document will be saved | | @param filename the path where document will be saved | |
| @see spectre_document_status | | @see spectre_document_status | |
| */ | | */ | |
| void spectre_document_save (SpectreDocument *do
cument, | | void spectre_document_save (SpectreDocument *do
cument, | |
| const char *fil
ename); | | const char *fil
ename); | |
| /* Save document as a pdf document. This function can fail | | /* Save document as a pdf document. This function can fail | |
| @param document the document that will be saved | | @param document the document that will be saved | |
| @param filename the path where document will be saved as pdf | | @param filename the path where document will be saved as pdf | |
| | | | |
End of changes. 1 change blocks. |
| 0 lines changed or deleted | | 56 lines changed or added | |
|
| spectre-page.h | | spectre-page.h | |
| | | | |
| skipping to change at line 68 | | skipping to change at line 68 | |
| /*! Returns the label of the page inside the document. | | /*! Returns the label of the page inside the document. | |
| @param page The page whose label will be returned | | @param page The page whose label will be returned | |
| */ | | */ | |
| const char *spectre_page_get_label (SpectrePage *page
); | | const char *spectre_page_get_label (SpectrePage *page
); | |
| | | | |
| /*! Returns the orientation of the page | | /*! Returns the orientation of the page | |
| @param page The page whose orientation will be returned | | @param page The page whose orientation will be returned | |
| */ | | */ | |
| SpectreOrientation spectre_page_get_orientation (SpectrePage *page
); | | SpectreOrientation spectre_page_get_orientation (SpectrePage *page
); | |
| | | | |
|
| /*! Returns the size of the page | | /*! Returns the size of the page. It always returns the page size according | |
| | | to | |
| | | the page bounding box without taking into account the page orientation. | |
| @param page The page whose size will be returned | | @param page The page whose size will be returned | |
|
| @param width The page width will be returned here | | @param width The page width will be returned here, or NULL | |
| @param height The page height will be returned here | | @param height The page height will be returned here, or NULL | |
| | | @see spectre_page_get_orientation | |
| */ | | */ | |
| void spectre_page_get_size (SpectrePage *page
, | | void spectre_page_get_size (SpectrePage *page
, | |
| int *width
, | | int *width
, | |
| int *heigh
t); | | int *heigh
t); | |
| | | | |
| /*! Renders the page to RGB32 format. This function can fail | | /*! Renders the page to RGB32 format. This function can fail | |
| @param page The page to renderer | | @param page The page to renderer | |
| @param rc The rendering context specifying how the page has to be rende
red | | @param rc The rendering context specifying how the page has to be rende
red | |
| @param page_data A pointer that will point to the image data | | @param page_data A pointer that will point to the image data | |
| if the call succeeds | | if the call succeeds | |
| @param row_length The length of an image row will be returned here. It
can | | @param row_length The length of an image row will be returned here. It
can | |
| happen that row_length is different than width * 4 | | happen that row_length is different than width * 4 | |
| @see spectre_page_status | | @see spectre_page_status | |
| */ | | */ | |
| void spectre_page_render (SpectrePage *page
, | | void spectre_page_render (SpectrePage *page
, | |
| SpectreRenderContext *rc, | | SpectreRenderContext *rc, | |
| unsigned char **page_
data, | | unsigned char **page_
data, | |
| int *row_l
ength); | | int *row_l
ength); | |
| | | | |
|
| | | /* ! Renders a rectangle of the page to RGB32 format. This function can fai | |
| | | l | |
| | | @param page The page to renderer | |
| | | @param rc The rendering context specifying how the page has to be rend | |
| | | ered | |
| | | @param x The X coordinate of the top left corner of the rectangle | |
| | | @param y The Y coordinate to the top left corner of the rectangle | |
| | | @param width The width of the rectangle | |
| | | @param height The height of the rectangle | |
| | | @param page_data A pointer that will point to the image data | |
| | | if the call succeeds | |
| | | @param row_length The length of an image row will be returned here. It | |
| | | can | |
| | | happen that row_length is different than width * 4 | |
| | | @see spectre_page_status | |
| | | */ | |
| | | void spectre_page_render_slice (SpectrePage *page | |
| | | , | |
| | | SpectreRenderContext *rc, | |
| | | int x, | |
| | | int y, | |
| | | int width | |
| | | , | |
| | | int heigh | |
| | | t, | |
| | | unsigned char **page_ | |
| | | data, | |
| | | int *row_l | |
| | | ength); | |
| | | | |
| SPECTRE_END_DECLS | | SPECTRE_END_DECLS | |
| | | | |
| #endif /* SPECTRE_PAGE_H */ | | #endif /* SPECTRE_PAGE_H */ | |
| | | | |
End of changes. 3 change blocks. |
| 3 lines changed or deleted | | 36 lines changed or added | |
|
| spectre-render-context.h | | spectre-render-context.h | |
| | | | |
| skipping to change at line 41 | | skipping to change at line 41 | |
| /*! Creates a rendering context */ | | /*! Creates a rendering context */ | |
| SpectreRenderContext *spectre_render_context_new (void); | | SpectreRenderContext *spectre_render_context_new (void); | |
| | | | |
| /*! Frees a rendering context | | /*! Frees a rendering context | |
| @param rc The rendering context to free | | @param rc The rendering context to free | |
| */ | | */ | |
| void spectre_render_context_free (Spectr
eRenderContext *rc); | | void spectre_render_context_free (Spectr
eRenderContext *rc); | |
| | | | |
| /*! Sets the scale. The default is 1 | | /*! Sets the scale. The default is 1 | |
| @param rc The rendering context to modify | | @param rc The rendering context to modify | |
|
| @param scale The scale to use when rendering. 2 is twice as big | | @param x_scale The scale factor for the X dimension to use when renderi | |
| | | ng. 2 is twice as big | |
| | | @param y_scale The scale factor for the Y dimension to use when renderi | |
| | | ng. 2 is twice as big | |
| */ | | */ | |
| void spectre_render_context_set_scale (Spectr
eRenderContext *rc, | | void spectre_render_context_set_scale (Spectr
eRenderContext *rc, | |
|
| double | | double | |
| scale); | | x_scale, | |
| | | double | |
| | | y_scale); | |
| | | | |
| /*! Gets the scale | | /*! Gets the scale | |
| @param rc The rendering context to query | | @param rc The rendering context to query | |
|
| | | @param x_scale The scale factor for the X dimension will be stored here | |
| | | , or NULL | |
| | | @param y_scale The scale factor for the Y dimension will be stored here | |
| | | , or NULL | |
| */ | | */ | |
|
| double spectre_render_context_get_scale (Spectr | | void spectre_render_context_get_scale (Spectr | |
| eRenderContext *rc); | | eRenderContext *rc, | |
| | | double | |
| | | *x_scale, | |
| | | double | |
| | | *y_scale); | |
| | | | |
| /*! Sets the rotation. The default is 0 | | /*! Sets the rotation. The default is 0 | |
| @param rc The rendering context to modify | | @param rc The rendering context to modify | |
| @param rotation The rotation to use when rendering. Usually 0, 90, 180
or 270 | | @param rotation The rotation to use when rendering. Usually 0, 90, 180
or 270 | |
| */ | | */ | |
| void spectre_render_context_set_rotation (Spectr
eRenderContext *rc, | | void spectre_render_context_set_rotation (Spectr
eRenderContext *rc, | |
| unsigne
d int rotation); | | unsigne
d int rotation); | |
| | | | |
| /*! Gets the rotation | | /*! Gets the rotation | |
| @param rc The rendering context to query | | @param rc The rendering context to query | |
| | | | |
| skipping to change at line 74 | | skipping to change at line 80 | |
| @param rc The rendering context to modify | | @param rc The rendering context to modify | |
| @param x_dpi the horizontal resolution to set | | @param x_dpi the horizontal resolution to set | |
| @param y_dpi the vertical resolution to set | | @param y_dpi the vertical resolution to set | |
| */ | | */ | |
| void spectre_render_context_set_resolution (Spectr
eRenderContext *rc, | | void spectre_render_context_set_resolution (Spectr
eRenderContext *rc, | |
| double
x_dpi, | | double
x_dpi, | |
| double
y_dpi); | | double
y_dpi); | |
| | | | |
| /*! Gets the resolution | | /*! Gets the resolution | |
| @param rc The rendering context to query | | @param rc The rendering context to query | |
|
| @param x_dpi the horizontal resolution will be stored here | | @param x_dpi the horizontal resolution will be stored here, or NULL | |
| @param y_dpi the vertical resolution will be stored here | | @param y_dpi the vertical resolution will be stored here, or NULL | |
| */ | | */ | |
| void spectre_render_context_get_resolution (Spectr
eRenderContext *rc, | | void spectre_render_context_get_resolution (Spectr
eRenderContext *rc, | |
| double
*x_dpi, | | double
*x_dpi, | |
| double
*y_dpi); | | double
*y_dpi); | |
| | | | |
|
| /*! Sets the page size in pixels | | /*! Sets the page size in pixels. Rotation shouldn't be considered, | |
| | | the page size will be automatically adjusted when rendering according | |
| | | to the rotation selected. Note that the page size doesn't affect the | |
| | | scale. If no page size is given the page bounding box will be used, | |
| | | or the rectangle given when using spectre_page_render_slice | |
| @param rc The rendering context to modify | | @param rc The rendering context to modify | |
| @param width the width of the page | | @param width the width of the page | |
| @param height the height of the page | | @param height the height of the page | |
| */ | | */ | |
| void spectre_render_context_set_page_size (Spectr
eRenderContext *rc, | | void spectre_render_context_set_page_size (Spectr
eRenderContext *rc, | |
| int
width, | | int
width, | |
| int
height); | | int
height); | |
| | | | |
| /*! Gets the page size in pixels | | /*! Gets the page size in pixels | |
| @param rc The rendering context to query | | @param rc The rendering context to query | |
|
| @param width the width of the page will be stored here | | @param width the width of the page will be stored here, or NULL | |
| @param height the height of the page will be stored here | | @param height the height of the page will be stored here, or NULL | |
| */ | | */ | |
| void spectre_render_context_get_page_size (Spectr
eRenderContext *rc, | | void spectre_render_context_get_page_size (Spectr
eRenderContext *rc, | |
| int
*width, | | int
*width, | |
| int
*height); | | int
*height); | |
| | | | |
| /*! Sets wheter to use the platform fonts when rendering or not. The defaul
t is TRUE | | /*! Sets wheter to use the platform fonts when rendering or not. The defaul
t is TRUE | |
| @param rc The rendering context to modify | | @param rc The rendering context to modify | |
| @param use_platform_fonts should platform fonts be used when rendering? | | @param use_platform_fonts should platform fonts be used when rendering? | |
| */ | | */ | |
| void spectre_render_context_set_use_platform_fonts (Spectr
eRenderContext *rc, | | void spectre_render_context_set_use_platform_fonts (Spectr
eRenderContext *rc, | |
| | | | |
End of changes. 7 change blocks. |
| 10 lines changed or deleted | | 27 lines changed or added | |
|