{"id":15018006,"url":"https://github.com/ickshonpe/bevy_mod_ui_texture_atlas_image","last_synced_at":"2025-10-23T13:31:08.166Z","repository":{"id":60497178,"uuid":"543541333","full_name":"ickshonpe/bevy_mod_ui_texture_atlas_image","owner":"ickshonpe","description":"bevy plugin for displaying images from a texture atlas in the bevy UI","archived":false,"fork":false,"pushed_at":"2023-04-06T08:30:45.000Z","size":89,"stargazers_count":15,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-30T18:51:55.601Z","etag":null,"topics":["bevy","bevy-plugin","bevy-ui","game-development","rust"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ickshonpe.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-09-30T10:12:49.000Z","updated_at":"2024-09-29T02:28:56.000Z","dependencies_parsed_at":"2024-09-24T20:45:18.009Z","dependency_job_id":null,"html_url":"https://github.com/ickshonpe/bevy_mod_ui_texture_atlas_image","commit_stats":{"total_commits":40,"total_committers":2,"mean_commits":20.0,"dds":"0.025000000000000022","last_synced_commit":"e35c115d30f499457021d7d46f498c4954261e29"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ickshonpe%2Fbevy_mod_ui_texture_atlas_image","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ickshonpe%2Fbevy_mod_ui_texture_atlas_image/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ickshonpe%2Fbevy_mod_ui_texture_atlas_image/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ickshonpe%2Fbevy_mod_ui_texture_atlas_image/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ickshonpe","download_url":"https://codeload.github.com/ickshonpe/bevy_mod_ui_texture_atlas_image/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237834717,"owners_count":19373779,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bevy","bevy-plugin","bevy-ui","game-development","rust"],"created_at":"2024-09-24T19:51:18.637Z","updated_at":"2025-10-23T13:31:02.864Z","avatar_url":"https://github.com/ickshonpe.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# bevy_mod_ui_texture_atlas_image\n[![crates.io](https://img.shields.io/crates/v/bevy_mod_ui_texture_atlas_image)](https://crates.io/crates/bevy_mod_ui_texture_atlas_image)\n[![MIT/Apache 2.0](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](https://github.com/ickshonpe/bevy_mod_ui_texture_atlas_image)\n[![crates.io](https://img.shields.io/crates/d/bevy_mod_ui_texture_atlas_image)](https://crates.io/crates/bevy_mod_ui_texture_atlas_image)\n\nDraw images from texture atlases with the Bevy UI.\n\n![image](bevy_mod_ui_texture_atlas_image_long.png)\n\n* Versions 0.3 and 0.4 support Bevy 0.10\n* Version 0.2 supports Bevy 0.9\n* Version 0.1 supports Bevy 0.8\n#\n\n## Details\n\nTo use this crate, add its dependency to your project's `Cargo.toml`:\n\n```toml\nbevy_mod_ui_texture_atlas_image = \"0.3\"\n```\n\nor with Cargo:\n\n```\ncargo add bevy_mod_ui_texture_atlas_image\n```\n\n## Components\n* `UiAtlasImage`\n\n    The texture atlas image of the node.\n* `ImageTint`\n\n    The tint color of the image.\n\n## Bundles\n* `AtlasImageBundle`\n\n    The bundle of components needed to display an image from a `TextureAtlas` with the Bevy UI.\n\n## Plugin\nThe ```UiAtlasImagePlugin``` plugin must be added to your Bevy App:\n\n```rust\nuse bevy_mod_ui_texture_atlas_image::*;\n\nfn main () {\n    App::new()\n        .add_plugins(DefaultPlugins)\n        .add_plugin(UiAtlasImagePlugin)\n        // ..rest of app\n        .run()\n}\n```\n\nThen you can spawn an `AtlasImageBundle` to draw images from a `TextureAtlas` with the Bevy UI:\n```rust\ncommands\n    .spawn(AtlasImageBundle {\n        atlas_image: UiAtlasImage { \n            atlas: texture_atlas_handle.clone(),\n            index: 5\n        },\n        ..Default::default()\n    });\n```\nThe differences between an `AtlasImageBundle` and an `ImageBundle` are that \n* Instead of a `UiImage` component, `AtlasImageBundle` has a `UiAtlasImage` component that sets the image displayed by the node.\n* Instead of a `BackgroundColor` component, `AtlasImageBundle` has an `ImageTint` component that sets the color tint of the image.\n\n#\n### Examples\n\n* Displaying a single image from a texture atlas:\n    ``` \n    cargo --run --example minimal\n    ```\n* Displaying three tiles from a texture atlas grid alongside the atlas's source image:\n    ``` \n    cargo --run --example tiles\n    ```\n* Displaying images from a texture atlas with an alpha channel.\n    ```\n    cargo --run --example alpha\n    ```\n* Displaying images from a texture atlas with clipping.\n    ```\n    cargo --run --example clipped\n    ```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fickshonpe%2Fbevy_mod_ui_texture_atlas_image","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fickshonpe%2Fbevy_mod_ui_texture_atlas_image","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fickshonpe%2Fbevy_mod_ui_texture_atlas_image/lists"}