Struct FancyCursor

pub struct FancyCursor<P = &'static str, Curs = UserCursor, Cam = UserCamera>
where
    P: Into<AssetPath<'static>> + Send + Sync + Clone + 'static,
    Curs: Component + Send + Sync + Clone + 'static,
    Cam: Component + Send + Sync + Clone + 'static,
{
    pub settings: Arc<CursorSettings<P, Curs, Cam>>,
}

Bevy plugin that “replaces” default cursor with one created from image.

Entity with Camera & Cam components must be spawned during startup before StartupStage::PostStartup, So remember to app.add_startup_system([system that spawns camera with Cam component]) .

Internally plugin uses Query<&Camera, With<Cam>> each frame and on startup to get camera rendering target. If that target isn’t bevy::render::camera::RenderTarget::Window, primary window will be used instead.

Fields

settings: Arc<CursorSettings<P, Curs, Cam>>

Implementations

impl<P, Curs, Cam> FancyCursor<P, Curs, Cam>

where P: Into<AssetPath<'static>> + Send + Sync + Clone + 'static, Curs: Component + Send + Sync + Clone + 'static, Cam: Component + Send + Sync + Clone + 'static,

pub fn create_setup( &self, ) -> impl Fn(ResMut<'_, Windows>, Res<'_, AssetServer>, Commands<'_, '_>, Query<'_, '_, &Camera, With<Cam>>)

pub fn create_update( &self, ) -> impl Fn(Res<'_, Windows>, Query<'_, '_, &Camera, With<Cam>>, Query<'_, '_, (&mut Style, &mut Visibility), With<Curs>>)

impl<P> FancyCursor<P>

where P: Into<AssetPath<'static>> + Send + Sync + Clone + 'static,

pub fn from_image(path: P) -> Self

Trait Implementations

impl<P, Curs, Cam> AsMut<Arc<CursorSettings<P, Curs, Cam>>> for FancyCursor<P, Curs, Cam>

where P: Into<AssetPath<'static>> + Send + Sync + Clone + 'static, Curs: Component + Send + Sync + Clone + 'static, Cam: Component + Send + Sync + Clone + 'static,

fn as_mut(&mut self) -> &mut Arc<CursorSettings<P, Curs, Cam>>

Converts this type into a mutable reference of the (usually inferred) input type.

impl<P, Curs, Cam> AsRef<Arc<CursorSettings<P, Curs, Cam>>> for FancyCursor<P, Curs, Cam>

where P: Into<AssetPath<'static>> + Send + Sync + Clone + 'static, Curs: Component + Send + Sync + Clone + 'static, Cam: Component + Send + Sync + Clone + 'static,

fn as_ref(&self) -> &Arc<CursorSettings<P, Curs, Cam>>

Converts this type into a shared reference of the (usually inferred) input type.

impl<P, Curs, Cam> Clone for FancyCursor<P, Curs, Cam>

where P: Into<AssetPath<'static>> + Send + Sync + Clone + 'static + Clone, Curs: Component + Send + Sync + Clone + 'static + Clone, Cam: Component + Send + Sync + Clone + 'static + Clone,

fn clone(&self) -> FancyCursor<P, Curs, Cam>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P, Curs, Cam> Debug for FancyCursor<P, Curs, Cam>

where P: Into<AssetPath<'static>> + Send + Sync + Clone + 'static + Debug, Curs: Component + Send + Sync + Clone + 'static + Debug, Cam: Component + Send + Sync + Clone + 'static + Debug,

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

Formats the value using the given formatter.

impl<P, Curs, Cam> Default for FancyCursor<P, Curs, Cam>

where P: Into<AssetPath<'static>> + Send + Sync + Clone + 'static + Default, Curs: Component + Send + Sync + Clone + 'static + Default, Cam: Component + Send + Sync + Clone + 'static + Default,

fn default() -> FancyCursor<P, Curs, Cam>

Returns the “default value” for a type.

impl<P, Curs, Cam> Deref for FancyCursor<P, Curs, Cam>

where P: Into<AssetPath<'static>> + Send + Sync + Clone + 'static, Curs: Component + Send + Sync + Clone + 'static, Cam: Component + Send + Sync + Clone + 'static,

type Target = Arc<CursorSettings<P, Curs, Cam>>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<P, Curs, Cam> DerefMut for FancyCursor<P, Curs, Cam>

where P: Into<AssetPath<'static>> + Send + Sync + Clone + 'static, Curs: Component + Send + Sync + Clone + 'static, Cam: Component + Send + Sync + Clone + 'static,

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<P, Curs, Cam> From<Arc<CursorSettings<P, Curs, Cam>>> for FancyCursor<P, Curs, Cam>

where P: Into<AssetPath<'static>> + Send + Sync + Clone + 'static, Curs: Component + Send + Sync + Clone + 'static, Cam: Component + Send + Sync + Clone + 'static,

fn from( original: Arc<CursorSettings<P, Curs, Cam>>, ) -> FancyCursor<P, Curs, Cam>

Converts to this type from the input type.

impl<P, Curs, Cam> From<CursorSettings<P, Curs, Cam>> for FancyCursor<P, Curs, Cam>

where P: Into<AssetPath<'static>> + Send + Sync + Clone + 'static, Curs: Component + Send + Sync + Clone + 'static, Cam: Component + Send + Sync + Clone + 'static,

fn from(settings: CursorSettings<P, Curs, Cam>) -> Self

Converts to this type from the input type.

impl<P, Curs, Cam> Plugin for FancyCursor<P, Curs, Cam>

where P: Into<AssetPath<'static>> + Send + Sync + Clone + 'static, Curs: Component + Send + Sync + Clone + 'static, Cam: Component + Send + Sync + Clone + 'static,

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

Configures the App to which this plugin is added.

fn name(&self) -> &str

Configures a name for the Plugin which is primarily used for debugging.

fn is_unique(&self) -> bool

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