package ccitt

Import Path
	golang.org/x/image/ccitt (on go.dev)

Dependency Relation
	imports 5 packages, and imported by one package

Involved Source Files

	  d reader.go
		Package ccitt implements a CCITT (fax) image decoder.

	    table.go
	    writer.go
Package-Level Type Names (total 3)

	/* sort by: alphabet | popularity */
	 type Options (struct)
		Options are optional parameters.

		Fields (total 2)
			Align bool
				Align means that some variable-bit-width codes are byte-aligned.

			Invert bool
				Invert means that black is the 1 bit or 0xFF byte, and white is 0.

		As Inputs Of (at least 2)
			func DecodeIntoGray(dst *image.Gray, r io.Reader, order Order, sf SubFormat, opts *Options) error
			func NewReader(r io.Reader, order Order, sf SubFormat, width int, height int, opts *Options) io.Reader

	 type Order uint32 (basic type)
		Order specifies the bit ordering in a CCITT data stream.

		As Inputs Of (at least 2)
			func DecodeIntoGray(dst *image.Gray, r io.Reader, order Order, sf SubFormat, opts *Options) error
			func NewReader(r io.Reader, order Order, sf SubFormat, width int, height int, opts *Options) io.Reader
		As Types Of (total 2)
			const LSB
			const MSB

	 type SubFormat uint32 (basic type)
		SubFormat represents that the CCITT format consists of a number of
		sub-formats. Decoding or encoding a CCITT data stream requires knowing the
		sub-format context. It is not represented in the data stream per se.

		As Inputs Of (at least 2)
			func DecodeIntoGray(dst *image.Gray, r io.Reader, order Order, sf SubFormat, opts *Options) error
			func NewReader(r io.Reader, order Order, sf SubFormat, width int, height int, opts *Options) io.Reader
		As Types Of (total 2)
			const Group3
			const Group4


Package-Level Functions (total 2)

	 func DecodeIntoGray(dst *image.Gray, r io.Reader, order Order, sf SubFormat, opts *Options) error
		DecodeIntoGray decodes the CCITT-formatted data in r into dst.
		
		It returns an error if dst's width and height don't match the implied width
		and height of CCITT-formatted data.

	 func NewReader(r io.Reader, order Order, sf SubFormat, width int, height int, opts *Options) io.Reader
		NewReader returns an io.Reader that decodes the CCITT-formatted data in r.
		The resultant byte stream is one bit per pixel (MSB first), with 1 meaning
		white and 0 meaning black. Each row in the result is byte-aligned.
		
		A negative height, such as passing AutoDetectHeight, means that the image
		height is not known in advance. A negative width is invalid.


Package-Level Constants (total 5)

	const AutoDetectHeight = -1
		AutoDetectHeight is passed as the height argument to NewReader to indicate
		that the image height (the number of rows) is not known in advance.

	const Group3 SubFormat = 0
	const Group4 SubFormat = 1
	const LSB Order = 0
		LSB means Least Significant Bits first.

	const MSB Order = 1
		MSB means Most Significant Bits first.

The pages are generated with Golds v0.8.7. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.