t4_tx_metadata_t Struct Reference

#include <t4_tx.h>

Public Attributes
int	compression
	The type of compression used on the wire.
int	image_type
	Image type - bi-level, gray, colour, etc.
int	width_code
	The width code for the image on the line side.
uint32_t	image_width
	The width of the current page on the wire, in pixels.
uint32_t	image_length
	The length of the current page on the wire, in pixels.
int	x_resolution
	Column-to-column (X) resolution in pixels per metre on the wire.
int	y_resolution
	Row-to-row (Y) resolution in pixels per metre on the wire.
int	resolution_code
	Code for the combined X and Y resolution on the wire.

Detailed Description

T.4 FAX compression metadata descriptor. This contains information about the image which may be relevant to the backend, but is not generally relevant to the image encoding process. The exception here is the y-resolution, which is used in T.4 2-D encoding for non-ECM applications, to optimise the balance of density and robustness.

Member Data Documentation

compression

int t4_tx_metadata_t::compression

The type of compression used on the wire.

Referenced by t4_tx_get_transfer_statistics(), t4_tx_get_tx_compression(), t4_tx_image_complete(), t4_tx_init(), t4_tx_set_max_2d_rows_per_1d_row(), t4_tx_set_min_bits_per_row(), t4_tx_set_tx_image_format(), and t4_tx_start_page().

image_length

uint32_t t4_tx_metadata_t::image_length

The length of the current page on the wire, in pixels.

Referenced by t4_tx_set_tx_image_format(), and t4_tx_start_page().

image_type

int t4_tx_metadata_t::image_type

Image type - bi-level, gray, colour, etc.

Referenced by t4_tx_get_transfer_statistics(), t4_tx_get_tx_image_type(), and t4_tx_set_tx_image_format().

image_width

uint32_t t4_tx_metadata_t::image_width

The width of the current page on the wire, in pixels.

Referenced by t4_tx_get_tx_image_width(), t4_tx_set_tx_image_format(), and t4_tx_start_page().

resolution_code

int t4_tx_metadata_t::resolution_code

Code for the combined X and Y resolution on the wire.

Referenced by t4_tx_get_tx_resolution(), and t4_tx_set_tx_image_format().

width_code

int t4_tx_metadata_t::width_code

The width code for the image on the line side.

Referenced by t4_tx_get_tx_image_width_code(), and t4_tx_set_tx_image_format().

x_resolution

int t4_tx_metadata_t::x_resolution

Column-to-column (X) resolution in pixels per metre on the wire.

Referenced by t4_tx_get_transfer_statistics(), t4_tx_get_tx_x_resolution(), and t4_tx_set_tx_image_format().

y_resolution

int t4_tx_metadata_t::y_resolution

Row-to-row (Y) resolution in pixels per metre on the wire.

Referenced by t4_tx_get_transfer_statistics(), t4_tx_get_tx_y_resolution(), and t4_tx_set_tx_image_format().

---

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

• private/t4_tx.h