Update new_target_texture doc comment

This commit is contained in:
tigregalis 2025-04-21 11:01:36 +08:00
parent ae0ee4f0e2
commit 301dc28371

View File

@ -843,12 +843,18 @@ impl Image {
Image::new(size, dimension, data, format, asset_usage) Image::new(size, dimension, data, format, asset_usage)
} }
/// Create a new zero-filled image with a given size, which can be rendered to. This is primarily /// Create a new zero-filled image with a given size, which can be rendered to.
/// for use as a render target for a [`Camera`]. See [`RenderTarget::Image`]. /// This is primarily for use as a render target for a [`Camera`].
/// See [`RenderTarget::Image`].
/// ///
/// You can use [`TEXTURE_FORMAT_SDR`] and [`TEXTURE_FORMAT_HDR`] /// You can use [`TEXTURE_FORMAT_SDR`] and [`TEXTURE_FORMAT_HDR`]
/// for Standard Dynamic Range (SDR) and High Dynamic Range (HDR) respectively. /// for Standard Dynamic Range (SDR) and High Dynamic Range (HDR) respectively.
/// ///
/// The default texture usages are
/// [`TEXTURE_BINDING`](TextureUsages::TEXTURE_BINDING),
/// [`COPY_DST`](TextureUsages::COPY_DST),
/// [`RENDER_ATTACHMENT`](TextureUsages::RENDER_ATTACHMENT).
///
/// [`Camera`]: https://docs.rs/bevy/latest/bevy/render/camera/struct.Camera.html /// [`Camera`]: https://docs.rs/bevy/latest/bevy/render/camera/struct.Camera.html
/// [`RenderTarget::Image`]: https://docs.rs/bevy/latest/bevy/render/camera/enum.RenderTarget.html#variant.Image /// [`RenderTarget::Image`]: https://docs.rs/bevy/latest/bevy/render/camera/enum.RenderTarget.html#variant.Image
pub fn new_target_texture(width: u32, height: u32, format: TextureFormat) -> Self { pub fn new_target_texture(width: u32, height: u32, format: TextureFormat) -> Self {