Struct ImageObject

pub struct ImageObject<Device: VkHandle<Handle = VkDevice>>(/* private fields */);

Opaque handle to a image object(constructed via ImageDesc)

Implementations

impl<Device: VkHandle<Handle = VkDevice>> ImageObject<Device>

pub const unsafe fn manage( handle: VkImage, parent: Device, image_type: VkImageType, format: VkFormat, extent: VkExtent3D, ) -> Self

Constructs from raw values

Safety

the resource must be created from the parent

pub const fn unmanage( self, ) -> (VkImage, Device, VkImageType, VkFormat, VkExtent3D)

Purges internal values (Drop will not be called for this resource)

impl<Device: VkHandle<Handle = VkDevice> + Clone> ImageObject<&Device>

pub fn clone_parent(self) -> ImageObject<Device>

Owning parent object by cloning it.

impl<Device: Device> ImageObject<Device>

pub fn new(device: Device, info: &ImageCreateInfo<'_>) -> Result<Self>

Create a new image object

Failure

On failure, this command returns

• VK_ERROR_OUT_OF_HOST_MEMORY
• VK_ERROR_OUT_OF_DEVICE_MEMORY
• [VK_ERROR_COMPRESSION_EXHAUSTED_EXT]
• [VK_ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS_KHR]

Trait Implementations

impl<Device: Device> DeviceChild for ImageObject<Device>

type ConcreteDevice = Device

A concrete type of the parent device object.

fn device(&self) -> &Self::ConcreteDevice

Retrieve a reference to a device object that creates this object

impl<Device: VkHandle<Handle = VkDevice>> DeviceChildHandle for ImageObject<Device>

fn device_handle(&self) -> VkDevice

Retrieve a reference to a device handle that creates this objecs

impl<Device: VkHandle<Handle = VkDevice>> Drop for ImageObject<Device>

fn drop(&mut self)

Executes the destructor for this type.

impl<Device: VkHandle<Handle = VkDevice>> Image for ImageObject<Device>

fn format(&self) -> VkFormat

The pixel format of an image

fn size(&self) -> &VkExtent3D

The size of an image

fn dimension(&self) -> VkImageViewType

fn sparse_requirement_count(&self) -> u32

Query a count of the memory requirements for a sparse image

fn sparse_requirements( &self, sink: &mut [MaybeUninit<VkSparseImageMemoryRequirements>], ) -> u32

Query the memory requirements for a sparse image

fn sparse_requirements_alloc(&self) -> Vec<VkSparseImageMemoryRequirements>

Query the memory requirements for a sparse image

fn layout_info(&self, subresource: &ImageSubresource) -> VkSubresourceLayout

Retrieve information about an image subresource

fn memory_barrier( &self, subresource_range: ImageSubresourceRange, trans: LayoutTransition, ) -> ImageMemoryBarrier

fn memory_barrier2<'r>( &'r self, subresource_range: ImageSubresourceRange, ) -> ImageMemoryBarrier2<'r>

impl<Device: VkHandle<Handle = VkDevice>> MemoryBound for ImageObject<Device>

type MemoryRequirementsInfo2<'b> = ImageMemoryRequirementsInfo2<'b, ImageObject<Device>> where Device: 'b

fn requirements(&self) -> VkMemoryRequirements

Returns the memory requirements for specified Vulkan object

fn requirements2<'b>(&'b self) -> Self::MemoryRequirementsInfo2<'b>

fn bind( &mut self, memory: &(impl VkHandle<Handle = VkDeviceMemory> + ?Sized), offset: usize, ) -> Result<()>

where Self: VkHandleMut,

Bind device memory to the object

impl<Device: VkHandle<Handle = VkDevice>> VkHandle for ImageObject<Device>

type Handle = VkImage

fn native_ptr(&self) -> Self::Handle

Retrieve an underlying handle

fn as_transparent_ref(&self) -> VkHandleRef<'_, Self::Handle>

impl<Device: VkHandle<Handle = VkDevice>> VkHandleMut for ImageObject<Device>

fn native_ptr_mut(&mut self) -> Self::Handle

Retrieve an underlying mutable handle

fn as_transparent_ref_mut(&mut self) -> VkHandleRefMut<'_, Self::Handle>

impl<Device: VkHandle<Handle = VkDevice>> VkObject for ImageObject<Device>

const TYPE: VkObjectType = 10i32

impl<Device: VkHandle<Handle = VkDevice> + Send> Send for ImageObject<Device>

impl<Device: VkHandle<Handle = VkDevice> + Sync> Sync for ImageObject<Device>