Struct Image

pub struct Image<B: Backend> { /* private fields */ }

Generic image resource wrapper.

Parameters

B - raw image type.

Implementations

impl<B> Image<B>

where B: Backend,

pub fn device_id(&self) -> DeviceId

Get owned id.

pub fn assert_device_owner(&self, device: &Device<B>)

Assert specified device is owner.

pub fn instance_id(&self) -> InstanceId

Get owned id.

pub fn assert_instance_owner(&self, instance: &Instance<B>)

Assert specified instance is owner.

impl<B> Image<B>

where B: Backend,

pub unsafe fn create( device: &Device<B>, heaps: &mut Heaps<B>, info: ImageInfo, memory_usage: impl MemoryUsage, ) -> Result<Self, ImageCreationError>

Create image.

Safety

In order to guarantee that Heap::allocate will return memory range owned by this Device, this Heaps instance must always be used with this Device instance.

Otherwise usage of hal methods must be always valid.

pub unsafe fn create_from_swapchain( device: DeviceId, info: ImageInfo, raw: B::Image, ) -> Self

Create image handler for swapchain image.

pub unsafe fn dispose(self, device: &Device<B>, heaps: &mut Heaps<B>)

Destroy image resource.

pub unsafe fn dispose_swapchain_image(self, device: DeviceId)

Drop image wrapper for swapchain image.

pub fn raw(&self) -> &B::Image

Get reference for raw image resource.

pub unsafe fn raw_mut(&mut self) -> &mut B::Image

Get mutable reference for raw image resource.

pub fn block(&self) -> Option<&MemoryBlock<B>>

Get reference to memory block occupied by image.

pub unsafe fn block_mut(&mut self) -> Option<&mut MemoryBlock<B>>

Get mutable reference to memory block occupied by image.

pub fn info(&self) -> &ImageInfo

Get image info.

pub fn kind(&self) -> Kind

Get Kind of the image.

pub fn format(&self) -> Format

Get Format of the image.

pub fn levels(&self) -> u8

Get levels count of the image.

pub fn layers(&self) -> u16

Get layers count of the image.

Trait Implementations

impl<B: Debug + Backend> Debug for Image<B>

where B::Image: Debug,

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

Formats the value using the given formatter.