Struct vulkano::image::view::ImageView

pub struct ImageView<I>where
    I: ImageAccess + ?Sized,{ /* private fields */ }

A wrapper around an image that makes it available to shaders or framebuffers.

Implementations

impl<I> ImageView<I>where
    I: ImageAccess + ?Sized,

pub fn new(
    image: Arc<I>,
    create_info: ImageViewCreateInfo
) -> Result<Arc<ImageView<I>>, ImageViewCreationError>

Creates a new ImageView.

Panics

• Panics if create_info.array_layers is empty.
• Panics if create_info.mip_levels is empty.
• Panics if create_info.aspects contains any aspects other than color, depth, stencil, plane0, plane1 or plane2.
• Panics if create_info.aspects contains more more than one aspect, unless depth and stencil are the only aspects selected.

pub fn new_default(
    image: Arc<I>
) -> Result<Arc<ImageView<I>>, ImageViewCreationError>

Creates a default ImageView. Equivalent to ImageView::new(image, ImageViewCreateInfo::from_image(image)).

pub unsafe fn from_handle(
    image: Arc<I>,
    handle: ImageView,
    create_info: ImageViewCreateInfo
) -> Result<Arc<Self>, VulkanError>

Creates a new ImageView from a raw object handle.

Safety

• handle must be a valid Vulkan object handle created from image.
• create_info must match the info used to create the object.

pub fn image(&self) -> &Arc<I>

Returns the wrapped image that this image view was created from.

Trait Implementations

impl<I: Debug> Debug for ImageView<I>where
    I: ImageAccess + ?Sized,

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

Formats the value using the given formatter.

impl<I> DeviceOwned for ImageView<I>where
    I: ImageAccess + ?Sized,

fn device(&self) -> &Arc<Device>

Returns the device that owns Self.

impl<I> Drop for ImageView<I>where
    I: ImageAccess + ?Sized,

fn drop(&mut self)

Executes the destructor for this type.

impl<I: ImageAccess + ?Sized> Hash for ImageView<I>

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<I> ImageViewAbstract for ImageView<I>where
    I: ImageAccess + Debug + 'static,

fn image(&self) -> Arc<dyn ImageAccess>

Returns the wrapped image that this image view was created from.

fn component_mapping(&self) -> ComponentMapping

Returns the component mapping of this view.

fn filter_cubic(&self) -> bool

Returns whether the image view supports sampling with a Cubic mag_filter or min_filter.

fn filter_cubic_minmax(&self) -> bool

Returns whether the image view supports sampling with a Cubic mag_filter or min_filter, and with a Min or Max reduction_mode.

fn format(&self) -> Option<Format>

Returns the format of this view. This can be different from the parent’s format.

fn format_features(&self) -> &FormatFeatures

Returns the features supported by the image view’s format.

fn sampler_ycbcr_conversion(&self) -> Option<&Arc<SamplerYcbcrConversion>>

Returns the sampler YCbCr conversion that this image view was created with, if any.

fn subresource_range(&self) -> &ImageSubresourceRange

Returns the subresource range of the wrapped image that this view exposes.

fn usage(&self) -> &ImageUsage

Returns the usage of the image view.

fn view_type(&self) -> ImageViewType

Returns the ImageViewType of this image view.

fn dimensions(&self) -> ImageDimensions

Returns the dimensions of this view.

impl ImageViewAbstract for ImageView<dyn ImageAccess>

fn image(&self) -> Arc<dyn ImageAccess>

Returns the wrapped image that this image view was created from.

fn component_mapping(&self) -> ComponentMapping

Returns the component mapping of this view.

fn filter_cubic(&self) -> bool

Returns whether the image view supports sampling with a Cubic mag_filter or min_filter.

fn filter_cubic_minmax(&self) -> bool

Returns whether the image view supports sampling with a Cubic mag_filter or min_filter, and with a Min or Max reduction_mode.

fn format(&self) -> Option<Format>

Returns the format of this view. This can be different from the parent’s format.

fn format_features(&self) -> &FormatFeatures

Returns the features supported by the image view’s format.

fn sampler_ycbcr_conversion(&self) -> Option<&Arc<SamplerYcbcrConversion>>

Returns the sampler YCbCr conversion that this image view was created with, if any.

fn subresource_range(&self) -> &ImageSubresourceRange

Returns the subresource range of the wrapped image that this view exposes.

fn usage(&self) -> &ImageUsage

Returns the usage of the image view.

fn view_type(&self) -> ImageViewType

Returns the ImageViewType of this image view.

fn dimensions(&self) -> ImageDimensions

Returns the dimensions of this view.

impl<I: ImageAccess + ?Sized> PartialEq<ImageView<I>> for ImageView<I>

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

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<I> VulkanObject for ImageView<I>where
    I: ImageAccess + ?Sized,

type Handle = ImageView

The type of the object.

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

Returns the raw Vulkan handle of the object.

impl<I: ImageAccess + ?Sized> Eq for ImageView<I>