Theme.resample_environment_texture

property Theme.resample_environment_texture: bool | float

Set or return resampling environment texture.

Resample the environment texture when using set_environment_texture(). Set this to a float to set the sampling rate explicitly or set to True to down-sample the texture to 1/16 of its original resolution.

Down-sampling the texture can substantially improve performance for some environments, for example, headless setups or if GPU support is limited.

Added in version 0.45.

Changed in version 0.49: The image-based lighting textures are down-sampled at the same rate. See set_environment_texture() for details.

Examples

Download Python source code | Download Jupyter notebook

Enable resampling the environment texture globally.

>>> import pyvista as pv
>>> pv.global_theme.resample_environment_texture = True
>>> pv.global_theme.resample_environment_texture
True

Disable the resampling the environment texture.

>>> import pyvista as pv
>>> pv.global_theme.resample_environment_texture = False
>>> pv.global_theme.resample_environment_texture
False