Struct vulkano::image::sys::UnsafeImage [−][src]
pub struct UnsafeImage { /* fields omitted */ }
Expand description
A storage for pixels or arbitrary data.
Safety
This type is not just unsafe but very unsafe. Don’t use it directly.
- You must manually bind memory to the image with
bind_memory
. The memory must respect the requirements returned bynew
. - The memory that you bind to the image must be manually kept alive.
- The queue family ownership must be manually enforced.
- The usage must be manually enforced.
- The image layout must be manually enforced and transitioned.
Implementations
pub unsafe fn new<'a, Mi, I>(
device: Arc<Device>,
usage: ImageUsage,
format: Format,
flags: ImageCreateFlags,
dimensions: ImageDimensions,
num_samples: SampleCount,
mipmaps: Mi,
sharing: Sharing<I>,
linear_tiling: bool,
preinitialized_layout: bool
) -> Result<(UnsafeImage, MemoryRequirements), ImageCreationError> where
Mi: Into<MipmapsCount>,
I: IntoIterator<Item = u32>,
pub unsafe fn new<'a, Mi, I>(
device: Arc<Device>,
usage: ImageUsage,
format: Format,
flags: ImageCreateFlags,
dimensions: ImageDimensions,
num_samples: SampleCount,
mipmaps: Mi,
sharing: Sharing<I>,
linear_tiling: bool,
preinitialized_layout: bool
) -> Result<(UnsafeImage, MemoryRequirements), ImageCreationError> where
Mi: Into<MipmapsCount>,
I: IntoIterator<Item = u32>,
Creates a new image and allocates memory for it.
Panic
- Panics if one of the dimensions is 0.
- Panics if the number of mipmaps is 0.
- Panics if the number of samples is 0.
pub unsafe fn from_raw(
device: Arc<Device>,
handle: Image,
usage: ImageUsage,
format: Format,
flags: ImageCreateFlags,
dimensions: ImageDimensions,
samples: SampleCount,
mipmaps: u32
) -> UnsafeImage
pub unsafe fn from_raw(
device: Arc<Device>,
handle: Image,
usage: ImageUsage,
format: Format,
flags: ImageCreateFlags,
dimensions: ImageDimensions,
samples: SampleCount,
mipmaps: u32
) -> UnsafeImage
Creates an image from a raw handle. The image won’t be destroyed.
This function is for example used at the swapchain’s initialization.
pub unsafe fn bind_memory(
&self,
memory: &DeviceMemory,
offset: DeviceSize
) -> Result<(), OomError>
Returns a key unique to each UnsafeImage
. Can be used for the conflicts_key
method.
Queries the layout of an image in memory. Only valid for images with linear tiling.
This function is only valid for images with a color format. See the other similar functions for the other aspects.
The layout is invariant for each image. However it is not cached, as this would waste memory in the case of non-linear-tiling images. You are encouraged to store the layout somewhere in order to avoid calling this semi-expensive function at every single memory access.
Note that while Vulkan allows querying the array layers other than 0, it is redundant as you can easily calculate the position of any layer.
Panic
- Panics if the mipmap level is out of range.
Safety
- The image must not have a depth, stencil or depth-stencil format.
- The image must have been created with linear tiling.
Same as color_linear_layout
, except that it retrieves layout for the requested YCbCr
component too if the format is a YCbCr format.
Panic
- Panics if plane aspect is out of range.
- Panics if the aspect is not a color or planar aspect.
- Panics if the number of mipmaps is not 1.
Returns the flags the image was created with.
Returns the features supported by the image’s format.
Returns the usage the image was created with.
Trait Implementations
Returns a reference to the object.
Auto Trait Implementations
impl RefUnwindSafe for UnsafeImage
impl Send for UnsafeImage
impl Sync for UnsafeImage
impl Unpin for UnsafeImage
impl UnwindSafe for UnsafeImage
Blanket Implementations
Mutably borrows from an owned value. Read more
Builds a pointer to this type from a raw pointer.
Returns true if the size is suitable to store a type like this.
Returns the size of an individual element.