Skip to content

Commit ca9e2dc

Browse files
add links to readme (image-rs#2437)
1 parent 95be339 commit ca9e2dc

File tree

1 file changed

+19
-18
lines changed

1 file changed

+19
-18
lines changed

README.md

+19-18
Original file line numberDiff line numberDiff line change
@@ -111,31 +111,32 @@ The most important methods for decoders are...
111111
All pixels are parameterised by their component type.
112112

113113
## Image Processing Functions
114-
These are the functions defined in the `imageops` module. All functions operate on types that implement the `GenericImage` trait.
114+
115+
These are the functions defined in the [`imageops`](https://docs.rs/image/latest/image/imageops/index.html) module. All functions operate on types that implement the [`GenericImage`](https://docs.rs/image/latest/image/trait.GenericImage.html) trait.
115116
Note that some of the functions are very slow in debug mode. Make sure to use release mode if you experience any performance issues.
116117

117-
+ **blur**: Performs a Gaussian blur on the supplied image.
118-
+ **brighten**: Brighten the supplied image.
119-
+ **huerotate**: Hue rotate the supplied image by degrees.
120-
+ **contrast**: Adjust the contrast of the supplied image.
121-
+ **crop**: Return a mutable view into an image.
122-
+ **filter3x3**: Perform a 3x3 box filter on the supplied image.
123-
+ **flip_horizontal**: Flip an image horizontally.
124-
+ **flip_vertical**: Flip an image vertically.
125-
+ **grayscale**: Convert the supplied image to grayscale.
126-
+ **invert**: Invert each pixel within the supplied image This function operates in place.
127-
+ **resize**: Resize the supplied image to the specified dimensions.
128-
+ **rotate180**: Rotate an image 180 degrees clockwise.
129-
+ **rotate270**: Rotate an image 270 degrees clockwise.
130-
+ **rotate90**: Rotate an image 90 degrees clockwise.
131-
+ **unsharpen**: Performs an unsharpen mask on the supplied image.
118+
+ [**blur**](https://docs.rs/image/latest/image/enum.DynamicImage.html#method.blur): Performs a Gaussian blur on the supplied image.
119+
+ [**brighten**](https://docs.rs/image/latest/image/enum.DynamicImage.html#method.brighten): Brighten the supplied image.
120+
+ [**huerotate**](https://docs.rs/image/latest/image/enum.DynamicImage.html#method.huerotate): Hue rotate the supplied image by degrees.
121+
+ [**contrast**](https://docs.rs/image/latest/image/enum.DynamicImage.html#method.adjust_contrast): Adjust the contrast of the supplied image.
122+
+ [**crop**](https://docs.rs/image/latest/image/enum.DynamicImage.html#method.crop): Return a mutable view into an image.
123+
+ [**filter3x3**](https://docs.rs/image/latest/image/enum.DynamicImage.html#method.filter3x3): Perform a 3x3 box filter on the supplied image.
124+
+ [**flip_horizontal**](https://docs.rs/image/latest/image/enum.DynamicImage.html#method.fliph): Flip an image horizontally.
125+
+ [**flip_vertical**](https://docs.rs/image/latest/image/enum.DynamicImage.html#method.flipv): Flip an image vertically.
126+
+ [**grayscale**](https://docs.rs/image/latest/image/enum.DynamicImage.html#method.grayscale): Convert the supplied image to grayscale.
127+
+ [**invert**](https://docs.rs/image/latest/image/enum.DynamicImage.html#method.invert): Invert each pixel within the supplied image This function operates in place.
128+
+ [**resize**](https://docs.rs/image/latest/image/enum.DynamicImage.html#method.resize): Resize the supplied image to the specified dimensions.
129+
+ [**rotate180**](https://docs.rs/image/latest/image/enum.DynamicImage.html#method.rotate180): Rotate an image 180 degrees clockwise.
130+
+ [**rotate270**](https://docs.rs/image/latest/image/enum.DynamicImage.html#method.rotate270): Rotate an image 270 degrees clockwise.
131+
+ [**rotate90**](https://docs.rs/image/latest/image/enum.DynamicImage.html#method.rotate90): Rotate an image 90 degrees clockwise.
132+
+ [**unsharpen**](https://docs.rs/image/latest/image/enum.DynamicImage.html#method.unsharpen): Performs an unsharpen mask on the supplied image.
132133

133134
For more options, see the [`imageproc`](https://crates.io/crates/imageproc) crate.
134135

135136
## Examples
136137
### Opening and Saving Images
137138

138-
`image` provides the `open` function for opening images from a path. The image
139+
`image` provides the [`open`](https://docs.rs/image/latest/image/fn.open.html) function for opening images from a path. The image
139140
format is determined from the path's file extension. An `io` module provides a
140141
reader which offer some more control.
141142

@@ -206,7 +207,7 @@ Example output:
206207
<img src="examples/fractal.png" alt="A Julia Fractal, c: -0.4 + 0.6i" width="500" />
207208

208209
### Writing raw buffers
209-
If the high level interface is not needed because the image was obtained by other means, `image` provides the function `save_buffer` to save a buffer to a file.
210+
If the high level interface is not needed because the image was obtained by other means, `image` provides the function [`save_buffer`](https://docs.rs/image/latest/image/fn.save_buffer.html) to save a buffer to a file.
210211

211212
```rust,no_run
212213
let buffer: &[u8] = unimplemented!(); // Generate the image data

0 commit comments

Comments
 (0)