Struct vulkayes_core::resource::image::image::Image

pub struct Image { /* fields omitted */ }

Implementations

impl Image

pub fn new<A: ImageMemoryAllocator>(
    device: Vrc<Device>,
    format: Format,
    size_info: ImageSizeInfo,
    tiling_and_layout: ImageTilingAndLayout,
    usage: ImageUsageFlags,
    sharing_mode: SharingMode<impl AsRef<[u32]>>,
    allocator_param: ImageAllocatorParams<'_, A>,
    host_memory_allocator: HostMemoryAllocator
) -> Result<Vrc<Self>, ImageError<A::Error>>

pub unsafe fn from_create_info<A: ImageMemoryAllocator>(
    device: Vrc<Device>,
    create_info: impl Deref<Target = ImageCreateInfo>,
    allocator_params: ImageAllocatorParams<'_, A>,
    host_memory_allocator: HostMemoryAllocator
) -> Result<Vrc<Self>, ImageError<A::Error>>

Creates a new Image from existing ImageCreateInfo

Safety

See https://www.khronos.org/registry/vulkan/specs/1.2-extensions/man/html/vkCreateImage.html.

pub unsafe fn from_existing(
    device: Vrc<Device>,
    image: Image,
    memory: Option<DeviceMemoryAllocation>,
    usage: ImageUsageFlags,
    format: Format,
    size: ImageSize,
    host_memory_allocator: HostMemoryAllocator
) -> Self

Crates a new Image from existing VkImage.

Safety

• image must have been crated from the device.
• memory must have been allocated from the device.
• All parameters must match the parameters used when creating the image.

pub const fn device(&self) -> &Vrc<Device>

pub const fn usage(&self) -> ImageUsageFlags

pub const fn size(&self) -> ImageSize

pub const fn format(&self) -> Format

pub fn memory(&self) -> Option<&DeviceMemoryAllocation>

Methods from Deref<Target = Image>

Trait Implementations

impl Borrow<Image> for Image

fn borrow(&self) -> &Image

Immutably borrows from an owned value.

impl Debug for Image

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

Formats the value using the given formatter.

impl Deref for Image

type Target = Image

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Drop for Image

fn drop(&mut self)

Executes the destructor for this type.

impl Eq for Image

impl HasHandle<Image> for Image

fn handle(&self) -> T

fn safe_handle(&self) -> SafeHandle<'_, T>

Returns a safe handle borrowed from self.

impl Hash for Image

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Image

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Image> for Image

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Image> for Image

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.