Struct vulkano::image::swapchain::SwapchainImage [−][src]
pub struct SwapchainImage<W> { /* fields omitted */ }
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]
impl<W> SwapchainImage<W>
[src]pub unsafe fn from_raw(
swapchain: Arc<Swapchain<W>>,
id: usize
) -> Result<Arc<SwapchainImage<W>>, OomError>
[src]
pub unsafe fn from_raw(
swapchain: Arc<Swapchain<W>>,
id: usize
) -> Result<Arc<SwapchainImage<W>>, OomError>
[src]Builds a SwapchainImage
from raw components.
This is an internal method that you shouldn’t call.
pub fn dimensions(&self) -> [u32; 2]
[src]
pub fn dimensions(&self) -> [u32; 2]
[src]Returns the dimensions of the image.
A SwapchainImage
is always two-dimensional.
Trait Implementations
impl<W> Hash for SwapchainImage<W>
[src]
impl<W> Hash for SwapchainImage<W>
[src]impl<W> ImageAccess for SwapchainImage<W>
[src]
impl<W> ImageAccess for SwapchainImage<W>
[src]fn inner(&self) -> ImageInner<'_>
[src]
fn inner(&self) -> ImageInner<'_>
[src]Returns the inner unsafe image object used by this image.
fn initial_layout_requirement(&self) -> ImageLayout
[src]
fn initial_layout_requirement(&self) -> ImageLayout
[src]Returns the layout that the image has when it is first used in a primary command buffer. Read more
fn final_layout_requirement(&self) -> ImageLayout
[src]
fn final_layout_requirement(&self) -> ImageLayout
[src]Returns the layout that the image must be returned to before the end of the command buffer. Read more
fn descriptor_layouts(&self) -> Option<ImageDescriptorLayouts>
[src]
fn descriptor_layouts(&self) -> Option<ImageDescriptorLayouts>
[src]Returns an ImageDescriptorLayouts
structure specifying the image layout to use
in descriptors of various kinds. Read more
fn conflicts_buffer(&self, other: &dyn BufferAccess) -> bool
[src]
fn conflicts_buffer(&self, other: &dyn BufferAccess) -> bool
[src]Returns true if an access to self
potentially overlaps the same memory as an
access to other
. Read more
fn conflicts_image(&self, other: &dyn ImageAccess) -> bool
[src]
fn conflicts_image(&self, other: &dyn ImageAccess) -> bool
[src]Returns true if an access to self
potentially overlaps the same memory as an
access to other
. Read more
fn conflict_key(&self) -> u64
[src]
fn conflict_key(&self) -> u64
[src]Returns a key that uniquely identifies the memory content of the image. Two ranges that potentially overlap in memory must return the same key. Read more
fn try_gpu_lock(&self, _: bool, _: ImageLayout) -> Result<(), AccessError>
[src]
fn try_gpu_lock(&self, _: bool, _: ImageLayout) -> Result<(), AccessError>
[src]Locks the resource for usage on the GPU. Returns an error if the lock can’t be acquired. Read more
unsafe fn layout_initialized(&self)
[src]
unsafe fn layout_initialized(&self)
[src]When images are created their memory layout is initially Undefined
or Preinitialized
.
This method allows the image memory barrier creation process to signal when an image
has been transitioned out of its initial Undefined
or Preinitialized
state. This
allows vulkano to avoid creating unnecessary image memory barriers between future
uses of the image. Read more
fn is_layout_initialized(&self) -> bool
[src]
unsafe fn increase_gpu_lock(&self)
[src]
unsafe fn increase_gpu_lock(&self)
[src]Locks the resource for usage on the GPU. Supposes that the resource is already locked, and simply increases the lock by one. Read more
unsafe fn unlock(&self, _: Option<ImageLayout>)
[src]
unsafe fn unlock(&self, _: Option<ImageLayout>)
[src]Unlocks the resource previously acquired with try_gpu_lock
or increase_gpu_lock
. Read more
fn current_miplevels_access(&self) -> Range<u32>
[src]
fn current_miplevels_access(&self) -> Range<u32>
[src]Returns the current mip level that is accessed by the gpu
fn current_layer_levels_access(&self) -> Range<u32>
[src]
fn current_layer_levels_access(&self) -> Range<u32>
[src]Returns the current layer level that is accessed by the gpu
fn has_depth(&self) -> bool
[src]
fn has_depth(&self) -> bool
[src]Returns true if the image has a depth component. In other words, if it is a depth or a depth-stencil format. Read more
fn has_stencil(&self) -> bool
[src]
fn has_stencil(&self) -> bool
[src]Returns true if the image has a stencil component. In other words, if it is a stencil or a depth-stencil format. Read more
fn mipmap_levels(&self) -> u32
[src]
fn mipmap_levels(&self) -> u32
[src]Returns the number of mipmap levels of this image.
fn dimensions(&self) -> ImageDimensions
[src]
fn dimensions(&self) -> ImageDimensions
[src]Returns the dimensions of the image.
fn supports_blit_source(&self) -> bool
[src]
fn supports_blit_source(&self) -> bool
[src]Returns true if the image can be used as a source for blits.
fn supports_blit_destination(&self) -> bool
[src]
fn supports_blit_destination(&self) -> bool
[src]Returns true if the image can be used as a destination for blits.
unsafe fn preinitialized_layout(&self) -> bool
[src]
unsafe fn forced_undefined_initial_layout(
self,
preinitialized: bool
) -> ImageAccessFromUndefinedLayout<Self> where
Self: Sized,
[src]
unsafe fn forced_undefined_initial_layout(
self,
preinitialized: bool
) -> ImageAccessFromUndefinedLayout<Self> where
Self: Sized,
[src]Wraps around this ImageAccess
and returns an identical ImageAccess
but whose initial
layout requirement is either Undefined
or Preinitialized
. Read more
impl<W> ImageClearValue<ClearValue> for SwapchainImage<W>
[src]
impl<W> ImageClearValue<ClearValue> for SwapchainImage<W>
[src]fn decode(&self, value: ClearValue) -> Option<ClearValue>
[src]
impl<P, W> ImageContent<P> for SwapchainImage<W>
[src]
impl<P, W> ImageContent<P> for SwapchainImage<W>
[src]fn matches_format(&self) -> bool
[src]
fn matches_format(&self) -> bool
[src]Checks whether pixels of type P
match the format of the image.
impl<W> PartialEq<SwapchainImage<W>> for SwapchainImage<W>
[src]
impl<W> PartialEq<SwapchainImage<W>> for SwapchainImage<W>
[src]impl<W> Eq for SwapchainImage<W>
[src]
Auto Trait Implementations
impl<W> RefUnwindSafe for SwapchainImage<W> where
W: RefUnwindSafe,
W: RefUnwindSafe,
impl<W> Send for SwapchainImage<W> where
W: Send + Sync,
W: Send + Sync,
impl<W> Sync for SwapchainImage<W> where
W: Send + Sync,
W: Send + Sync,
impl<W> Unpin for SwapchainImage<W>
impl<W> UnwindSafe for SwapchainImage<W> where
W: RefUnwindSafe,
W: RefUnwindSafe,
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> Content for T
[src]
impl<T> Content for T
[src]pub fn ref_from_ptr(*mut c_void, usize) -> Option<*mut T>
[src]
pub fn ref_from_ptr(*mut c_void, usize) -> Option<*mut T>
[src]Builds a pointer to this type from a raw pointer.
pub fn is_size_suitable(usize) -> bool
[src]
pub fn is_size_suitable(usize) -> bool
[src]Returns true if the size is suitable to store a type like this.
pub fn indiv_size() -> usize
[src]
pub fn indiv_size() -> usize
[src]Returns the size of an individual element.