Struct WriteOptions

pub struct WriteOptions {
    pub generate_mipmaps: bool,
    pub resize_straight_alpha: bool,
    pub resize_filter: ResizeFilter,
}

Fields

generate_mipmaps: bool

Whether to generate mipmaps for the texture.

Since the encoder knows exactly how many mipmaps are needed, it will generate all mipmaps until the next level 0 object or EOF.

Note: Generating mipmaps for volume depth slices is not supported. This will NOT result in an error and instead the encoder will silently ignore the option.

Default: false

resize_straight_alpha: bool

Whether the alpha channel (if any) is straight alpha.

This is important when generating mipmaps. Resizing RGBA with straight alpha requires that the alpha channel is premultiplied into the color channels before resizing and then unpremultiplied after resizing. This is necessary to avoid color bleeding.

If the alpha channel is premultiplied alpha or custom (e.g. like in channel-packed textures), this option should be set to false.

If this option is set to false, all channels will be resized independently of each other.

Default: true

resize_filter: ResizeFilter

The filter to use when resizing the texture to generate mipmaps.

Default: ResizeFilter::Box

Trait Implementations

impl Clone for WriteOptions

fn clone(&self) -> WriteOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WriteOptions

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

Formats the value using the given formatter.

impl Default for WriteOptions

fn default() -> Self

Returns the “default value” for a type.

impl Copy for WriteOptions