Struct image::codecs::jpeg::encoder::JpegEncoder

source ·
pub struct JpegEncoder<W> {
    writer: BitWriter<W>,
    components: Vec<Component>,
    tables: Vec<[u8; 64]>,
    luma_dctable: Cow<'static, [(u8, u16); 256]>,
    luma_actable: Cow<'static, [(u8, u16); 256]>,
    chroma_dctable: Cow<'static, [(u8, u16); 256]>,
    chroma_actable: Cow<'static, [(u8, u16); 256]>,
    pixel_density: PixelDensity,
}
Expand description

The representation of a JPEG encoder

Fields§

§writer: BitWriter<W>§components: Vec<Component>§tables: Vec<[u8; 64]>§luma_dctable: Cow<'static, [(u8, u16); 256]>§luma_actable: Cow<'static, [(u8, u16); 256]>§chroma_dctable: Cow<'static, [(u8, u16); 256]>§chroma_actable: Cow<'static, [(u8, u16); 256]>§pixel_density: PixelDensity

Implementations§

source§

impl<W: Write> JpegEncoder<W>

source

pub fn new(w: W) -> JpegEncoder<W>

Create a new encoder that writes its output to w

source

pub fn new_with_quality(w: W, quality: u8) -> JpegEncoder<W>

Create a new encoder that writes its output to w, and has the quality parameter quality with a value in the range 1-100 where 1 is the worst and 100 is the best.

source

pub fn set_pixel_density(&mut self, pixel_density: PixelDensity)

Set the pixel density of the images the encoder will encode. If this method is not called, then a default pixel aspect ratio of 1x1 will be applied, and no DPI information will be stored in the image.

source

pub fn encode( &mut self, image: &[u8], width: u32, height: u32, color_type: ColorType, ) -> ImageResult<()>

Encodes the image stored in the raw byte buffer image that has dimensions width and height and ColorType c

The Image in encoded with subsampling ratio 4:2:2

§Panics

Panics if width * height * color_type.bytes_per_pixel() != image.len().

source

pub fn encode_image<I: GenericImageView>( &mut self, image: &I, ) -> ImageResult<()>

Encodes the given image.

As a special feature this does not require the whole image to be present in memory at the same time such that it may be computed on the fly, which is why this method exists on this encoder but not on others. Instead the encoder will iterate over 8-by-8 blocks of pixels at a time, inspecting each pixel exactly once. You can rely on this behaviour when calling this method.

The Image in encoded with subsampling ratio 4:2:2

source

fn encode_gray<I: GenericImageView>(&mut self, image: &I) -> Result<()>

source

fn encode_rgb<I: GenericImageView>(&mut self, image: &I) -> Result<()>

Trait Implementations§

source§

impl<W: Write> ImageEncoder for JpegEncoder<W>

source§

fn write_image( self, buf: &[u8], width: u32, height: u32, color_type: ColorType, ) -> ImageResult<()>

Writes all the bytes in an image to the encoder. Read more

Auto Trait Implementations§

§

impl<W> Freeze for JpegEncoder<W>
where W: Freeze,

§

impl<W> RefUnwindSafe for JpegEncoder<W>
where W: RefUnwindSafe,

§

impl<W> Send for JpegEncoder<W>
where W: Send,

§

impl<W> Sync for JpegEncoder<W>
where W: Sync,

§

impl<W> Unpin for JpegEncoder<W>
where W: Unpin,

§

impl<W> UnwindSafe for JpegEncoder<W>
where W: UnwindSafe,

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> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> Pointable for T

source§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

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

§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

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

§

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.