Struct vulkano::image::view::ImageView

source · [−]

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

Expand description

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_default(image, ImageViewCreateInfo::from_image(image)).

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

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

Trait Implementations

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

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

Formats the value using the given formatter. Read more

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. Read more

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

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

Feeds this value into the given Hasher. Read more

1.3.0 · source

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

Feeds a slice of this type into the given Hasher. Read more

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

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

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

fn array_layers(&self) -> Range<u32>

Returns the range of array layers of the wrapped image that this view exposes.

fn aspects(&self) -> &ImageAspects

Returns the aspects of the wrapped image that this view exposes.

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. Read more

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. Read more

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 mip_levels(&self) -> Range<u32>

Returns the range of mip levels of the wrapped image that this view exposes.

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

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

fn usage(&self) -> &ImageUsage

Returns the usage of the image view.

fn view_type(&self) -> ImageViewType

Returns the ImageViewType of this image 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 array_layers(&self) -> Range<u32>

Returns the range of array layers of the wrapped image that this view exposes.

fn aspects(&self) -> &ImageAspects

Returns the aspects of the wrapped image that this view exposes.

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. Read more

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. Read more

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 mip_levels(&self) -> Range<u32>

Returns the range of mip levels of the wrapped image that this view exposes.

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

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

fn usage(&self) -> &ImageUsage

Returns the usage of the image view.

fn view_type(&self) -> ImageViewType

Returns the ImageViewType of this image view.

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

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

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

1.0.0 · source

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

This method tests for !=.

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

type Object = ImageView

The type of the object.

fn internal_object(&self) -> ImageView

Returns a reference to the object.

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

Auto Trait Implementations

impl<I: ?Sized> RefUnwindSafe for ImageView<I> where
I: RefUnwindSafe,

impl<I: ?Sized> Send for ImageView<I>

impl<I: ?Sized> Sync for ImageView<I>

impl<I: ?Sized> Unpin for ImageView<I>

impl<I: ?Sized> UnwindSafe for ImageView<I> where
I: RefUnwindSafe,

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.