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.
Methods
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> ImageAccess for SwapchainImage<W>
[src]
fn inner(&self) -> ImageInner
[src]
Returns the inner unsafe image object used by this image.
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]
Returns the layout that the image must be returned to before the end of the command buffer. Read more
fn conflicts_buffer(&self, other: &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: &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]
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]
Locks the resource for usage on the GPU. Returns an error if the lock can't be acquired. Read more
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]
Unlocks the resource previously acquired with try_gpu_lock
or increase_gpu_lock
. Read more
fn format(&self) -> Format
[src]
Returns the format of this image.
fn has_color(&self) -> bool
[src]
Returns true if the image is a color image.
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]
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]
Returns the number of mipmap levels of this image.
fn samples(&self) -> u32
[src]
Returns the number of samples of this image.
fn dimensions(&self) -> ImageDimensions
[src]
Returns the dimensions of the image.
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]
Returns true if the image can be used as a destination for blits.
unsafe fn forced_undefined_initial_layout(
self,
preinitialized: bool
) -> ImageAccessFromUndefinedLayout<Self> where
Self: Sized,
[src]
self,
preinitialized: bool
) -> ImageAccessFromUndefinedLayout<Self> where
Self: Sized,
Wraps around this ImageAccess
and returns an identical ImageAccess
but whose initial layout requirement is either Undefined
or Preinitialized
. Read more
impl<W> ImageClearValue<<Format as FormatDesc>::ClearValue> for SwapchainImage<W>
[src]
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]
fn matches_format(&self) -> bool
[src]
Checks whether pixels of type P
match the format of the image.
impl<W> ImageViewAccess for SwapchainImage<W>
[src]
fn parent(&self) -> &ImageAccess
[src]
fn dimensions(&self) -> Dimensions
[src]
Returns the dimensions of the image view.
fn inner(&self) -> &UnsafeImageView
[src]
Returns the inner unsafe image view object used by this image view.
fn descriptor_set_storage_image_layout(&self) -> ImageLayout
[src]
Returns the image layout to use in a descriptor with the given subresource.
fn descriptor_set_combined_image_sampler_layout(&self) -> ImageLayout
[src]
Returns the image layout to use in a descriptor with the given subresource.
fn descriptor_set_sampled_image_layout(&self) -> ImageLayout
[src]
Returns the image layout to use in a descriptor with the given subresource.
fn descriptor_set_input_attachment_layout(&self) -> ImageLayout
[src]
Returns the image layout to use in a descriptor with the given subresource.
fn identity_swizzle(&self) -> bool
[src]
Returns true if the view doesn't use components swizzling. Read more
fn format(&self) -> Format
[src]
Returns the format of this view. This can be different from the parent's format.
fn samples(&self) -> u32
[src]
fn can_be_sampled(&self, _sampler: &Sampler) -> bool
[src]
Returns true if the given sampler can be used with this image view. Read more
Auto Trait Implementations
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,