Expand description
Clustered decals, bounding regions that project textures onto surfaces.
A clustered decal is a bounding box that projects a texture onto any surface within its bounds along the positive Z axis. In Bevy, clustered decals use the clustered forward rendering technique.
Clustered decals are the highest-quality types of decals that Bevy supports, but they require bindless textures. This means that they presently can’t be used on WebGL 2 or WebGPU. Bevy’s clustered decals can be used with forward or deferred rendering and don’t require a prepass.
On their own, clustered decals only project the base color of a texture. You
can, however, use the built-in tag field to customize the appearance of a
clustered decal arbitrarily. See the documentation in clustered.wgsl
for
more information and the clustered_decals
example for an example of use.
Structs§
- Clustered
Decal Plugin - A plugin that adds support for clustered decals.
- Decals
Buffer - A render-world resource that holds the buffer of
ClusteredDecal
s ready to upload to the GPU. - Render
Clustered Decal - The GPU data structure that stores information about each decal.
- Render
Clustered Decals - Stores information about all the clustered decals in the scene.
Functions§
- clustered_
decals_ are_ usable - Returns true if clustered decals are usable on the current platform or false otherwise.
- extract_
decals - Extracts decals from the main world into the render world.