Struct GpuImage 

pub struct GpuImage {
    pub texture: Texture,
    pub texture_view: TextureView,
    pub texture_format: TextureFormat,
    pub texture_view_format: Option<TextureFormat>,
    pub sampler: Sampler,
    pub size: Extent3d,
    pub mip_level_count: u32,
    pub had_data: bool,
}

The GPU-representation of an Image. Consists of the Texture, its TextureView and the corresponding Sampler, and the texture’s size.

Fields

texture: Texture

texture_view: TextureView

texture_format: TextureFormat

texture_view_format: Option<TextureFormat>

sampler: Sampler

size: Extent3d

mip_level_count: u32

had_data: bool

Implementations

impl GpuImage

pub fn aspect_ratio(&self) -> AspectRatio

Returns the aspect ratio (width / height) of a 2D image.

pub fn size_2d(&self) -> UVec2

Returns the size of a 2D image.

Trait Implementations

impl Clone for GpuImage

fn clone(&self) -> GpuImage

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GpuImage

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl RenderAsset for GpuImage

fn prepare_asset( image: Self::SourceAsset, _: AssetId<Self::SourceAsset>, (render_device, render_queue, default_sampler): &mut SystemParamItem<'_, '_, Self::Param>, previous_asset: Option<&Self>, ) -> Result<Self, PrepareAssetError<Self::SourceAsset>>

Converts the extracted image into a GpuImage.

type SourceAsset = Image

The representation of the asset in the “main world”.

type Param = (Res<'static, RenderDevice>, Res<'static, RenderQueue>, Res<'static, DefaultImageSampler>)

Specifies all ECS data required by RenderAsset::prepare_asset.

fn asset_usage(image: &Self::SourceAsset) -> RenderAssetUsages

Whether or not to unload the asset after extracting it to the render world.

fn take_gpu_data( source: &mut Self::SourceAsset, previous_gpu_asset: Option<&Self>, ) -> Result<Self::SourceAsset, AssetExtractionError>

Make a copy of the asset to be moved to the RenderWorld / gpu. Heavy internal data (pixels, vertex attributes) should be moved into the copy, leaving this asset with only metadata. An error may be returned to indicate that the asset has already been extracted, and should not have been modified on the CPU side (as it cannot be transferred to GPU again). The previous GPU asset is also provided, which can be used to check if the modification is valid.

fn byte_len(image: &Self::SourceAsset) -> Option<usize>

Size of the data the asset will upload to the gpu. Specifying a return value will allow the asset to be throttled via RenderAssetBytesPerFrame.

fn unload_asset( _source_asset: AssetId<Self::SourceAsset>, _param: &mut SystemParamItem<'_, '_, Self::Param>, )

Called whenever the RenderAsset::SourceAsset has been removed.