[−][src]Struct vulkano::image::swapchain::SwapchainImage
An image that is part of a swapchain.
Creating a SwapchainImage
is automatically done when creating a swapchain.
A swapchain image is special in the sense that it can only be used after being acquired by
calling the acquire
method on the swapchain. You have no way to know in advance which
swapchain image is going to be acquired, so you should keep all of them alive.
After a swapchain image has been acquired, you are free to perform all the usual operations on it. When you are done you can then present the image (by calling the corresponding method on the swapchain), which will have the effect of showing the content of the image to the screen. Once an image has been presented, it can no longer be used unless it is acquired again.
Implementations
impl<W> SwapchainImage<W>
[src]
pub unsafe fn from_raw(
swapchain: Arc<Swapchain<W>>,
id: usize
) -> Result<Arc<SwapchainImage<W>>, OomError>
[src]
swapchain: Arc<Swapchain<W>>,
id: usize
) -> Result<Arc<SwapchainImage<W>>, OomError>
Builds a SwapchainImage
from raw components.
This is an internal method that you shouldn't call.
pub fn dimensions(&self) -> [u32; 2]
[src]
Returns the dimensions of the image.
A SwapchainImage
is always two-dimensional.
pub fn swapchain(&self) -> &Arc<Swapchain<W>>
[src]
Returns the swapchain this image belongs to.
Trait Implementations
impl<W> Eq for SwapchainImage<W>
[src]
impl<W> Hash for SwapchainImage<W>
[src]
pub fn hash<H: Hasher>(&self, state: &mut H)
[src]
pub fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl<W> ImageAccess for SwapchainImage<W>
[src]
pub fn inner(&self) -> ImageInner<'_>
[src]
pub fn initial_layout_requirement(&self) -> ImageLayout
[src]
pub fn final_layout_requirement(&self) -> ImageLayout
[src]
pub fn conflicts_buffer(&self, other: &dyn BufferAccess) -> bool
[src]
pub fn conflicts_image(&self, other: &dyn ImageAccess) -> bool
[src]
pub fn conflict_key(&self) -> u64
[src]
pub fn try_gpu_lock(&self, _: bool, _: ImageLayout) -> Result<(), AccessError>
[src]
pub unsafe fn layout_initialized(&self)
[src]
pub fn is_layout_initialized(&self) -> bool
[src]
pub unsafe fn increase_gpu_lock(&self)
[src]
pub unsafe fn unlock(&self, _: Option<ImageLayout>)
[src]
pub fn current_miplevels_access(&self) -> Range<u32>
[src]
pub fn current_layer_levels_access(&self) -> Range<u32>
[src]
pub fn format(&self) -> Format
[src]
pub fn has_color(&self) -> bool
[src]
pub fn has_depth(&self) -> bool
[src]
pub fn has_stencil(&self) -> bool
[src]
pub fn mipmap_levels(&self) -> u32
[src]
pub fn samples(&self) -> u32
[src]
pub fn dimensions(&self) -> ImageDimensions
[src]
pub fn supports_blit_source(&self) -> bool
[src]
pub fn supports_blit_destination(&self) -> bool
[src]
pub unsafe fn preinitialized_layout(&self) -> bool
[src]
pub unsafe fn forced_undefined_initial_layout(
self,
preinitialized: bool
) -> ImageAccessFromUndefinedLayout<Self> where
Self: Sized,
[src]
self,
preinitialized: bool
) -> ImageAccessFromUndefinedLayout<Self> where
Self: Sized,
impl<W> ImageClearValue<<Format as FormatDesc>::ClearValue> for SwapchainImage<W>
[src]
pub fn decode(
&self,
value: <Format as FormatDesc>::ClearValue
) -> Option<ClearValue>
[src]
&self,
value: <Format as FormatDesc>::ClearValue
) -> Option<ClearValue>
impl<P, W> ImageContent<P> for SwapchainImage<W>
[src]
pub fn matches_format(&self) -> bool
[src]
impl<W> ImageViewAccess for SwapchainImage<W>
[src]
pub fn parent(&self) -> &dyn ImageAccess
[src]
pub fn dimensions(&self) -> Dimensions
[src]
pub fn inner(&self) -> &UnsafeImageView
[src]
pub fn descriptor_set_storage_image_layout(&self) -> ImageLayout
[src]
pub fn descriptor_set_combined_image_sampler_layout(&self) -> ImageLayout
[src]
pub fn descriptor_set_sampled_image_layout(&self) -> ImageLayout
[src]
pub fn descriptor_set_input_attachment_layout(&self) -> ImageLayout
[src]
pub fn identity_swizzle(&self) -> bool
[src]
pub fn format(&self) -> Format
[src]
pub fn samples(&self) -> u32
[src]
pub fn can_be_sampled(&self, _sampler: &Sampler) -> bool
[src]
impl<W> PartialEq<SwapchainImage<W>> for SwapchainImage<W>
[src]
Auto Trait Implementations
impl<W> RefUnwindSafe for SwapchainImage<W> where
W: RefUnwindSafe,
[src]
W: RefUnwindSafe,
impl<W> Send for SwapchainImage<W> where
W: Send + Sync,
[src]
W: Send + Sync,
impl<W> Sync for SwapchainImage<W> where
W: Send + Sync,
[src]
W: Send + Sync,
impl<W> Unpin for SwapchainImage<W>
[src]
impl<W> UnwindSafe for SwapchainImage<W> where
W: RefUnwindSafe,
[src]
W: RefUnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Content for T
[src]
pub fn ref_from_ptr(*mut c_void, usize) -> Option<*mut T>
[src]
pub fn is_size_suitable(usize) -> bool
[src]
pub fn indiv_size() -> usize
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,