Struct ViewDepthPyramid

pub struct ViewDepthPyramid {
    pub all_mips: TextureView,
    pub mips: [TextureView; 12],
    pub mip_count: u32,
}

Stores a hierarchical Z-buffer for a view, which is a series of mipmaps useful for efficient occlusion culling.

This will only be present on a view when occlusion culling is enabled.

Fields

all_mips: TextureView

A texture view containing the entire depth texture.

mips: [TextureView; 12]

A series of texture views containing one mip level each.

mip_count: u32

The total number of mipmap levels.

This is the base-2 logarithm of the greatest dimension of the depth buffer, rounded up.

Implementations

impl ViewDepthPyramid

pub fn new( render_device: &RenderDevice, texture_cache: &mut TextureCache, depth_pyramid_dummy_texture: &TextureView, size: UVec2, texture_label: &'static str, texture_view_label: &'static str, ) -> ViewDepthPyramid

Allocates a new depth pyramid for a depth buffer with the given size.

pub fn create_bind_group<'a, R>( &'a self, render_device: &RenderDevice, label: &'static str, bind_group_layout: &BindGroupLayout, source_image: R, sampler: &'a Sampler, ) -> BindGroup

where R: IntoBinding<'a>,

Creates a bind group that allows the depth buffer to be attached to the downsample_depth.wgsl shader.

pub fn downsample_depth( &self, label: &str, render_context: &mut RenderContext<'_>, view_size: UVec2, downsample_depth_bind_group: &BindGroup, downsample_depth_first_pipeline: &ComputePipeline, downsample_depth_second_pipeline: &ComputePipeline, )

Invokes the shaders to generate the hierarchical Z-buffer.

This is intended to be invoked as part of a render node.

Trait Implementations

impl Component for ViewDepthPyramid

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have [Component<Mutability = Mutable>], while immutable components will instead have [Component<Mutability = Immutable>].

fn register_required_components( requiree: ComponentId, components: &mut ComponentsRegistrator<'_>, required_components: &mut RequiredComponents, inheritance_depth: u16, recursion_check_stack: &mut Vec<ComponentId>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn register_component_hooks(hooks: &mut ComponentHooks)

👎Deprecated since 0.16.0: Use the individual hook methods instead (e.g., Component::on_add, etc.)

Called when registering this component, allowing mutable access to its ComponentHooks.

fn on_add() -> Option<for<'w> fn(_: DeferredWorld<'w>, _: HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(_: DeferredWorld<'w>, _: HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_replace() -> Option<for<'w> fn(_: DeferredWorld<'w>, _: HookContext)>

Gets the on_replace ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(_: DeferredWorld<'w>, _: HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(_: DeferredWorld<'w>, _: HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]