Struct nannou::wgpu::TextureBuilder

pub struct TextureBuilder { /* fields omitted */ }

A type aimed at simplifying the construction of a Texture.

The builder assumes a set of defaults describing a 128x128, non-multisampled, single-layer, non-linear sRGBA-8 texture. A suite of builder methods may be used to specify the exact properties desired.

Methods

impl TextureBuilder

pub fn from_image_view<T>(image_view: &T) -> Self where
    T: GenericImageView,
    T::Pixel: Pixel, 

Produce a texture descriptor from an image.

Specifically, this supports any image type implementing image::GenericImageView whose Pixel type implements Pixel.

impl Builder

pub const DEFAULT_SIDE: u32

pub const DEFAULT_DEPTH: u32

pub const DEFAULT_SIZE: Extent3d

pub const DEFAULT_ARRAY_LAYER_COUNT: u32

pub const DEFAULT_MIP_LEVEL_COUNT: u32

pub const DEFAULT_SAMPLE_COUNT: u32

pub const DEFAULT_DIMENSION: TextureDimension

pub const DEFAULT_FORMAT: TextureFormat

pub const DEFAULT_USAGE: TextureUsage

pub const DEFAULT_DESCRIPTOR: TextureDescriptor

pub fn new() -> Self

Creates a new Default builder

pub fn size(self, [width, height]: [u32; 2]) -> Self

Specify the width and height of the texture.

Note: On calls to size, depth and extent the Builder will attempt to infer the wgpu::TextureDimension of its inner wgpu::TextureDescriptor by examining its size field.

pub fn depth(self, depth: u32) -> Self

Specify the depth of the texture.

Note: On calls to size, depth and extent the Builder will attempt to infer the wgpu::TextureDimension of its inner wgpu::TextureDescriptor by examining its size field.

pub fn extent(self, extent: Extent3d) -> Self

Specify the width, height and depth of the texture.

Note: On calls to size, depth and extent the Builder will attempt to infer the wgpu::TextureDimension of its inner wgpu::TextureDescriptor by examining its size field.

pub fn array_layer_count(self, count: u32) -> Self

pub fn mip_level_count(self, count: u32) -> Self

pub fn sample_count(self, count: u32) -> Self

Specify the number of samples per pixel in the case that the texture is multisampled.

pub fn format(self, format: TextureFormat) -> Self

Specify the texture format.

pub fn usage(self, usage: TextureUsage) -> Self

Describes to the implementation how the texture is to be used.

It is important that the set of usage bits reflects the

pub fn build(self, device: &Device) -> Texture

Build the texture resulting from the specified parameters with the given device.

pub fn into_descriptor(self) -> TextureDescriptor

Consumes the builder and returns the resulting wgpu::TextureDescriptor.

Trait Implementations

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Self

Returns the "default value" for a type.

impl From<TextureDescriptor> for Builder

fn from(descriptor: TextureDescriptor) -> Self

Performs the conversion.

impl Into<TextureDescriptor> for Builder

fn into(self) -> TextureDescriptor

Performs the conversion.