Remove garbage from README
The docs are in the src/lib.rs anyway and are present on docs.rs.
This commit is contained in:
parent
acfeff5327
commit
6a041f84ba
1 changed files with 2 additions and 55 deletions
57
README.md
57
README.md
|
|
@ -32,32 +32,6 @@ Winit is designed to be a low-level brick in a hierarchy of libraries. Consequen
|
||||||
show something on the window you need to use the platform-specific getters provided by winit, or
|
show something on the window you need to use the platform-specific getters provided by winit, or
|
||||||
another library.
|
another library.
|
||||||
|
|
||||||
```rust
|
|
||||||
use winit::{
|
|
||||||
event::{Event, WindowEvent},
|
|
||||||
event_loop::EventLoop,
|
|
||||||
window::WindowBuilder,
|
|
||||||
};
|
|
||||||
|
|
||||||
fn main() {
|
|
||||||
let event_loop = EventLoop::new();
|
|
||||||
event_loop.set_control_flow(ControlFlow::Wait);
|
|
||||||
let window = WindowBuilder::new().build(&event_loop).unwrap();
|
|
||||||
|
|
||||||
event_loop.run(move |event, elwt| {
|
|
||||||
match event {
|
|
||||||
Event::WindowEvent {
|
|
||||||
event: WindowEvent::CloseRequested,
|
|
||||||
window_id,
|
|
||||||
} if window_id == window.id() => elwt.exit(),
|
|
||||||
_ => (),
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Winit is only officially supported on the latest stable version of the Rust compiler.
|
|
||||||
|
|
||||||
### Cargo Features
|
### Cargo Features
|
||||||
|
|
||||||
Winit provides the following features, which can be enabled in your `Cargo.toml` file:
|
Winit provides the following features, which can be enabled in your `Cargo.toml` file:
|
||||||
|
|
@ -177,33 +151,6 @@ class. Your application _must_ specify the base class it needs via a feature fla
|
||||||
[agdk_releases]: https://developer.android.com/games/agdk/download#agdk-libraries
|
[agdk_releases]: https://developer.android.com/games/agdk/download#agdk-libraries
|
||||||
[Gradle]: https://developer.android.com/studio/build
|
[Gradle]: https://developer.android.com/studio/build
|
||||||
|
|
||||||
For example, add this to Cargo.toml:
|
|
||||||
```toml
|
|
||||||
winit = { version = "0.29.1-beta", features = [ "android-native-activity" ] }
|
|
||||||
|
|
||||||
[target.'cfg(target_os = "android")'.dependencies]
|
|
||||||
android_logger = "0.11.0"
|
|
||||||
```
|
|
||||||
|
|
||||||
And, for example, define an entry point for your library like this:
|
|
||||||
```rust
|
|
||||||
#[cfg(target_os = "android")]
|
|
||||||
use winit::platform::android::activity::AndroidApp;
|
|
||||||
|
|
||||||
#[cfg(target_os = "android")]
|
|
||||||
#[no_mangle]
|
|
||||||
fn android_main(app: AndroidApp) {
|
|
||||||
use winit::platform::android::EventLoopBuilderExtAndroid;
|
|
||||||
|
|
||||||
android_logger::init_once(android_logger::Config::default().with_min_level(log::Level::Trace));
|
|
||||||
|
|
||||||
let event_loop = EventLoopBuilder::with_user_event()
|
|
||||||
.with_android_app(app)
|
|
||||||
.build();
|
|
||||||
_main(event_loop);
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
For more details, refer to these `android-activity` [example applications](https://github.com/rib/android-activity/tree/main/examples).
|
For more details, refer to these `android-activity` [example applications](https://github.com/rib/android-activity/tree/main/examples).
|
||||||
|
|
||||||
##### Converting from `ndk-glue` to `android-activity`
|
##### Converting from `ndk-glue` to `android-activity`
|
||||||
|
|
@ -221,13 +168,13 @@ doing anything; this includes creating windows, fetching monitors, drawing,
|
||||||
and so on, see issues [#2238], [#2051] and [#2087].
|
and so on, see issues [#2238], [#2051] and [#2087].
|
||||||
|
|
||||||
If you encounter problems, you should try doing your initialization inside
|
If you encounter problems, you should try doing your initialization inside
|
||||||
`Event::NewEvents(StartCause::Init)`.
|
`Event::Resume`.
|
||||||
|
|
||||||
#### iOS
|
#### iOS
|
||||||
|
|
||||||
Similar to macOS, iOS's main `UIApplicationMain` does some init work that's required
|
Similar to macOS, iOS's main `UIApplicationMain` does some init work that's required
|
||||||
by all UI related code, see issue [#1705]. You should consider creating your windows
|
by all UI related code, see issue [#1705]. You should consider creating your windows
|
||||||
inside `Event::NewEvents(StartCause::Init)`.
|
inside `Event::Resume`.
|
||||||
|
|
||||||
|
|
||||||
[#2238]: https://github.com/rust-windowing/winit/issues/2238
|
[#2238]: https://github.com/rust-windowing/winit/issues/2238
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue