pyvista.Renderer.enable_depth_peeling

Renderer.enable_depth_peeling(number_of_peels=None, occlusion_ratio=None)

Enable depth peeling to improve rendering of translucent geometry.

Parameters:

number_of_peelsint, optional

The maximum number of peeling layers. Initial value is 4 and is set in the pyvista.global_theme. A special value of 0 means no maximum limit. It has to be a positive value.

occlusion_ratiofloat, optional

The threshold under which the depth peeling algorithm stops to iterate over peel layers. This is the ratio of the number of pixels that have been touched by the last layer over the total number of pixels of the viewport area. Initial value is 0.0, meaning rendering has to be exact. Greater values may speed up the rendering with small impact on the quality.

Returns:

bool

If depth peeling is supported.