pub struct ImmutableImage<A = PotentialDedicatedAllocation<StdMemoryPoolAlloc>> { /* private fields */ }
Expand description
Image whose purpose is to be used for read-only purposes. You can write to the image once, but then you must only ever read from it.
Implementations
sourceimpl ImmutableImage
impl ImmutableImage
pub fn new<'a, I>(
device: Arc<Device>,
dimensions: ImageDimensions,
format: Format,
queue_families: I
) -> Result<Arc<ImmutableImage>, ImageCreationError> where
I: IntoIterator<Item = QueueFamily<'a>>,
use ImmutableImage::uninitialized instead
pub fn with_mipmaps<'a, I, M>(
device: Arc<Device>,
dimensions: ImageDimensions,
format: Format,
mip_levels: M,
queue_families: I
) -> Result<Arc<ImmutableImage>, ImageCreationError> where
I: IntoIterator<Item = QueueFamily<'a>>,
M: Into<MipmapsCount>,
use ImmutableImage::uninitialized instead
sourcepub fn uninitialized<'a, I, M>(
device: Arc<Device>,
dimensions: ImageDimensions,
format: Format,
mip_levels: M,
usage: ImageUsage,
flags: ImageCreateFlags,
layout: ImageLayout,
queue_families: I
) -> Result<(Arc<ImmutableImage>, Arc<ImmutableImageInitialization>), ImageCreationError> where
I: IntoIterator<Item = QueueFamily<'a>>,
M: Into<MipmapsCount>,
pub fn uninitialized<'a, I, M>(
device: Arc<Device>,
dimensions: ImageDimensions,
format: Format,
mip_levels: M,
usage: ImageUsage,
flags: ImageCreateFlags,
layout: ImageLayout,
queue_families: I
) -> Result<(Arc<ImmutableImage>, Arc<ImmutableImageInitialization>), ImageCreationError> where
I: IntoIterator<Item = QueueFamily<'a>>,
M: Into<MipmapsCount>,
Builds an uninitialized immutable image.
Returns two things: the image, and a special access that should be used for the initial upload to the image.
sourcepub fn from_iter<Px, I>(
iter: I,
dimensions: ImageDimensions,
mip_levels: MipmapsCount,
format: Format,
queue: Arc<Queue>
) -> Result<(Arc<Self>, CommandBufferExecFuture<NowFuture, PrimaryAutoCommandBuffer>), ImageCreationError> where
[Px]: BufferContents,
I: IntoIterator<Item = Px>,
I::IntoIter: ExactSizeIterator,
pub fn from_iter<Px, I>(
iter: I,
dimensions: ImageDimensions,
mip_levels: MipmapsCount,
format: Format,
queue: Arc<Queue>
) -> Result<(Arc<Self>, CommandBufferExecFuture<NowFuture, PrimaryAutoCommandBuffer>), ImageCreationError> where
[Px]: BufferContents,
I: IntoIterator<Item = Px>,
I::IntoIter: ExactSizeIterator,
Construct an ImmutableImage from the contents of iter
.
sourcepub fn from_buffer(
source: Arc<dyn BufferAccess>,
dimensions: ImageDimensions,
mip_levels: MipmapsCount,
format: Format,
queue: Arc<Queue>
) -> Result<(Arc<Self>, CommandBufferExecFuture<NowFuture, PrimaryAutoCommandBuffer>), ImageCreationError>
pub fn from_buffer(
source: Arc<dyn BufferAccess>,
dimensions: ImageDimensions,
mip_levels: MipmapsCount,
format: Format,
queue: Arc<Queue>
) -> Result<(Arc<Self>, CommandBufferExecFuture<NowFuture, PrimaryAutoCommandBuffer>), ImageCreationError>
Construct an ImmutableImage containing a copy of the data in source
.
Trait Implementations
sourceimpl<A: Debug> Debug for ImmutableImage<A>
impl<A: Debug> Debug for ImmutableImage<A>
sourceimpl<A> Hash for ImmutableImage<A> where
A: MemoryPoolAlloc,
impl<A> Hash for ImmutableImage<A> where
A: MemoryPoolAlloc,
sourceimpl<A> ImageAccess for ImmutableImage<A> where
A: MemoryPoolAlloc,
impl<A> ImageAccess for ImmutableImage<A> where
A: MemoryPoolAlloc,
sourcefn inner(&self) -> ImageInner<'_>
fn inner(&self) -> ImageInner<'_>
Returns the inner unsafe image object used by this image.
fn is_layout_initialized(&self) -> bool
sourcefn initial_layout_requirement(&self) -> ImageLayout
fn initial_layout_requirement(&self) -> ImageLayout
Returns the layout that the image has when it is first used in a primary command buffer. Read more
sourcefn final_layout_requirement(&self) -> ImageLayout
fn final_layout_requirement(&self) -> ImageLayout
Returns the layout that the image must be returned to before the end of the command buffer. Read more
sourcefn descriptor_layouts(&self) -> Option<ImageDescriptorLayouts>
fn descriptor_layouts(&self) -> Option<ImageDescriptorLayouts>
Returns an ImageDescriptorLayouts
structure specifying the image layout to use
in descriptors of various kinds. Read more
sourcefn conflict_key(&self) -> u64
fn conflict_key(&self) -> u64
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
sourcefn try_gpu_lock(
&self,
exclusive_access: bool,
uninitialized_safe: bool,
expected_layout: ImageLayout
) -> Result<(), AccessError>
fn try_gpu_lock(
&self,
exclusive_access: bool,
uninitialized_safe: bool,
expected_layout: ImageLayout
) -> Result<(), AccessError>
Locks the resource for usage on the GPU. Returns an error if the lock can’t be acquired. Read more
sourceunsafe fn increase_gpu_lock(&self)
unsafe fn increase_gpu_lock(&self)
Locks the resource for usage on the GPU. Supposes that the resource is already locked, and simply increases the lock by one. Read more
sourceunsafe fn unlock(&self, new_layout: Option<ImageLayout>)
unsafe fn unlock(&self, new_layout: Option<ImageLayout>)
Unlocks the resource previously acquired with try_gpu_lock
or increase_gpu_lock
. Read more
sourcefn current_mip_levels_access(&self) -> Range<u32>
fn current_mip_levels_access(&self) -> Range<u32>
Returns the current mip level that is accessed by the gpu
sourcefn current_array_layers_access(&self) -> Range<u32>
fn current_array_layers_access(&self) -> Range<u32>
Returns the current array layer that is accessed by the gpu
sourcefn mip_levels(&self) -> u32
fn mip_levels(&self) -> u32
Returns the number of mipmap levels of this image.
sourcefn samples(&self) -> SampleCount
fn samples(&self) -> SampleCount
Returns the number of samples of this image.
sourcefn dimensions(&self) -> ImageDimensions
fn dimensions(&self) -> ImageDimensions
Returns the dimensions of the image.
sourcefn format_features(&self) -> &FormatFeatures
fn format_features(&self) -> &FormatFeatures
Returns the features supported by the image’s format.
sourceunsafe fn layout_initialized(&self)
unsafe fn layout_initialized(&self)
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
unsafe fn initial_layout(&self) -> ImageLayout
sourceunsafe fn forced_undefined_initial_layout(
self,
preinitialized: bool
) -> Arc<ImageAccessFromUndefinedLayout<Self>> where
Self: Sized,
unsafe fn forced_undefined_initial_layout(
self,
preinitialized: bool
) -> Arc<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
sourceimpl<P, A> ImageContent<P> for ImmutableImage<A> where
A: MemoryPoolAlloc,
impl<P, A> ImageContent<P> for ImmutableImage<A> where
A: MemoryPoolAlloc,
sourcefn matches_format(&self) -> bool
fn matches_format(&self) -> bool
Checks whether pixels of type P
match the format of the image.
sourceimpl<A> PartialEq<ImmutableImage<A>> for ImmutableImage<A> where
A: MemoryPoolAlloc,
impl<A> PartialEq<ImmutableImage<A>> for ImmutableImage<A> where
A: MemoryPoolAlloc,
impl<A> Eq for ImmutableImage<A> where
A: MemoryPoolAlloc,
Auto Trait Implementations
impl<A> RefUnwindSafe for ImmutableImage<A> where
A: RefUnwindSafe,
impl<A> Send for ImmutableImage<A> where
A: Send,
impl<A> Sync for ImmutableImage<A> where
A: Sync,
impl<A> Unpin for ImmutableImage<A> where
A: Unpin,
impl<A> UnwindSafe for ImmutableImage<A> where
A: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more