pyvista.set_vtkwriter_mode

set_vtkwriter_mode(

vtk_writer: _VTKWriterType,

use_binary: bool = True,

compression: _CompressionOptions = 'zlib',

) → _VTKWriterType

Set any vtk writer to write as binary or ascii.

Parameters:

vtk_writer

The vtk writer instance to be configured. Must be one of vtkDataWriter, vtkPLYWriter, vtkSTLWriter, vtkXMLWriter.

use_binarybool, default: True

If True, the writer is set to write files in binary format. If False, the writer is set to write files in ASCII format.

compressionstr or None, default: ‘zlib’

The compression type to use when use_binary is True and vtk_writer is of type vtkXMLWriter. This argument has no effect otherwise. Acceptable values are 'zlib', 'lz4', 'lzma', and None. None indicates no compression.

Added in version 0.47.

Returns:

vtkDataWriter | vtkPLYWriter | vtkSTLWriter | vtkXMLWriter

The configured vtk writer instance.