Skip to content

[Merged by Bors] - Default image sampler doc fix#5047

Closed
sarkahn wants to merge 7 commits intobevyengine:mainfrom
sarkahn:default_image_sampler_doc_fix
Closed

[Merged by Bors] - Default image sampler doc fix#5047
sarkahn wants to merge 7 commits intobevyengine:mainfrom
sarkahn:default_image_sampler_doc_fix

Conversation

@sarkahn
Copy link
Contributor

@sarkahn sarkahn commented Jun 18, 2022

Objective

Attempt to more clearly document ImageSettings and setting a default sampler for new images, as per #5046

Changelog

  • Moved ImageSettings into image.rs, image::* is already exported. Makes it simpler for linking docs.
  • Renamed "DefaultImageSampler" to "RenderDefaultImageSampler". Not a great name, but more consistent with other render resources.
  • Added/updated related docs

sarkahn added 4 commits June 18, 2022 11:06
Moved ImageSettings into image.rs
Changed DefaultImageSampler to RenderDefaultImageSampler
Added docs explaining how to set the default image sampler via
ImageSettings
@Weibye Weibye added C-Docs An addition or correction to our documentation A-Rendering Drawing game state to the screen labels Jun 18, 2022
Copy link
Member

@alice-i-cecile alice-i-cecile left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is clearer, and I like the reorganization. Can you revert the rename? I don't think the improvement is worth the breaking change.

sarkahn and others added 2 commits June 20, 2022 14:34
Co-authored-by: François <mockersf@gmail.com>
Co-authored-by: François <mockersf@gmail.com>
@alice-i-cecile alice-i-cecile requested a review from mockersf June 21, 2022 02:02
Copy link
Contributor

@superdump superdump left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@alice-i-cecile
Copy link
Member

bors r+

bors bot pushed a commit that referenced this pull request Jun 26, 2022
# Objective

Attempt to more clearly document `ImageSettings` and setting a default sampler for new images, as per #5046

## Changelog

- Moved ImageSettings into image.rs, image::* is already exported. Makes it simpler for linking docs. 
- Renamed "DefaultImageSampler" to "RenderDefaultImageSampler". Not a great name, but more consistent with other render resources.
- Added/updated related docs
@bors bors bot changed the title Default image sampler doc fix [Merged by Bors] - Default image sampler doc fix Jun 26, 2022
@bors bors bot closed this Jun 26, 2022
inodentry pushed a commit to IyesGames/bevy that referenced this pull request Aug 8, 2022
# Objective

Attempt to more clearly document `ImageSettings` and setting a default sampler for new images, as per bevyengine#5046

## Changelog

- Moved ImageSettings into image.rs, image::* is already exported. Makes it simpler for linking docs. 
- Renamed "DefaultImageSampler" to "RenderDefaultImageSampler". Not a great name, but more consistent with other render resources.
- Added/updated related docs
james7132 pushed a commit to james7132/bevy that referenced this pull request Oct 28, 2022
# Objective

Attempt to more clearly document `ImageSettings` and setting a default sampler for new images, as per bevyengine#5046

## Changelog

- Moved ImageSettings into image.rs, image::* is already exported. Makes it simpler for linking docs. 
- Renamed "DefaultImageSampler" to "RenderDefaultImageSampler". Not a great name, but more consistent with other render resources.
- Added/updated related docs
ItsDoot pushed a commit to ItsDoot/bevy that referenced this pull request Feb 1, 2023
# Objective

Attempt to more clearly document `ImageSettings` and setting a default sampler for new images, as per bevyengine#5046

## Changelog

- Moved ImageSettings into image.rs, image::* is already exported. Makes it simpler for linking docs. 
- Renamed "DefaultImageSampler" to "RenderDefaultImageSampler". Not a great name, but more consistent with other render resources.
- Added/updated related docs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-Rendering Drawing game state to the screen C-Docs An addition or correction to our documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants