Struct IsDefaultUiCamera 

pub struct IsDefaultUiCamera;

Marker used to identify default cameras, they will have priority over the PrimaryWindow camera.

This is useful if the PrimaryWindow has two cameras, one of them used just for debug purposes and the user wants a way to choose the default Camera without having to add a UiTargetCamera to the root node.

Another use is when the user wants the Ui to be in another window by default, all that is needed is to place this component on the camera

fn spawn_camera(mut commands: Commands) {
    let another_window = commands.spawn(Window {
        title: String::from("Another window"),
        ..Default::default()
    }).id();
    commands.spawn((
        Camera2d,
        Camera {
            target: RenderTarget::Window(WindowRef::Entity(another_window)),
            ..Default::default()
        },
        // We add the Marker here so all Ui will spawn in
        // another window if no UiTargetCamera is specified
        IsDefaultUiCamera
    ));
}

Trait Implementations

impl Component for IsDefaultUiCamera

where IsDefaultUiCamera: 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]

impl Default for IsDefaultUiCamera

fn default() -> IsDefaultUiCamera

Returns the “default value” for a type.