From 8ae36f669655b8146777a841fe43ed12783ab6e4 Mon Sep 17 00:00:00 2001 From: Asger Nyman Christiansen Date: Mon, 26 Feb 2024 17:16:48 +0100 Subject: [PATCH] Update example links --- README.md | 4 +-- examples/README.md | 62 +++++++++++++++++++++++----------------------- src/lib.rs | 2 +- 3 files changed, 34 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index fb07e6c39..2cf5a8458 100644 --- a/README.md +++ b/README.md @@ -75,11 +75,11 @@ The crate consist of three main modules for drawing, `context`, `core` and `rend In addition, the [three-d-asset](https://github.com/asny/three-d-asset) crate enables loading, deserializing, serializing and saving 3D assets, for example 3D models, textures etc. Please make sure to use the same version of [three-d-asset](https://github.com/asny/three-d-asset) as defined in the `Cargo.toml`. -### [Examples](https://github.com/asny/three-d/tree/master/examples) +### [Examples](https://github.com/asny/three-d/tree/0.17/examples) ![PBR example](https://asny.github.io/three-d/0.17/pbr.png) -Several examples covering most features can be found in the [examples folder](https://github.com/asny/three-d/tree/master/examples). +Several examples covering most features can be found in the [examples folder](https://github.com/asny/three-d/tree/0.17/examples). Here you will also find an overview of the examples, build instructions and links to the web version of the examples. diff --git a/examples/README.md b/examples/README.md index f02113b6a..bb99b6ead 100644 --- a/examples/README.md +++ b/examples/README.md @@ -20,134 +20,134 @@ All of the examples builds to both native (desktop, mobile or whatever target sp Because they should run in a browser and to keep the same code for native and wasm, all loading happens async. If your application is native only, you can avoid the async runtime (`tokio` or `async-std`) and use `three_d_asset::load` instead of `three_d_asset::load_async`. -## Triangle [[code](https://github.com/asny/three-d/tree/master/examples/triangle/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/triangle.html)] +## Triangle [[code](https://github.com/asny/three-d/tree/0.17/examples/triangle/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/triangle.html)] This is the recommended starting point for a gentle introduction to `three-d`. ![Triangle example](https://asny.github.io/three-d/0.17/triangle.png) -## Triangle core [[code](https://github.com/asny/three-d/tree/master/examples/triangle_core/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/triangle_core.html)] +## Triangle core [[code](https://github.com/asny/three-d/tree/0.17/examples/triangle_core/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/triangle_core.html)] This is the same as the `Triangle` example, except it only uses the core module and not the renderer module. ![Triangle core example](https://asny.github.io/three-d/0.17/triangle_core.png) -## Mandelbrot [[code](https://github.com/asny/three-d/tree/master/examples/mandelbrot/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/mandelbrot.html)] +## Mandelbrot [[code](https://github.com/asny/three-d/tree/0.17/examples/mandelbrot/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/mandelbrot.html)] ![Mandelbrot example](https://asny.github.io/three-d/0.17/mandelbrot.png) -## Shapes2D [[code](https://github.com/asny/three-d/tree/master/examples/shapes2d/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/shapes2d.html)] +## Shapes2D [[code](https://github.com/asny/three-d/tree/0.17/examples/shapes2d/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/shapes2d.html)] ![Shapes2d example](https://asny.github.io/three-d/0.17/shapes2d.png) -## Shapes [[code](https://github.com/asny/three-d/tree/master/examples/shapes/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/shapes.html)] +## Shapes [[code](https://github.com/asny/three-d/tree/0.17/examples/shapes/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/shapes.html)] ![Shapes example](https://asny.github.io/three-d/0.17/shapes.png) -## Instanced Draw Order [[code](https://github.com/asny/three-d/tree/master/examples/instanced_draw_order/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/instanced_draw_order.html)] +## Instanced Draw Order [[code](https://github.com/asny/three-d/tree/0.17/examples/instanced_draw_order/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/instanced_draw_order.html)] This example shows how depth ordering is currently working for `InstancedMesh` objects with transparency. ![Instanced Draw Order](https://asny.github.io/three-d/0.17/instanced_draw_order.png) -## Instanced Shapes [[code](https://github.com/asny/three-d/tree/master/examples/instanced_shapes/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/instanced_shapes.html)] +## Instanced Shapes [[code](https://github.com/asny/three-d/tree/0.17/examples/instanced_shapes/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/instanced_shapes.html)] ![Instanced Shapes example](https://asny.github.io/three-d/0.17/instanced_shapes.png) -## Screen [[code](https://github.com/asny/three-d/tree/master/examples/screen/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/screen.html)] +## Screen [[code](https://github.com/asny/three-d/tree/0.17/examples/screen/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/screen.html)] ![Screen example](https://asny.github.io/three-d/0.17/screen.png) -## Multisample [[code](https://github.com/asny/three-d/tree/master/examples/multisample/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/multisample.html)] +## Multisample [[code](https://github.com/asny/three-d/tree/0.17/examples/multisample/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/multisample.html)] ![Screen example](https://asny.github.io/three-d/0.17/multisample.png) -## Sprites [[code](https://github.com/asny/three-d/tree/master/examples/sprites/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/sprites.html)] +## Sprites [[code](https://github.com/asny/three-d/tree/0.17/examples/sprites/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/sprites.html)] ![Sprites example](https://asny.github.io/three-d/0.17/sprites.png) -## Texture [[code](https://github.com/asny/three-d/tree/master/examples/texture/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/texture.html)] +## Texture [[code](https://github.com/asny/three-d/tree/0.17/examples/texture/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/texture.html)] ![Texture example](https://asny.github.io/three-d/0.17/texture.png) -## Animation [[code](https://github.com/asny/three-d/tree/master/examples/animation/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/animation.html)] +## Animation [[code](https://github.com/asny/three-d/tree/0.17/examples/animation/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/animation.html)] ![Animation example](https://asny.github.io/three-d/0.17/animation.png) -## Picking [[code](https://github.com/asny/three-d/tree/master/examples/picking/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/picking.html)] +## Picking [[code](https://github.com/asny/three-d/tree/0.17/examples/picking/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/picking.html)] ![Picking example](https://asny.github.io/three-d/0.17/picking.png) -## Environment [[code](https://github.com/asny/three-d/tree/master/examples/environment/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/environment.html)] +## Environment [[code](https://github.com/asny/three-d/tree/0.17/examples/environment/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/environment.html)] ![Environment example](https://asny.github.io/three-d/0.17/environment.png) -## PBR [[code](https://github.com/asny/three-d/tree/master/examples/pbr/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/pbr.html)] +## PBR [[code](https://github.com/asny/three-d/tree/0.17/examples/pbr/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/pbr.html)] ![PBR example](https://asny.github.io/three-d/0.17/pbr.png) -## Lighting [[code](https://github.com/asny/three-d/tree/master/examples/lighting/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/lighting.html)] +## Lighting [[code](https://github.com/asny/three-d/tree/0.17/examples/lighting/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/lighting.html)] ![Lighting example](https://asny.github.io/three-d/0.17/lighting.png) -## Lights [[code](https://github.com/asny/three-d/tree/master/examples/lights/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/lights.html)] +## Lights [[code](https://github.com/asny/three-d/tree/0.17/examples/lights/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/lights.html)] ![Lights example](https://asny.github.io/three-d/0.17/lights.png) -## Image [[code](https://github.com/asny/three-d/tree/master/examples/image/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/image.html)] +## Image [[code](https://github.com/asny/three-d/tree/0.17/examples/image/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/image.html)] ![Image example](https://asny.github.io/three-d/0.17/image.png) -## Point cloud [[code](https://github.com/asny/three-d/tree/master/examples/point_cloud/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/point_cloud.html)] +## Point cloud [[code](https://github.com/asny/three-d/tree/0.17/examples/point_cloud/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/point_cloud.html)] ![Point cloud example](https://asny.github.io/three-d/0.17/point_cloud.png) -## Fog [[code](https://github.com/asny/three-d/tree/master/examples/fog/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/fog.html)] +## Fog [[code](https://github.com/asny/three-d/tree/0.17/examples/fog/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/fog.html)] ![Fog example](https://asny.github.io/three-d/0.17/fog.png) -## Terrain [[code](https://github.com/asny/three-d/tree/master/examples/terrain/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/terrain.html)] +## Terrain [[code](https://github.com/asny/three-d/tree/0.17/examples/terrain/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/terrain.html)] ![Terrain example](https://asny.github.io/three-d/0.17/terrain.png) -## Fireworks [[code](https://github.com/asny/three-d/tree/master/examples/fireworks/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/fireworks.html)] +## Fireworks [[code](https://github.com/asny/three-d/tree/0.17/examples/fireworks/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/fireworks.html)] ![Fireworks example](https://asny.github.io/three-d/0.17/fireworks.png) -## Statues [[code](https://github.com/asny/three-d/tree/master/examples/statues/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/statues.html)] +## Statues [[code](https://github.com/asny/three-d/tree/0.17/examples/statues/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/statues.html)] ![Statues example](https://asny.github.io/three-d/0.17/statues.png) -## Wireframe [[code](https://github.com/asny/three-d/tree/master/examples/wireframe/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/wireframe.html)] +## Wireframe [[code](https://github.com/asny/three-d/tree/0.17/examples/wireframe/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/wireframe.html)] ![Wireframe example](https://asny.github.io/three-d/0.17/wireframe.png) -## Forest [[code](https://github.com/asny/three-d/tree/master/examples/forest/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/forest.html)] +## Forest [[code](https://github.com/asny/three-d/tree/0.17/examples/forest/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/forest.html)] ![Forest example](https://asny.github.io/three-d/0.17/forest.png) -## Volume [[code](https://github.com/asny/three-d/tree/master/examples/volume/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/volume.html)] +## Volume [[code](https://github.com/asny/three-d/tree/0.17/examples/volume/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/volume.html)] ![Volume example](https://asny.github.io/three-d/0.17/volume.png) -## Normals [[code](https://github.com/asny/three-d/tree/master/examples/normals/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/normals.html)] +## Normals [[code](https://github.com/asny/three-d/tree/0.17/examples/normals/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/normals.html)] ![Normals example](https://asny.github.io/three-d/0.17/normals.png) -## Logo [[code](https://github.com/asny/three-d/tree/master/examples/logo/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/logo.html)] +## Logo [[code](https://github.com/asny/three-d/tree/0.17/examples/logo/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/logo.html)] ![Logo example](https://asny.github.io/three-d/0.17/logo.png) -## Winit window [[code](https://github.com/asny/three-d/tree/master/examples/winit_window/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/winit_window.html)] +## Winit window [[code](https://github.com/asny/three-d/tree/0.17/examples/winit_window/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/winit_window.html)] Shows how to easily combine a custom [winit](https://crates.io/crates/winit) window with `three-d` rendering. ![Winit window example](https://asny.github.io/three-d/0.17/winit_window.png) -## Multiwindow [[code](https://github.com/asny/three-d/tree/master/examples/multiwindow/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/multiwindow.html)] +## Multiwindow [[code](https://github.com/asny/three-d/tree/0.17/examples/multiwindow/src/main.rs)] [[demo](https://asny.github.io/three-d/0.17/multiwindow.html)] Shows how to create multiple [winit](https://crates.io/crates/winit) windows and render with `three-d`. -## Headless [[code](https://github.com/asny/three-d/tree/master/examples/headless/src/main.rs)] +## Headless [[code](https://github.com/asny/three-d/tree/0.17/examples/headless/src/main.rs)] This example does not create a window but render directly to a render target and saves the result to disk. Therefore, this example does not work on web. diff --git a/src/lib.rs b/src/lib.rs index 73f95fe3e..eb623d46f 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -6,7 +6,7 @@ //! //! A 3D renderer which enables out-of-the-box build to both desktop and web with the same code. //! See the [README](https://crates.io/crates/three-d) for more information and -//! the [examples](https://github.com/asny/three-d/tree/master/examples) for how to use it. +//! the [examples](https://github.com/asny/three-d/tree/0.17/examples) for how to use it. //! pub mod context;