More docs on the predictor
This commit is contained in:
1 parent
a03eeccfe5
commit
3a6492f251
1 file changed
+5
-1
+5
-1
@@ -165,9 +165,13 @@ impl<W: Write + Seek, K: TiffKind> TiffEncoder<W, K> {
|
|||||||
/// A predictor is used to simplify the file before writing it. This is very
|
/// A predictor is used to simplify the file before writing it. This is very
|
||||||
/// useful when writing a file compressed using LZW or DEFLATE as it can improve compression ratio
|
/// useful when writing a file compressed using LZW or DEFLATE as it can improve compression ratio
|
||||||
///
|
///
|
||||||
|
/// The floating-point predictor is not universally supported. While most software can handle it,
|
||||||
|
/// Safari, Mac OS Preview and ImageJ Java library cannot. Don't use a predictor for float data
|
||||||
|
/// for maximum compatibility at the cost of compression ratio.
|
||||||
|
///
|
||||||
/// The chosen predictor should match the data type being encoded.
|
/// The chosen predictor should match the data type being encoded.
|
||||||
/// Encoding floating-point data with `Predictor::Horizontal` is technically possible,
|
/// Encoding floating-point data with `Predictor::Horizontal` is technically possible,
|
||||||
/// but the compression is less efficient, and some decoders may reject such files.
|
/// but rarely beneficial, and some decoders may reject such files.
|
||||||
pub fn with_predictor(mut self, predictor: Predictor) -> Self {
|
pub fn with_predictor(mut self, predictor: Predictor) -> Self {
|
||||||
self.predictor = predictor;
|
self.predictor = predictor;
|
||||||
|
|
||||||
|
|||||||
Reference in new issue
Block a user