Crate turtle [−] [src]
The API Documentation below will help you learn about the various things you can do with this crate.
If this is your first time using Rust or using this crate, read the Guide on turtle.rs to learn how to start.
The documentation for the Turtle
struct contains a listing of all of the
various drawing commands that you can use on the Turtles that you create. The color
module and its submodules contain hundreds of predefined color names that you
can use to set the pen, background and fill color of a turtle. That module also explains how to
use any arbitrary color, including ones that may not be defined in this crate.
Note: Call turtle::start()
if you do not create a turtle with
Turtle::new()
right at the beginning of your program. Most
programs will never need to call this function as it is called for you in
Turtle::new()
.
Random Values
See the rand
module for information about generating random colors, speeds,
angles, and more which can be used in your programs to produce some interesting results!
Event Handling
The Event
enum documentation provides information about how you can
create an event loop. This allows you to draw things in response to certain events like the
mouse moving, keys being pressed, and more.
The Turtle
struct contains a few convenience methods so you can do some common event-related
things without creating the entire event loop. For example, use
wait_for_click()
to wait for the user to click
anywhere on the screen before proceeding.
Reexports
pub use color::Color; |
pub use event::Event; |
pub use rand::random_range; |
Modules
color |
Color types and constants |
event |
Event handling (mouse, keyboard, controller, touch screen, etc.) |
rand |
Utilities for generating random values |
Structs
Turtle |
A turtle with a pen attached to its tail |
Enums
Speed |
Represents the supported movement and rotation speeds |
Functions
random |
Generates a random value using the thread-local random number generator. |
start |
Start the turtle window in advance |
Type Definitions
Angle |
An angle value without a unit |
Distance |
Any distance value (positive or negative) |
Point |
A point in 2D space: [x, y] |