Struct voodoo::ImageBuilder

pub struct ImageBuilder<'b> { /* fields omitted */ }

A builder for Image.

Methods

impl<'b> ImageBuilder<'b>

pub fn new() -> ImageBuilder<'b>

Returns a new render pass builder.

pub fn flags<'s>(
    &'s mut self,
    flags: ImageCreateFlags
) -> &'s mut ImageBuilder<'b>

flags is a bitmask of VkImageCreateFlagBits describing additional parameters of the image.

pub fn image_type<'s>(
    &'s mut self,
    image_type: ImageType
) -> &'s mut ImageBuilder<'b>

imageType is a VkImageType value specifying the basic dimensionality of the image. Layers in array textures do not count as a dimension for the purposes of the image type.

pub fn format<'s>(&'s mut self, format: Format) -> &'s mut ImageBuilder<'b>

format is a VkFormat describing the format and type of the data elements that will be contained in the image.

pub fn extent<'s>(&'s mut self, extent: Extent3d) -> &'s mut ImageBuilder<'b>

extent is a VkExtent3D describing the number of data elements in each dimension of the base level.

pub fn mip_levels<'s>(&'s mut self, mip_levels: u32) -> &'s mut ImageBuilder<'b>

mipLevels describes the number of levels of detail available for minified sampling of the image.

pub fn array_layers<'s>(
    &'s mut self,
    array_layers: u32
) -> &'s mut ImageBuilder<'b>

arrayLayers is the number of layers in the image.

pub fn samples<'s>(
    &'s mut self,
    samples: SampleCountFlags
) -> &'s mut ImageBuilder<'b>

samples is the number of sub-data element samples in the image as defined in VkSampleCountFlagBits. See Multisampling.

pub fn tiling<'s>(&'s mut self, tiling: ImageTiling) -> &'s mut ImageBuilder<'b>

tiling is a VkImageTiling value specifying the tiling arrangement of the data elements in memory.

pub fn usage<'s>(
    &'s mut self,
    usage: ImageUsageFlags
) -> &'s mut ImageBuilder<'b>

usage is a bitmask of VkImageUsageFlagBits describing the intended usage of the image.

pub fn sharing_mode<'s>(
    &'s mut self,
    sharing_mode: SharingMode
) -> &'s mut ImageBuilder<'b>

sharingMode is a VkSharingMode value specifying the sharing mode of the image when it will be accessed by multiple queue families.

pub fn queue_family_indices<'s, 'p>(
    &'s mut self,
    queue_family_indices: &'p [u32]
) -> &'s mut ImageBuilder<'b> where
    'p: 'b, 

queueFamilyIndexCount is the number of entries in the pQueueFamilyIndices array. pQueueFamilyIndices is a list of queue families that will access this image (ignored if sharingMode is not VK_SHARING_MODE_CONCURRENT).

pub fn initial_layout<'s>(
    &'s mut self,
    initial_layout: ImageLayout
) -> &'s mut ImageBuilder<'b>

initialLayout is a VkImageLayout value specifying the initial VkImageLayout of all image subresources of the image. See Image Layouts.

pub fn build(&self, device: Device) -> VdResult<Image>

Trait Implementations

impl<'b> Debug for ImageBuilder<'b>

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<'b> Clone for ImageBuilder<'b>

fn clone(&self) -> ImageBuilder<'b>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.