Struct GpuImage 

pub struct GpuImage {
    pub texture: Texture,
    pub texture_view: TextureView,
    pub sampler: Sampler,
    pub texture_descriptor: TextureDescriptor<Option<&'static str>, &'static [TextureFormat]>,
    pub texture_view_descriptor: Option<TextureViewDescriptor<Option<&'static str>>>,
    pub had_data: bool,
}

Available on crate feature bevy_render only.

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

sampler: Sampler

texture_descriptor: TextureDescriptor<Option<&'static str>, &'static [TextureFormat]>

texture_view_descriptor: Option<TextureViewDescriptor<Option<&'static str>>>

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.

pub fn view_format(&self) -> TextureFormat

Gets the view format of this image. If the view format is not explicitly provided, falls back to the base image format

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<(), Error>

Formats the value using the given formatter.

impl RenderAsset for GpuImage

fn prepare_asset( image: <GpuImage as RenderAsset>::SourceAsset, _: AssetId<<GpuImage as RenderAsset>::SourceAsset>, _: &mut <<GpuImage as RenderAsset>::Param as SystemParam>::Item<'_, '_>, previous_asset: Option<&GpuImage>, ) -> Result<GpuImage, PrepareAssetError<<GpuImage as RenderAsset>::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: &<GpuImage as RenderAsset>::SourceAsset, ) -> RenderAssetUsages

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

fn take_gpu_data( source: &mut <GpuImage as RenderAsset>::SourceAsset, previous_gpu_asset: Option<&GpuImage>, ) -> Result<<GpuImage as RenderAsset>::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: &<GpuImage as RenderAsset>::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 <Self::Param as SystemParam>::Item<'_, '_>, )

Called whenever the RenderAsset::SourceAsset has been removed.