Struct RenderLayers 

pub struct RenderLayers(/* private fields */);

Defines which rendering layers an entity belongs to.

A camera renders an entity only when their render layers intersect.

The Default instance of RenderLayers contains layer 0, the first layer. Entities without this component also belong to layer 0.

An empty RenderLayers makes the entity invisible.

Implementations

impl RenderLayers

pub const fn layer(n: usize) -> RenderLayers

Create a new RenderLayers belonging to the given layer.

This const constructor is limited to size_of::<usize>() layers. If you need to support an arbitrary number of layers, use with or from_layers.

Examples found in repository

examples/2d/pixel_grid_snap.rs (line 22)

const PIXEL_PERFECT_LAYERS: RenderLayers = RenderLayers::layer(0);

/// Render layers for high-resolution rendering.
const HIGH_RES_LAYERS: RenderLayers = RenderLayers::layer(1);

examples/3d/order_independent_transparency.rs (line 33)

fn setup(
    mut commands: Commands,
    mut meshes: ResMut<Assets<Mesh>>,
    mut materials: ResMut<Assets<StandardMaterial>>,
) {
    // camera
    commands.spawn((
        Camera3d::default(),
        Transform::from_xyz(0.0, 0.0, 10.0).looking_at(Vec3::ZERO, Vec3::Y),
        // Add this component to this camera to render transparent meshes using OIT
        OrderIndependentTransparencySettings::default(),
        RenderLayers::layer(1),
        // Msaa currently doesn't work with OIT
        Msaa::Off,
    ));

    // light
    commands.spawn((
        PointLight {
            shadows_enabled: false,
            ..default()
        },
        Transform::from_xyz(4.0, 8.0, 4.0),
        RenderLayers::layer(1),
    ));

    // spawn help text
    commands.spawn((
        Text::default(),
        Node {
            position_type: PositionType::Absolute,
            top: px(12),
            left: px(12),
            ..default()
        },
        RenderLayers::layer(1),
        children![
            TextSpan::new("Press T to toggle OIT\n"),
            TextSpan::new("OIT Enabled"),
            TextSpan::new("\nPress C to cycle test scenes"),
        ],
    ));

    // spawn default scene
    spawn_spheres(&mut commands, &mut meshes, &mut materials);
}

fn toggle_oit(
    mut commands: Commands,
    text: Single<Entity, With<Text>>,
    keyboard_input: Res<ButtonInput<KeyCode>>,
    q: Single<(Entity, Has<OrderIndependentTransparencySettings>), With<Camera3d>>,
    mut text_writer: TextUiWriter,
) {
    if keyboard_input.just_pressed(KeyCode::KeyT) {
        let (e, has_oit) = *q;
        *text_writer.text(*text, 2) = if has_oit {
            // Removing the component will completely disable OIT for this camera
            commands
                .entity(e)
                .remove::<OrderIndependentTransparencySettings>();
            "OIT disabled".to_string()
        } else {
            // Adding the component to the camera will render any transparent meshes
            // with OIT instead of alpha blending
            commands
                .entity(e)
                .insert(OrderIndependentTransparencySettings::default());
            "OIT enabled".to_string()
        };
    }
}

fn cycle_scenes(
    mut commands: Commands,
    keyboard_input: Res<ButtonInput<KeyCode>>,
    mut meshes: ResMut<Assets<Mesh>>,
    mut materials: ResMut<Assets<StandardMaterial>>,
    q: Query<Entity, With<Mesh3d>>,
    mut scene_id: Local<usize>,
) {
    if keyboard_input.just_pressed(KeyCode::KeyC) {
        // despawn current scene
        for e in &q {
            commands.entity(e).despawn();
        }
        // increment scene_id
        *scene_id = (*scene_id + 1) % 2;
        // spawn next scene
        match *scene_id {
            0 => spawn_spheres(&mut commands, &mut meshes, &mut materials),
            1 => spawn_occlusion_test(&mut commands, &mut meshes, &mut materials),
            _ => unreachable!(),
        }
    }
}

/// Spawns 3 overlapping spheres
/// Technically, when using `alpha_to_coverage` with MSAA this particular example wouldn't break,
/// but it breaks when disabling MSAA and is enough to show the difference between OIT enabled vs disabled.
fn spawn_spheres(
    commands: &mut Commands,
    meshes: &mut Assets<Mesh>,
    materials: &mut Assets<StandardMaterial>,
) {
    let pos_a = Vec3::new(-1.0, 0.75, 0.0);
    let pos_b = Vec3::new(0.0, -0.75, 0.0);
    let pos_c = Vec3::new(1.0, 0.75, 0.0);

    let offset = Vec3::new(0.0, 0.0, 0.0);

    let sphere_handle = meshes.add(Sphere::new(2.0).mesh());

    let alpha = 0.25;

    let render_layers = RenderLayers::layer(1);

    commands.spawn((
        Mesh3d(sphere_handle.clone()),
        MeshMaterial3d(materials.add(StandardMaterial {
            base_color: RED.with_alpha(alpha).into(),
            alpha_mode: AlphaMode::Blend,
            ..default()
        })),
        Transform::from_translation(pos_a + offset),
        render_layers.clone(),
    ));
    commands.spawn((
        Mesh3d(sphere_handle.clone()),
        MeshMaterial3d(materials.add(StandardMaterial {
            base_color: GREEN.with_alpha(alpha).into(),
            alpha_mode: AlphaMode::Blend,
            ..default()
        })),
        Transform::from_translation(pos_b + offset),
        render_layers.clone(),
    ));
    commands.spawn((
        Mesh3d(sphere_handle.clone()),
        MeshMaterial3d(materials.add(StandardMaterial {
            base_color: BLUE.with_alpha(alpha).into(),
            alpha_mode: AlphaMode::Blend,
            ..default()
        })),
        Transform::from_translation(pos_c + offset),
        render_layers.clone(),
    ));
}

/// Spawn a combination of opaque cubes and transparent spheres.
/// This is useful to make sure transparent meshes drawn with OIT
/// are properly occluded by opaque meshes.
fn spawn_occlusion_test(
    commands: &mut Commands,
    meshes: &mut Assets<Mesh>,
    materials: &mut Assets<StandardMaterial>,
) {
    let sphere_handle = meshes.add(Sphere::new(1.0).mesh());
    let cube_handle = meshes.add(Cuboid::from_size(Vec3::ONE).mesh());
    let cube_material = materials.add(Color::srgb(0.8, 0.7, 0.6));

    let render_layers = RenderLayers::layer(1);

    // front
    let x = -2.5;
    commands.spawn((
        Mesh3d(cube_handle.clone()),
        MeshMaterial3d(cube_material.clone()),
        Transform::from_xyz(x, 0.0, 2.0),
        render_layers.clone(),
    ));
    commands.spawn((
        Mesh3d(sphere_handle.clone()),
        MeshMaterial3d(materials.add(StandardMaterial {
            base_color: RED.with_alpha(0.5).into(),
            alpha_mode: AlphaMode::Blend,
            ..default()
        })),
        Transform::from_xyz(x, 0., 0.),
        render_layers.clone(),
    ));

    // intersection
    commands.spawn((
        Mesh3d(cube_handle.clone()),
        MeshMaterial3d(cube_material.clone()),
        Transform::from_xyz(x, 0.0, 1.0),
        render_layers.clone(),
    ));
    commands.spawn((
        Mesh3d(sphere_handle.clone()),
        MeshMaterial3d(materials.add(StandardMaterial {
            base_color: RED.with_alpha(0.5).into(),
            alpha_mode: AlphaMode::Blend,
            ..default()
        })),
        Transform::from_xyz(0., 0., 0.),
        render_layers.clone(),
    ));

    // back
    let x = 2.5;
    commands.spawn((
        Mesh3d(cube_handle.clone()),
        MeshMaterial3d(cube_material.clone()),
        Transform::from_xyz(x, 0.0, -2.0),
        render_layers.clone(),
    ));
    commands.spawn((
        Mesh3d(sphere_handle.clone()),
        MeshMaterial3d(materials.add(StandardMaterial {
            base_color: RED.with_alpha(0.5).into(),
            alpha_mode: AlphaMode::Blend,
            ..default()
        })),
        Transform::from_xyz(x, 0., 0.),
        render_layers.clone(),
    ));
}

examples/camera/first_person_view_model.rs (line 134)

fn spawn_view_model(
    mut commands: Commands,
    mut meshes: ResMut<Assets<Mesh>>,
    mut materials: ResMut<Assets<StandardMaterial>>,
) {
    let arm = meshes.add(Cuboid::new(0.1, 0.1, 0.5));
    let arm_material = materials.add(Color::from(tailwind::TEAL_200));

    commands.spawn((
        Player,
        CameraSensitivity::default(),
        Transform::from_xyz(0.0, 1.0, 0.0),
        Visibility::default(),
        children![
            (
                WorldModelCamera,
                Camera3d::default(),
                Projection::from(PerspectiveProjection {
                    fov: 90.0_f32.to_radians(),
                    ..default()
                }),
            ),
            // Spawn view model camera.
            (
                Camera3d::default(),
                Camera {
                    // Bump the order to render on top of the world model.
                    order: 1,
                    ..default()
                },
                Projection::from(PerspectiveProjection {
                    fov: 70.0_f32.to_radians(),
                    ..default()
                }),
                // Only render objects belonging to the view model.
                RenderLayers::layer(VIEW_MODEL_RENDER_LAYER),
            ),
            // Spawn the player's right arm.
            (
                Mesh3d(arm),
                MeshMaterial3d(arm_material),
                Transform::from_xyz(0.2, -0.1, -0.25),
                // Ensure the arm is only rendered by the view model camera.
                RenderLayers::layer(VIEW_MODEL_RENDER_LAYER),
                // The arm is free-floating, so shadows would look weird.
                NotShadowCaster,
            ),
        ],
    ));
}

examples/camera/2d_on_ui.rs (line 27)

fn setup(mut commands: Commands, asset_server: Res<AssetServer>) {
    // The default camera. `IsDefaultUiCamera` makes this the default camera to render UI elements to. Alternatively, you can add the `UiTargetCamera` component to root UI nodes to define which camera they should be rendered to.
    commands.spawn((Camera2d, IsDefaultUiCamera));

    // The second camera. The higher order means that this camera will be rendered after the first camera. We will render to this camera to draw on top of the UI.
    commands.spawn((
        Camera2d,
        Camera {
            order: 1,
            // Don't draw anything in the background, to see the previous camera.
            clear_color: ClearColorConfig::None,
            ..default()
        },
        // This camera will only render entities which are on the same render layer.
        RenderLayers::layer(1),
    ));

    commands.spawn((
        // We could also use a `UiTargetCamera` component here instead of the general `IsDefaultUiCamera`.
        Node {
            width: percent(100),
            height: percent(100),
            display: Display::Flex,
            justify_content: JustifyContent::Center,
            align_items: AlignItems::Center,
            ..default()
        },
        BackgroundColor(tailwind::ROSE_400.into()),
        children![(
            Node {
                height: percent(30),
                width: percent(20),
                min_height: px(150),
                min_width: px(150),
                border: UiRect::all(px(2)),
                ..default()
            },
            BorderRadius::all(percent(25)),
            BorderColor::all(Color::WHITE),
        )],
    ));

    // This 2D object will be rendered on the second camera, on top of the default camera where the UI is rendered.
    commands.spawn((
        Sprite {
            image: asset_server.load("textures/rpg/chars/sensei/sensei.png"),
            custom_size: Some(Vec2::new(100., 100.)),
            ..default()
        },
        RenderLayers::layer(1),
    ));
}

examples/3d/render_to_texture.rs (line 43)

fn setup(
    mut commands: Commands,
    mut meshes: ResMut<Assets<Mesh>>,
    mut materials: ResMut<Assets<StandardMaterial>>,
    mut images: ResMut<Assets<Image>>,
) {
    // This is the texture that will be rendered to.
    let image = Image::new_target_texture(512, 512, TextureFormat::bevy_default());

    let image_handle = images.add(image);

    let cube_handle = meshes.add(Cuboid::new(4.0, 4.0, 4.0));
    let cube_material_handle = materials.add(StandardMaterial {
        base_color: Color::srgb(0.8, 0.7, 0.6),
        reflectance: 0.02,
        unlit: false,
        ..default()
    });

    // This specifies the layer used for the first pass, which will be attached to the first pass camera and cube.
    let first_pass_layer = RenderLayers::layer(1);

    // The cube that will be rendered to the texture.
    commands.spawn((
        Mesh3d(cube_handle),
        MeshMaterial3d(cube_material_handle),
        Transform::from_translation(Vec3::new(0.0, 0.0, 1.0)),
        FirstPassCube,
        first_pass_layer.clone(),
    ));

    // Light
    // NOTE: we add the light to both layers so it affects both the rendered-to-texture cube, and the cube on which we display the texture
    // Setting the layer to RenderLayers::layer(0) would cause the main view to be lit, but the rendered-to-texture cube to be unlit.
    // Setting the layer to RenderLayers::layer(1) would cause the rendered-to-texture cube to be lit, but the main view to be unlit.
    commands.spawn((
        PointLight::default(),
        Transform::from_translation(Vec3::new(0.0, 0.0, 10.0)),
        RenderLayers::layer(0).with(1),
    ));

    commands.spawn((
        Camera3d::default(),
        Camera {
            // render before the "main pass" camera
            order: -1,
            target: image_handle.clone().into(),
            clear_color: Color::WHITE.into(),
            ..default()
        },
        Transform::from_translation(Vec3::new(0.0, 0.0, 15.0)).looking_at(Vec3::ZERO, Vec3::Y),
        first_pass_layer,
    ));

    let cube_size = 4.0;
    let cube_handle = meshes.add(Cuboid::new(cube_size, cube_size, cube_size));

    // This material has the texture that has been rendered.
    let material_handle = materials.add(StandardMaterial {
        base_color_texture: Some(image_handle),
        reflectance: 0.02,
        unlit: false,
        ..default()
    });

    // Main pass cube, with material containing the rendered first pass texture.
    commands.spawn((
        Mesh3d(cube_handle),
        MeshMaterial3d(material_handle),
        Transform::from_xyz(0.0, 0.0, 1.5).with_rotation(Quat::from_rotation_x(-PI / 5.0)),
        MainPassCube,
    ));

    // The main pass camera.
    commands.spawn((
        Camera3d::default(),
        Transform::from_xyz(0.0, 0.0, 15.0).looking_at(Vec3::ZERO, Vec3::Y),
    ));
}

examples/window/multi_window_text.rs (line 49)

fn setup_scene(mut commands: Commands) {
    // The first camera; no render target is specified, its render target will be set to the primary window automatically.
    // This camera has no `RenderLayers` component, so it only renders entities belonging to render layer `0`.
    commands.spawn(Camera2d);

    // Spawn a second window
    let secondary_window = commands
        .spawn(Window {
            title: "Secondary Window".to_owned(),
            // Override the secondary window's scale factor and set it to double that of the primary window.
            // This means the second window's text will use glyphs drawn at twice the resolution of the primary window's text,
            // and they will be twice as big on screen.
            resolution: WindowResolution::default().with_scale_factor_override(2.),
            ..default()
        })
        .id();

    // Spawn a second camera
    let secondary_window_camera = commands
        .spawn((
            Camera2d,
            // This camera will only render entities belonging to render layer `1`.
            RenderLayers::layer(1),
            Camera {
                // Without an explicit render target, this camera would also target the primary window.
                target: RenderTarget::Window(WindowRef::Entity(secondary_window)),
                ..default()
            },
        ))
        .id();

    let node = Node {
        position_type: PositionType::Absolute,
        top: Val::Px(12.0),
        left: Val::Px(12.0),
        ..default()
    };

    let text_font = TextFont::from_font_size(30.);

    // UI nodes can only be rendered by one camera at a time and ignore `RenderLayers`.
    // This root UI node has no `UiTargetCamera` so `bevy_ui` will try to find a
    // camera with the `IsDefaultUiCamera` marker component. When that fails (neither
    // camera spawned here has an `IsDefaultUiCamera`), it queries for the
    // first camera targeting the primary window and uses that.
    commands.spawn(node.clone()).with_child((
        Text::new("UI Text Primary Window"),
        text_font.clone(),
        TextShadow::default(),
    ));

    commands
        .spawn((node, UiTargetCamera(secondary_window_camera)))
        .with_child((
            Text::new("UI Text Secondary Window"),
            text_font.clone(),
            TextShadow::default(),
        ));

    // `Text2d` belonging to render layer `0`.
    commands.spawn((
        Text2d::new("Text2d Primary Window"),
        TextColor(YELLOW.into()),
        text_font.clone(),
        Text2dShadow::default(),
    ));

    // `Text2d` belonging to render layer `1`.
    commands.spawn((
        Text2d::new("Text2d Secondary Window"),
        TextColor(YELLOW.into()),
        text_font.clone(),
        Text2dShadow::default(),
        RenderLayers::layer(1),
    ));

    // This `Text2d` entity belongs to both render layers `0` and `1`, so it will be rendered by both
    // cameras. A single text layout is generated per `Text2d` entity, targeting a specific scale
    // factor. Since the two camera's render targets have different scale factors, the text layout
    // will be generated using the higher scale factor (the secondary window's), and then downscaled when it is
    // drawn by the camera targeting the primary window.
    commands.spawn((
        Text2d::new("Text2d Both Windows"),
        TextColor(LIGHT_CYAN.into()),
        text_font,
        Text2dShadow::default(),
        RenderLayers::from_layers(&[0, 1]),
        Transform::from_xyz(0., -50., 0.),
    ));
}

pub const fn none() -> RenderLayers

Create a new RenderLayers that belongs to no layers.

This is distinct from RenderLayers::default, which belongs to the first layer.

pub fn from_layers(layers: &[usize]) -> RenderLayers

Create a RenderLayers from a list of layers.

Examples found in repository

examples/camera/first_person_view_model.rs (line 186)

fn spawn_lights(mut commands: Commands) {
    commands.spawn((
        PointLight {
            color: Color::from(tailwind::ROSE_300),
            shadows_enabled: true,
            ..default()
        },
        Transform::from_xyz(-2.0, 4.0, -0.75),
        // The light source illuminates both the world model and the view model.
        RenderLayers::from_layers(&[DEFAULT_RENDER_LAYER, VIEW_MODEL_RENDER_LAYER]),
    ));
}

examples/window/multi_window_text.rs (line 113)

fn setup_scene(mut commands: Commands) {
    // The first camera; no render target is specified, its render target will be set to the primary window automatically.
    // This camera has no `RenderLayers` component, so it only renders entities belonging to render layer `0`.
    commands.spawn(Camera2d);

    // Spawn a second window
    let secondary_window = commands
        .spawn(Window {
            title: "Secondary Window".to_owned(),
            // Override the secondary window's scale factor and set it to double that of the primary window.
            // This means the second window's text will use glyphs drawn at twice the resolution of the primary window's text,
            // and they will be twice as big on screen.
            resolution: WindowResolution::default().with_scale_factor_override(2.),
            ..default()
        })
        .id();

    // Spawn a second camera
    let secondary_window_camera = commands
        .spawn((
            Camera2d,
            // This camera will only render entities belonging to render layer `1`.
            RenderLayers::layer(1),
            Camera {
                // Without an explicit render target, this camera would also target the primary window.
                target: RenderTarget::Window(WindowRef::Entity(secondary_window)),
                ..default()
            },
        ))
        .id();

    let node = Node {
        position_type: PositionType::Absolute,
        top: Val::Px(12.0),
        left: Val::Px(12.0),
        ..default()
    };

    let text_font = TextFont::from_font_size(30.);

    // UI nodes can only be rendered by one camera at a time and ignore `RenderLayers`.
    // This root UI node has no `UiTargetCamera` so `bevy_ui` will try to find a
    // camera with the `IsDefaultUiCamera` marker component. When that fails (neither
    // camera spawned here has an `IsDefaultUiCamera`), it queries for the
    // first camera targeting the primary window and uses that.
    commands.spawn(node.clone()).with_child((
        Text::new("UI Text Primary Window"),
        text_font.clone(),
        TextShadow::default(),
    ));

    commands
        .spawn((node, UiTargetCamera(secondary_window_camera)))
        .with_child((
            Text::new("UI Text Secondary Window"),
            text_font.clone(),
            TextShadow::default(),
        ));

    // `Text2d` belonging to render layer `0`.
    commands.spawn((
        Text2d::new("Text2d Primary Window"),
        TextColor(YELLOW.into()),
        text_font.clone(),
        Text2dShadow::default(),
    ));

    // `Text2d` belonging to render layer `1`.
    commands.spawn((
        Text2d::new("Text2d Secondary Window"),
        TextColor(YELLOW.into()),
        text_font.clone(),
        Text2dShadow::default(),
        RenderLayers::layer(1),
    ));

    // This `Text2d` entity belongs to both render layers `0` and `1`, so it will be rendered by both
    // cameras. A single text layout is generated per `Text2d` entity, targeting a specific scale
    // factor. Since the two camera's render targets have different scale factors, the text layout
    // will be generated using the higher scale factor (the secondary window's), and then downscaled when it is
    // drawn by the camera targeting the primary window.
    commands.spawn((
        Text2d::new("Text2d Both Windows"),
        TextColor(LIGHT_CYAN.into()),
        text_font,
        Text2dShadow::default(),
        RenderLayers::from_layers(&[0, 1]),
        Transform::from_xyz(0., -50., 0.),
    ));
}

pub fn with(self, layer: usize) -> RenderLayers

Add the given layer.

This may be called multiple times to allow an entity to belong to multiple rendering layers.

Examples found in repository

examples/3d/render_to_texture.rs (line 61)

fn setup(
    mut commands: Commands,
    mut meshes: ResMut<Assets<Mesh>>,
    mut materials: ResMut<Assets<StandardMaterial>>,
    mut images: ResMut<Assets<Image>>,
) {
    // This is the texture that will be rendered to.
    let image = Image::new_target_texture(512, 512, TextureFormat::bevy_default());

    let image_handle = images.add(image);

    let cube_handle = meshes.add(Cuboid::new(4.0, 4.0, 4.0));
    let cube_material_handle = materials.add(StandardMaterial {
        base_color: Color::srgb(0.8, 0.7, 0.6),
        reflectance: 0.02,
        unlit: false,
        ..default()
    });

    // This specifies the layer used for the first pass, which will be attached to the first pass camera and cube.
    let first_pass_layer = RenderLayers::layer(1);

    // The cube that will be rendered to the texture.
    commands.spawn((
        Mesh3d(cube_handle),
        MeshMaterial3d(cube_material_handle),
        Transform::from_translation(Vec3::new(0.0, 0.0, 1.0)),
        FirstPassCube,
        first_pass_layer.clone(),
    ));

    // Light
    // NOTE: we add the light to both layers so it affects both the rendered-to-texture cube, and the cube on which we display the texture
    // Setting the layer to RenderLayers::layer(0) would cause the main view to be lit, but the rendered-to-texture cube to be unlit.
    // Setting the layer to RenderLayers::layer(1) would cause the rendered-to-texture cube to be lit, but the main view to be unlit.
    commands.spawn((
        PointLight::default(),
        Transform::from_translation(Vec3::new(0.0, 0.0, 10.0)),
        RenderLayers::layer(0).with(1),
    ));

    commands.spawn((
        Camera3d::default(),
        Camera {
            // render before the "main pass" camera
            order: -1,
            target: image_handle.clone().into(),
            clear_color: Color::WHITE.into(),
            ..default()
        },
        Transform::from_translation(Vec3::new(0.0, 0.0, 15.0)).looking_at(Vec3::ZERO, Vec3::Y),
        first_pass_layer,
    ));

    let cube_size = 4.0;
    let cube_handle = meshes.add(Cuboid::new(cube_size, cube_size, cube_size));

    // This material has the texture that has been rendered.
    let material_handle = materials.add(StandardMaterial {
        base_color_texture: Some(image_handle),
        reflectance: 0.02,
        unlit: false,
        ..default()
    });

    // Main pass cube, with material containing the rendered first pass texture.
    commands.spawn((
        Mesh3d(cube_handle),
        MeshMaterial3d(material_handle),
        Transform::from_xyz(0.0, 0.0, 1.5).with_rotation(Quat::from_rotation_x(-PI / 5.0)),
        MainPassCube,
    ));

    // The main pass camera.
    commands.spawn((
        Camera3d::default(),
        Transform::from_xyz(0.0, 0.0, 15.0).looking_at(Vec3::ZERO, Vec3::Y),
    ));
}

pub fn without(self, layer: usize) -> RenderLayers

Removes the given rendering layer.

pub fn iter(&self) -> impl Iterator<Item = usize>

Get an iterator of the layers.

pub fn intersects(&self, other: &RenderLayers) -> bool

Determine if a RenderLayers intersects another.

RenderLayerss intersect if they share any common layers.

A RenderLayers with no layers will not match any other RenderLayers, even another with no layers.

pub fn bits(&self) -> &[u64]

Get the bitmask representation of the contained layers.

pub fn intersection(&self, other: &RenderLayers) -> RenderLayers

Returns the set of layers shared by two instances of RenderLayers.

This corresponds to the self & other operation.

pub fn union(&self, other: &RenderLayers) -> RenderLayers

Returns all layers included in either instance of RenderLayers.

This corresponds to the self | other operation.

pub fn symmetric_difference(&self, other: &RenderLayers) -> RenderLayers

Returns all layers included in exactly one of the instances of RenderLayers.

This corresponds to the “exclusive or” (XOR) operation: self ^ other.

Trait Implementations

impl BitAnd for RenderLayers

type Output = RenderLayers

The resulting type after applying the & operator.

fn bitand(self, rhs: RenderLayers) -> <RenderLayers as BitAnd>::Output

Performs the & operation.

impl BitOr for RenderLayers

type Output = RenderLayers

The resulting type after applying the | operator.

fn bitor(self, rhs: RenderLayers) -> <RenderLayers as BitOr>::Output

Performs the | operation.

impl BitXor for RenderLayers

type Output = RenderLayers

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: RenderLayers) -> <RenderLayers as BitXor>::Output

Performs the ^ operation.

impl Clone for RenderLayers

fn clone(&self) -> RenderLayers

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Component for RenderLayers

where RenderLayers: 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, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

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 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]

impl Debug for RenderLayers

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for &RenderLayers

fn default() -> &RenderLayers

Returns the “default value” for a type.

impl Default for RenderLayers

fn default() -> RenderLayers

By default, this structure includes layer 0, which represents the first layer.

This is distinct from RenderLayers::none, which doesn’t belong to any layers.

impl FromArg for RenderLayers

type This<'from_arg> = RenderLayers

The type to convert into.

fn from_arg( arg: Arg<'_>, ) -> Result<<RenderLayers as FromArg>::This<'_>, ArgError>

Creates an item from an argument.

impl FromIterator<usize> for RenderLayers

fn from_iter<T>(i: T) -> RenderLayers

where T: IntoIterator<Item = usize>,

Creates a value from an iterator.

impl FromReflect for RenderLayers

fn from_reflect( reflect: &(dyn PartialReflect + 'static), ) -> Option<RenderLayers>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn PartialReflect>, ) -> Result<Self, Box<dyn PartialReflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetOwnership for RenderLayers

fn ownership() -> Ownership

Returns the ownership of Self.

impl GetTypeRegistration for RenderLayers

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl IntoReturn for RenderLayers

fn into_return<'into_return>(self) -> Return<'into_return>

where RenderLayers: 'into_return,

Converts Self into a Return value.

impl Ord for RenderLayers

fn cmp(&self, other: &RenderLayers) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for RenderLayers

fn eq(&self, other: &RenderLayers) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for RenderLayers

fn partial_cmp(&self, other: &RenderLayers) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialReflect for RenderLayers

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn try_apply( &mut self, value: &(dyn PartialReflect + 'static), ) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<RenderLayers>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<RenderLayers>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&(dyn Reflect + 'static)>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut (dyn Reflect + 'static)>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect(self: Box<RenderLayers>) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &(dyn PartialReflect + 'static)

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut (dyn PartialReflect + 'static)

Casts this type to a mutable, reflected value.

fn reflect_partial_eq( &self, value: &(dyn PartialReflect + 'static), ) -> Option<bool>

Returns a “partial equality” comparison result.

fn debug(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Debug formatter for the value.

fn reflect_clone(&self) -> Result<Box<dyn Reflect>, ReflectCloneError>

Attempts to clone Self using reflection.

fn apply(&mut self, value: &(dyn PartialReflect + 'static))

Applies a reflected value to this value.

fn to_dynamic(&self) -> Box<dyn PartialReflect>

Converts this reflected value into its dynamic representation based on its kind.

fn reflect_clone_and_take<T>(&self) -> Result<T, ReflectCloneError>

where T: 'static, Self: Sized + TypePath,

For a type implementing PartialReflect, combines reflect_clone and take in a useful fashion, automatically constructing an appropriate ReflectCloneError if the downcast fails.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Reflect for RenderLayers

fn into_any(self: Box<RenderLayers>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &(dyn Any + 'static)

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<RenderLayers>) -> Box<dyn Reflect>

Casts this type to a boxed, fully-reflected value.

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a fully-reflected value.

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

Casts this type to a mutable, fully-reflected value.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

impl TupleStruct for RenderLayers

fn field(&self, index: usize) -> Option<&(dyn PartialReflect + 'static)>

Returns a reference to the value of the field with index index as a &dyn Reflect.

fn field_mut( &mut self, index: usize, ) -> Option<&mut (dyn PartialReflect + 'static)>

Returns a mutable reference to the value of the field with index index as a &mut dyn Reflect.

fn field_len(&self) -> usize

Returns the number of fields in the tuple struct.

fn iter_fields(&self) -> TupleStructFieldIter<'_>

Returns an iterator over the values of the tuple struct’s fields.

fn to_dynamic_tuple_struct(&self) -> DynamicTupleStruct

Creates a new DynamicTupleStruct from this tuple struct.

fn get_represented_tuple_struct_info(&self) -> Option<&'static TupleStructInfo>

Will return None if TypeInfo is not available.

impl TypePath for RenderLayers

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for RenderLayers

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Eq for RenderLayers

impl StructuralPartialEq for RenderLayers