libspectre/spectre-page.h File Reference

#include <libspectre/spectre-macros.h>
#include <libspectre/spectre-status.h>
#include <libspectre/spectre-render-context.h>

Go to the source code of this file.

Typedefs
typedef struct SpectrePage	SpectrePage
Enumerations
enum	SpectreOrientation { SPECTRE_ORIENTATION_PORTRAIT, SPECTRE_ORIENTATION_REVERSE_LANDSCAPE, SPECTRE_ORIENTATION_REVERSE_PORTRAIT, SPECTRE_ORIENTATION_LANDSCAPE }
Functions
SpectreStatus	spectre_page_status (SpectrePage *page)
void	spectre_page_free (SpectrePage *page)
unsigned int	spectre_page_get_index (SpectrePage *page)
const char *	spectre_page_get_label (SpectrePage *page)
SpectreOrientation	spectre_page_get_orientation (SpectrePage *page)
void	spectre_page_get_size (SpectrePage *page, int *width, int *height)
void	spectre_page_render (SpectrePage *page, SpectreRenderContext *rc, unsigned char **page_data, int *row_length)
void	spectre_page_render_slice (SpectrePage *page, SpectreRenderContext *rc, int x, int y, int width, int height, unsigned char **page_data, int *row_length)

---

Typedef Documentation

typedef struct SpectrePage SpectrePage

This is the object that represents a page of a PostScript document. They can not be created directly and can only be obtained from spectre_document_get_page

---

Enumeration Type Documentation

enum SpectreOrientation

Enumerator:

SPECTRE_ORIENTATION_PORTRAIT	Vertical orientation
SPECTRE_ORIENTATION_REVERSE_LANDSCAPE	Inverse horizontal orientation, also known as Seascape
SPECTRE_ORIENTATION_REVERSE_PORTRAIT	Inverse vertical orientation
SPECTRE_ORIENTATION_LANDSCAPE	Horizontal orientation

---

Function Documentation

void spectre_page_free

(

SpectrePage *

page

)

Frees the memory of the given page

Parameters:

page

The page whose memory will be freed

unsigned int spectre_page_get_index

(

SpectrePage *

page

)

Returns the index of the page inside the document. First page has index 0

Parameters:

page

The page whose index will be returned

const char* spectre_page_get_label

(

SpectrePage *

page

)

Returns the label of the page inside the document.

Parameters:

page

The page whose label will be returned

SpectreOrientation spectre_page_get_orientation

(

SpectrePage *

page

)

Returns the orientation of the page

Parameters:

page

The page whose orientation will be returned

void spectre_page_get_size	(	SpectrePage *	page,
		int *	width,
		int *	height
	)

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.

Parameters:

	page	The page whose size will be returned
	width	The page width will be returned here, or NULL
	height	The page height will be returned here, or NULL

See also:

spectre_page_get_orientation

void spectre_page_render	(	SpectrePage *	page,
		SpectreRenderContext *	rc,
		unsigned char **	page_data,
		int *	row_length
	)

Renders the page to RGB32 format. This function can fail

Parameters:

	page	The page to renderer
	rc	The rendering context specifying how the page has to be rendered
	page_data	A pointer that will point to the image data if the call succeeds
	row_length	The length of an image row will be returned here. It can happen that row_length is different than width * 4

See also:

spectre_page_status

void spectre_page_render_slice	(	SpectrePage *	page,
		SpectreRenderContext *	rc,
		int	x,
		int	y,
		int	width,
		int	height,
		unsigned char **	page_data,
		int *	row_length
	)

SpectreStatus spectre_page_status

(

SpectrePage *

page

)

Returns the status of the given page

Parameters:

page

The page whose status will be returned

---