Skip to main content

ImageCreateInfo

Struct ImageCreateInfo 

Source
pub struct ImageCreateInfo<'a> {
Show 15 fields pub s_type: StructureType, pub p_next: *const c_void, pub flags: ImageCreateFlags, pub image_type: ImageType, pub format: Format, pub extent: Extent3D, pub mip_levels: u32, pub array_layers: u32, pub samples: SampleCountFlagBits, pub tiling: ImageTiling, pub usage: ImageUsageFlags, pub sharing_mode: SharingMode, pub queue_family_index_count: u32, pub p_queue_family_indices: *const u32, pub initial_layout: ImageLayout, /* private fields */
}
Expand description

Native structure VkImageCreateInfo.

Khronos reference: VkImageCreateInfo

Fields§

§s_type: StructureType

Native field sType.

§p_next: *const c_void

Native field pNext.

§flags: ImageCreateFlags

Native field flags.

§image_type: ImageType

Native field imageType.

§format: Format

Native field format.

§extent: Extent3D

Native field extent.

§mip_levels: u32

Native field mipLevels.

§array_layers: u32

Native field arrayLayers.

§samples: SampleCountFlagBits

Native field samples.

§tiling: ImageTiling

Native field tiling.

§usage: ImageUsageFlags

Native field usage.

§sharing_mode: SharingMode

Native field sharingMode.

§queue_family_index_count: u32

Native field queueFamilyIndexCount.

§p_queue_family_indices: *const u32

Native field pQueueFamilyIndices.

§initial_layout: ImageLayout

Native field initialLayout.

Implementations§

Source§

impl<'a> ImageCreateInfo<'a>

Source

pub fn new() -> Self

Construct the record with its canonical sType tag and default native state.

Source

pub fn set_flags(self, value: ImageCreateFlags) -> Self

Set native field flags without native effects.

Source

pub fn set_image_type(self, value: ImageType) -> Self

Set native field imageType without native effects.

Source

pub fn set_format(self, value: Format) -> Self

Set native field format without native effects.

Source

pub fn set_extent(self, value: Extent3D) -> Self

Set native field extent without native effects.

Source

pub fn set_mip_levels(self, value: u32) -> Self

Set native field mipLevels without native effects.

Source

pub fn set_array_layers(self, value: u32) -> Self

Set native field arrayLayers without native effects.

Source

pub fn set_samples(self, value: SampleCountFlagBits) -> Self

Set native field samples without native effects.

Source

pub fn set_tiling(self, value: ImageTiling) -> Self

Set native field tiling without native effects.

Source

pub fn set_usage(self, value: ImageUsageFlags) -> Self

Set native field usage without native effects.

Source

pub fn set_sharing_mode(self, value: SharingMode) -> Self

Set native field sharingMode without native effects.

Source

pub fn set_queue_family_index_count(self, value: u32) -> Self

Set native count queueFamilyIndexCount directly without checking associated pointer extents. Use the borrowed array helpers to derive matching storage and counts together. Direct count edits support null-query/dynamic-state paths and remain a native-call validity obligation, including after earlier borrowed setters.

Source

pub fn set_queue_family_indices( self, value: &'a [u32], ) -> Result<Self, ConstructionError>

Borrow pQueueFamilyIndices and set checked native count queueFamilyIndexCount. The borrow covers this storage only; nested raw pointers, format, alignment and asynchronous retention remain native-call obligations. Output storage must be initialized; returned sizes do not enlarge its capacity.

§Errors

Returns a construction error if the length exceeds the native count width.

Source

pub fn set_initial_layout(self, value: ImageLayout) -> Self

Set native field initialLayout without native effects.

Source

pub fn push_next<T: Extends<Self>>( self, next: &'a mut T, ) -> Result<Self, ConstructionError>

Prepend one registry-compatible node, retaining its exclusive borrow.

The node must have a null p_next and both headers must have canonical tags. Existing links are never traversed and remain written after the borrow ends. Type compatibility does not establish enabled extensions or Vulkan valid usage.

§Errors

Returns a construction error for a changed structure tag or already-linked node.

Trait Implementations§

Source§

impl<'a> Default for ImageCreateInfo<'a>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'a, 'root> Extends<ImageCreateInfo<'root>> for ImageCreateFlags2CreateInfoKHR<'a>

Source§

impl<'a, 'root> Extends<ImageCreateInfo<'root>> for ImageUsageFlags2CreateInfoKHR<'a>

Source§

impl<'a, 'root> Extends<ImageCreateInfo<'root>> for DedicatedAllocationImageCreateInfoNV<'a>

Source§

impl<'a, 'root> Extends<ImageCreateInfo<'root>> for ExternalMemoryImageCreateInfoNV<'a>

Source§

impl<'a, 'root> Extends<ImageCreateInfo<'root>> for ExternalMemoryImageCreateInfo<'a>

Source§

impl<'a, 'root> Extends<ImageCreateInfo<'root>> for ImageSwapchainCreateInfoKHR<'a>

Source§

impl<'a, 'root> Extends<ImageCreateInfo<'root>> for ImageFormatListCreateInfo<'a>

Source§

impl<'a, 'root> Extends<ImageCreateInfo<'root>> for ExternalFormatANDROID<'a>

Available on crate feature platform-android only.
Source§

impl<'a, 'root> Extends<ImageCreateInfo<'root>> for ImageDrmFormatModifierListCreateInfoEXT<'a>

Source§

impl<'a, 'root> Extends<ImageCreateInfo<'root>> for ImageDrmFormatModifierExplicitCreateInfoEXT<'a>

Source§

impl<'a, 'root> Extends<ImageCreateInfo<'root>> for ImageStencilUsageCreateInfo<'a>

Source§

impl<'a, 'root> Extends<ImageCreateInfo<'root>> for ImageStencilUsage2CreateInfoKHR<'a>

Source§

impl<'a, 'root> Extends<ImageCreateInfo<'root>> for VideoProfileListInfoKHR<'a>

Source§

impl<'a, 'root> Extends<ImageCreateInfo<'root>> for OpaqueCaptureDescriptorDataCreateInfoEXT<'a>

Source§

impl<'a, 'root> Extends<ImageCreateInfo<'root>> for BufferCollectionImageCreateInfoFUCHSIA<'a>

Available on crate feature platform-fuchsia only.
Source§

impl<'a, 'root> Extends<ImageCreateInfo<'root>> for ImageCompressionControlEXT<'a>

Source§

impl<'a, 'root> Extends<ImageCreateInfo<'root>> for ExportMetalObjectCreateInfoEXT<'a>

Available on crate feature platform-metal only.
Source§

impl<'a, 'root> Extends<ImageCreateInfo<'root>> for ImportMetalTextureInfoEXT<'a>

Available on crate feature platform-metal only.
Source§

impl<'a, 'root> Extends<ImageCreateInfo<'root>> for ImportMetalIOSurfaceInfoEXT<'a>

Available on crate feature platform-metal only.
Source§

impl<'a, 'root> Extends<ImageCreateInfo<'root>> for OpticalFlowImageFormatInfoNV<'a>

Source§

impl<'a, 'root> Extends<ImageCreateInfo<'root>> for ExternalFormatQNX<'a>

Available on crate feature platform-screen only.
Source§

impl<'a, 'root> Extends<ImageCreateInfo<'root>> for ImageAlignmentControlCreateInfoMESA<'a>

Source§

impl<'a, 'root> Extends<ImageCreateInfo<'root>> for ExternalFormatOHOS<'a>

Available on crate feature platform-ohos only.
Source§

impl<'a, 'root> Extends<ImageCreateInfo<'root>> for OpaqueCaptureDataCreateInfoEXT<'a>

Source§

impl<'a, 'root> Extends<ImageCreateInfo<'root>> for DataGraphOpticalFlowImageFormatInfoARM<'a>

Source§

impl<'a, 'root> Extends<ImageCreateInfo<'root>> for ImageTilingControlCreateInfoEXT<'a>

Auto Trait Implementations§

§

impl<'a> !Send for ImageCreateInfo<'a>

§

impl<'a> !Sync for ImageCreateInfo<'a>

§

impl<'a> !UnwindSafe for ImageCreateInfo<'a>

§

impl<'a> Forget for ImageCreateInfo<'a>

§

impl<'a> Freeze for ImageCreateInfo<'a>

§

impl<'a> Move for ImageCreateInfo<'a>

§

impl<'a> RefUnwindSafe for ImageCreateInfo<'a>

§

impl<'a> Unpin for ImageCreateInfo<'a>

§

impl<'a> UnsafeUnpin for ImageCreateInfo<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.