bevyengine / bevyengine/bevy

The words "image" and "texture" are used interchangeably in some doc comments

Open
#16,165 0 comments 1 reaction 0 assignees View on GitHub
A-Rendering C-Docs D-Straightforward S-Ready-For-Implementation
Dominant language
Rust
Stars
48.2k
Forks
4.8k
Avg merge
3d 22h
Merged PRs (30d)
161

Description

## How can Bevy's documentation be improved?

The words "image" and "texture" are used interchangeably in some of the doc comments, example from `ImageScaleMode`:

```
/// Controls how the image is altered when scaled.
#[derive(Component, Debug, Clone, Reflect)]
#[reflect(Component, Debug)]
pub enum ImageScaleMode {
/// The texture will be cut in 9 slices, keeping the texture in proportions on resize
Sliced(TextureSlicer),
/// The texture will be repeated if stretched beyond `stretched_value`
Tiled {
/// Should the image repeat horizontally
tile_x: bool,
/// Should the image repeat vertically
tile_y: bool,
/// The texture will repeat when the ratio between the *drawing dimensions* of texture and the
/// *original texture size* are above this value.
stretch_value: f32,
},
}
```

It's not that anything is incorrect, but the `Image` and `Texture` types serve very different purposes in Bevy so there's potential for confusion and it feels a bit loose and inconsistant to me.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.