mirror of
https://github.com/emilk/egui.git
synced 2026-06-28 07:23:13 -04:00
cd45d18615
<!-- Please read the "Making a PR" section of [`CONTRIBUTING.md`](https://github.com/emilk/egui/blob/master/CONTRIBUTING.md) before opening a Pull Request! * Keep your PR:s small and focused. * The PR title is what ends up in the changelog, so make it descriptive! * If applicable, add a screenshot or gif. * If it is a non-trivial addition, consider adding a demo for it to `egui_demo_lib`, or a new example. * Do NOT open PR:s from your `master` branch, as that makes it hard for maintainers to add commits to your PR. * Remember to run `cargo fmt` and `cargo clippy`. * Open the PR as a draft until you have self-reviewed it and run `./scripts/check.sh`. * When you have addressed a PR comment, mark it as resolved. Please be patient! I will review your PR, but my time is limited! --> Related to #3482 Not sure what the "best practice" is, to me it seems like one should import from "the original location" if possible, but now it should at least be possible to not re-export ahash without any breakage in the egui code base (but possibly in projects using egui, so one should probably deprecate it if one would like to go that path). It also seems like epaint re-exports ahash.
259 lines
7.4 KiB
TOML
259 lines
7.4 KiB
TOML
[package]
|
|
name = "eframe"
|
|
version.workspace = true
|
|
authors = ["Emil Ernerfeldt <emil.ernerfeldt@gmail.com>"]
|
|
description = "egui framework - write GUI apps that compiles to web and/or natively"
|
|
edition.workspace = true
|
|
rust-version.workspace = true
|
|
homepage = "https://github.com/emilk/egui/tree/master/crates/eframe"
|
|
license.workspace = true
|
|
readme = "README.md"
|
|
repository = "https://github.com/emilk/egui/tree/master/crates/eframe"
|
|
categories = ["gui", "game-development"]
|
|
keywords = ["egui", "gui", "gamedev"]
|
|
include = [
|
|
"../LICENSE-APACHE",
|
|
"../LICENSE-MIT",
|
|
"**/*.rs",
|
|
"Cargo.toml",
|
|
"data/icon.png",
|
|
]
|
|
|
|
[package.metadata.docs.rs]
|
|
all-features = true
|
|
rustc-args = ["--cfg=web_sys_unstable_apis"]
|
|
targets = ["x86_64-unknown-linux-gnu", "wasm32-unknown-unknown"]
|
|
|
|
[lints]
|
|
workspace = true
|
|
|
|
[lib]
|
|
|
|
|
|
[features]
|
|
default = [
|
|
"accesskit",
|
|
"default_fonts",
|
|
"glow",
|
|
"wayland",
|
|
"web_screen_reader",
|
|
"winit/default",
|
|
"x11",
|
|
]
|
|
|
|
## Enable platform accessibility API implementations through [AccessKit](https://accesskit.dev/).
|
|
accesskit = ["egui/accesskit", "egui-winit/accesskit"]
|
|
|
|
# Allow crates to choose an android-activity backend via Winit
|
|
# - It's important that most applications should not have to depend on android-activity directly, and can
|
|
# rely on Winit to pull in a suitable version (unlike most Rust crates, any version conflicts won't link)
|
|
# - It's also important that we don't impose an android-activity backend by taking this choice away from applications.
|
|
|
|
## Enable the `game-activity` backend via `egui-winit` on Android
|
|
android-game-activity = ["egui-winit/android-game-activity"]
|
|
## Enable the `native-activity` backend via `egui-winit` on Android
|
|
android-native-activity = ["egui-winit/android-native-activity"]
|
|
|
|
## If set, egui will use `include_bytes!` to bundle some fonts.
|
|
## If you plan on specifying your own fonts you may disable this feature.
|
|
default_fonts = ["egui/default_fonts"]
|
|
|
|
## Use [`glow`](https://github.com/grovesNL/glow) for painting, via [`egui_glow`](https://github.com/emilk/egui/tree/master/crates/egui_glow).
|
|
glow = [
|
|
"dep:egui_glow",
|
|
"dep:glow",
|
|
"dep:glutin-winit",
|
|
"dep:glutin",
|
|
"dep:rwh_05",
|
|
"winit/rwh_05",
|
|
]
|
|
|
|
## Enable saving app state to disk.
|
|
persistence = [
|
|
"directories-next",
|
|
"egui-winit/serde",
|
|
"egui/persistence",
|
|
"ron",
|
|
"serde",
|
|
]
|
|
|
|
## Enable profiling with the [`puffin`](https://docs.rs/puffin) crate.
|
|
##
|
|
## `eframe` will call `puffin::GlobalProfiler::lock().new_frame()` for you
|
|
##
|
|
## Only enabled on native, because of the low resolution (1ms) of clocks in browsers.
|
|
puffin = [
|
|
"dep:puffin",
|
|
"egui/puffin",
|
|
"egui_glow?/puffin",
|
|
"egui-wgpu?/puffin",
|
|
"egui-winit/puffin",
|
|
]
|
|
|
|
## Enables wayland support and fixes clipboard issue.
|
|
wayland = ["egui-winit/wayland", "egui-wgpu?/wayland", "egui_glow?/wayland"]
|
|
|
|
## Enable screen reader support (requires `ctx.options_mut(|o| o.screen_reader = true);`) on web.
|
|
##
|
|
## For other platforms, use the `accesskit` feature instead.
|
|
web_screen_reader = [
|
|
"web-sys/SpeechSynthesis",
|
|
"web-sys/SpeechSynthesisUtterance",
|
|
]
|
|
|
|
## Use [`wgpu`](https://docs.rs/wgpu) for painting (via [`egui-wgpu`](https://github.com/emilk/egui/tree/master/crates/egui-wgpu)).
|
|
##
|
|
## This overrides the `glow` feature.
|
|
##
|
|
## By default, only WebGPU is enabled on web.
|
|
## If you want to enable WebGL, you need to turn on the `webgl` feature of crate `wgpu`:
|
|
##
|
|
## ```toml
|
|
## wgpu = { version = "*", features = ["webgpu", "webgl"] }
|
|
## ```
|
|
##
|
|
## By default, eframe will prefer WebGPU over WebGL, but
|
|
## you can configure this at run-time with [`NativeOptions::wgpu_options`].
|
|
wgpu = ["dep:wgpu", "dep:egui-wgpu", "dep:pollster"]
|
|
|
|
## Enables compiling for x11.
|
|
x11 = ["egui-winit/x11", "egui-wgpu?/x11", "egui_glow?/x11"]
|
|
|
|
## If set, eframe will look for the env-var `EFRAME_SCREENSHOT_TO` and write a screenshot to that location, and then quit.
|
|
## This is used to generate images for examples.
|
|
__screenshot = []
|
|
|
|
[dependencies]
|
|
egui = { workspace = true, default-features = false, features = [
|
|
"bytemuck",
|
|
"log",
|
|
] }
|
|
|
|
ahash.workspace = true
|
|
document-features.workspace = true
|
|
log.workspace = true
|
|
parking_lot.workspace = true
|
|
raw-window-handle.workspace = true
|
|
static_assertions = "1.1.0"
|
|
web-time.workspace = true
|
|
|
|
# Optional dependencies
|
|
|
|
egui_glow = { workspace = true, optional = true, default-features = false }
|
|
glow = { workspace = true, optional = true }
|
|
# glutin stuck on old version of raw-window-handle:
|
|
rwh_05 = { package = "raw-window-handle", version = "0.5.2", optional = true, features = [
|
|
"std",
|
|
] }
|
|
ron = { workspace = true, optional = true, features = ["integer128"] }
|
|
serde = { workspace = true, optional = true }
|
|
|
|
# -------------------------------------------
|
|
# native:
|
|
[target.'cfg(not(target_arch = "wasm32"))'.dependencies]
|
|
egui-winit = { workspace = true, default-features = false, features = [
|
|
"clipboard",
|
|
"links",
|
|
] }
|
|
image = { workspace = true, features = ["png"] } # Needed for app icon
|
|
winit = { workspace = true, default-features = false, features = ["rwh_06"] }
|
|
|
|
# optional native:
|
|
directories-next = { version = "2", optional = true }
|
|
egui-wgpu = { workspace = true, optional = true, features = [
|
|
"winit",
|
|
] } # if wgpu is used, use it with winit
|
|
pollster = { version = "0.3", optional = true } # needed for wgpu
|
|
|
|
# we can expose these to user so that they can select which backends they want to enable to avoid compiling useless deps.
|
|
# this can be done at the same time we expose x11/wayland features of winit crate.
|
|
glutin = { workspace = true, optional = true }
|
|
glutin-winit = { workspace = true, optional = true }
|
|
puffin = { workspace = true, optional = true }
|
|
wgpu = { workspace = true, optional = true, features = [
|
|
# Let's enable some backends so that users can use `eframe` out-of-the-box
|
|
# without having to explicitly opt-in to backends
|
|
"metal",
|
|
"webgpu",
|
|
] }
|
|
|
|
# mac:
|
|
[target.'cfg(any(target_os = "macos"))'.dependencies]
|
|
objc2 = "0.5.1"
|
|
objc2-foundation = { version = "0.2.0", features = [
|
|
"block2",
|
|
"NSData",
|
|
"NSString",
|
|
] }
|
|
objc2-app-kit = { version = "0.2.0", features = [
|
|
"NSApplication",
|
|
"NSImage",
|
|
"NSMenu",
|
|
"NSMenuItem",
|
|
"NSResponder",
|
|
] }
|
|
|
|
# windows:
|
|
[target.'cfg(any(target_os = "windows"))'.dependencies]
|
|
winapi = { version = "0.3.9", features = ["winuser"] }
|
|
|
|
# -------------------------------------------
|
|
# web:
|
|
[target.'cfg(target_arch = "wasm32")'.dependencies]
|
|
bytemuck.workspace = true
|
|
js-sys = "0.3"
|
|
percent-encoding = "2.1"
|
|
wasm-bindgen.workspace = true
|
|
wasm-bindgen-futures.workspace = true
|
|
web-sys = { workspace = true, features = [
|
|
"BinaryType",
|
|
"Blob",
|
|
"Clipboard",
|
|
"ClipboardEvent",
|
|
"CompositionEvent",
|
|
"console",
|
|
"CssStyleDeclaration",
|
|
"DataTransfer",
|
|
"DataTransferItem",
|
|
"DataTransferItemList",
|
|
"Document",
|
|
"DomRect",
|
|
"DragEvent",
|
|
"Element",
|
|
"Event",
|
|
"EventListener",
|
|
"EventTarget",
|
|
"ExtSRgb",
|
|
"File",
|
|
"FileList",
|
|
"FocusEvent",
|
|
"HtmlCanvasElement",
|
|
"HtmlElement",
|
|
"HtmlInputElement",
|
|
"InputEvent",
|
|
"KeyboardEvent",
|
|
"Location",
|
|
"MediaQueryList",
|
|
"MediaQueryListEvent",
|
|
"MouseEvent",
|
|
"Navigator",
|
|
"Performance",
|
|
"Storage",
|
|
"Touch",
|
|
"TouchEvent",
|
|
"TouchList",
|
|
"WebGl2RenderingContext",
|
|
"WebglDebugRendererInfo",
|
|
"WebGlRenderingContext",
|
|
"WheelEvent",
|
|
"Window",
|
|
] }
|
|
|
|
# optional web:
|
|
egui-wgpu = { workspace = true, optional = true } # if wgpu is used, use it without (!) winit
|
|
wgpu = { workspace = true, optional = true, features = [
|
|
# Let's enable some backends so that users can use `eframe` out-of-the-box
|
|
# without having to explicitly opt-in to backends
|
|
"webgpu",
|
|
] }
|