Struct OrderIndependentTransparencyPlugin

pub struct OrderIndependentTransparencyPlugin;

A plugin that adds support for Order Independent Transparency (OIT). This can correctly render some scenes that would otherwise have artifacts due to alpha blending, but uses more memory.

To enable OIT for a camera you need to add the OrderIndependentTransparencySettings component to it.

If you want to use OIT for your custom material you need to call oit_draw(position, color) in your fragment shader. You also need to make sure that your fragment shader doesn’t output any colors.

Implementation details

This implementation uses 2 passes.

The first pass writes the depth and color of all the fragments to a big buffer. The buffer contains N layers for each pixel, where N can be set with OrderIndependentTransparencySettings::layer_count. This pass is essentially a forward pass.

The second pass is a single fullscreen triangle pass that sorts all the fragments then blends them together and outputs the result to the screen.

Trait Implementations

impl Plugin for OrderIndependentTransparencyPlugin

fn build(&self, app: &mut App)

Configures the App to which this plugin is added.

fn finish(&self, app: &mut App)

Finish adding this plugin to the App, once all plugins registered are ready. This can be useful for plugins that depends on another plugin asynchronous setup, like the renderer.

fn ready(&self, _app: &App) -> bool

Has the plugin finished its setup? This can be useful for plugins that need something asynchronous to happen before they can finish their setup, like the initialization of a renderer. Once the plugin is ready, finish should be called.

fn cleanup(&self, _app: &mut App)

Runs after all plugins are built and finished, but before the app schedule is executed. This can be useful if you have some resource that other plugins need during their build step, but after build you want to remove it and send it to another thread.

fn name(&self) -> &str

Configures a name for the Plugin which is primarily used for checking plugin uniqueness and debugging.

fn is_unique(&self) -> bool

If the plugin can be meaningfully instantiated several times in an App, override this method to return false.