Skip to content

Commit

Permalink
chore: new version and updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ElhamAryanpur committed Jun 7, 2024
1 parent 4762fbd commit b9481b9
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 2 deletions.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "blue_engine"
version = "0.5.10"
version = "0.5.12"
authors = ["Elham Aryanpur <[email protected]>"]
edition = "2021"
description = "General-Purpose, Easy-to-use, Fast, and Portable graphics engine"
Expand Down
12 changes: 12 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,18 @@
//! The code of the engine is organized in a rather different manner than traditional in the
//! language. There are inspirations from other languages to make it easier to navigate the
//! project.
//!
//! ## Older hardware
//!
//! The engine uses WGPU under the hood for rendering. WGPU by nature is designed for modern hardware, so if you have or want to
//! target older hardware, you might need to add a couple more things to WindowDescriptor during Engine::new_config:
//!
//! 1) set a backend that targets your older hardware, such as GL using the backends field: `backend: blue_engine::wgpu::Backends::GL`
//! 2) experiement with the limits field, which describes what features you need. `limits: blue_engine::wgpu::Limits::default()`. there
//! are three options for limits: `default` for normal hardware, `downlevel_defaults` which are compatible with GLES-3 and D3D-11, or
//! `downlevel_webgl2_defaults` which is also compatible with WebGL2, and the lowest level for limits and can support very old hardware.
//!
//! with these two changes, hopefully you can get Blue Engine to run on older hardware. If not, please let me know so I can help you further.

pub(crate) mod definition;
/// contains all the declarations such as structs, exports, enums, ...
Expand Down

0 comments on commit b9481b9

Please sign in to comment.