sw_htm_render_info Struct Reference

Render information passed to sw_htm_api::RenderInitiation() and sw_htm_api::DoHalftone(). More...

#include "swhtm.h"

Data Fields
sw_htm_coord	width
	The width of the output raster, in pixels.
sw_htm_coord	height
	The height of the output raster, in pixels.
unsigned int	src_bit_depth
	The number of bits per pixel for each channel in the source raster. More...
unsigned int	dst_bit_depth
	The number of bits per pixel for each channel in the destination raster.
int	msk_linebytes
	The number of bytes between consecutive lines of the mask raster. More...
int	src_linebytes
	The number of bytes between consecutive lines of the source raster. More...
int	dst_linebytes
	The number of bytes between consecutive lines of the destination raster. More...
HqBool	partial_paint
	Whether this render is a partial paint. More...
unsigned int	max_render_threads
	The maximum number of renderer threads the RIP will use. More...
unsigned int	job_number
	The ordinal job number of the job being rendered.
unsigned int	page_number
	The ordinal number of the page within the job. More...
unsigned int	src_values_per_component
	The number of color values for each component of the source raster.

Detailed Description

Render information passed to sw_htm_api::RenderInitiation() and sw_htm_api::DoHalftone().

Field Documentation

dst_linebytes

int sw_htm_render_info::dst_linebytes

The number of bytes between consecutive lines of the destination raster.

This is the number to add to the byte address of one line in order to get the byte address of the next line in the raster.

max_render_threads

unsigned int sw_htm_render_info::max_render_threads

The maximum number of renderer threads the RIP will use.

Note that the RIP may opt to use fewer than this, but will never use more.

msk_linebytes

int sw_htm_render_info::msk_linebytes

The number of bytes between consecutive lines of the mask raster.

This is the number to add to the byte address of one line in order to get the byte address of the next line in the raster.

page_number

unsigned int sw_htm_render_info::page_number

The ordinal number of the page within the job.

This is not necessarily the same as any document page number.

partial_paint

HqBool sw_htm_render_info::partial_paint

Whether this render is a partial paint.

If partial_paint is TRUE, the RIP is rendering the content of its display list so far, usually due to running out of memory. In extreme cases, several partial paints may occur before the final render which completes the page. During partial paint, very little memory is available (just a small amount the RIP keeps in reserve) so screening modules must avoid trying to allocate more for themselves.

src_bit_depth

unsigned int sw_htm_render_info::src_bit_depth

The number of bits per pixel for each channel in the source raster.

The same number will apply to any object properties map.

src_linebytes

int sw_htm_render_info::src_linebytes

The number of bytes between consecutive lines of the source raster.

This is the number to add to the byte address of one line in order to get the byte address of the next line in the raster.

The same number will apply to any object properties map.

---

The documentation for this struct was generated from the following file:

• lib/interface/swhtm.h