Struct mupdf::pixmap::Pixmap

pub struct Pixmap { /* private fields */ }

Pixmaps (pixel maps) are objects at the heart of MuPDF’s rendering capabilities.

They represent plane rectangular sets of pixels. Each pixel is described by a number of bytes (components) defining its color, plus an optional alpha byte defining its transparency.

Implementations

impl Pixmap

pub fn new( cs: &Colorspace, x: i32, y: i32, w: i32, h: i32, alpha: bool ) -> Result<Self, Error>

Create an empty pixmap of size and origin.

Note that the image area is not initialized and will contain crap data

pub fn new_with_rect( cs: &Colorspace, rect: IRect, alpha: bool ) -> Result<Self, Error>

Create an empty pixmap of size and origin given by the rectangle.

Note that the image area is not initialized and will contain crap data

pub fn new_with_w_h( cs: &Colorspace, w: i32, h: i32, alpha: bool ) -> Result<Self, Error>

Create an empty pixmap of size with origin set to (0, 0).

Note that the image area is not initialized and will contain crap data

pub fn x(&self) -> i32

X-coordinate of top-left corner

pub fn y(&self) -> i32

Y-coordinate of top-left corner

pub fn origin(&self) -> (i32, i32)

Pixmap origin, (x, y)

pub fn width(&self) -> u32

Width of the region in pixels.

pub fn height(&self) -> u32

Height of the region in pixels.

pub fn stride(&self) -> isize

Contains the length of one row of image data in Pixmap samples.

This is primarily used for calculation purposes. The following expressions are true:

• samples.len() == height * stride
• width * n == stride

pub fn n(&self) -> u8

Number of components per pixel.

pub fn alpha(&self) -> bool

Indicates whether the pixmap contains transparency information.

pub fn color_space(&self) -> Option<Colorspace>

pub fn resolution(&self) -> (i32, i32)

Horizontal and vertical resolution in dpi (dots per inch).

pub fn set_resolution(&mut self, x_res: i32, y_res: i32)

pub fn rect(&self) -> IRect

pub fn samples(&self) -> &[u8]

pub fn samples_mut(&mut self) -> &mut [u8]

pub fn pixels(&self) -> Option<&[u32]>

Only valid for RGBA or BGRA pixmaps

pub fn clear(&mut self) -> Result<(), Error>

Initialize the samples area with 0x00

pub fn clear_with(&mut self, value: i32) -> Result<(), Error>

Initialize the samples area

Params

• value - values from 0 to 255 are valid. Each color byte of each pixel will be set to this value, while alpha will be set to 255 (non-transparent) if present

pub fn save_as(&self, filename: &str, format: ImageFormat) -> Result<(), Error>

pub fn invert(&mut self) -> Result<(), Error>

pub fn gamma(&mut self, gamma: f32) -> Result<(), Error>

Apply a gamma factor to a pixmap, i.e. lighten or darken it.

Pixmaps with no colorspace are ignored

Params

• gamma - gamma = 1.0 does nothing, gamma < 1.0 lightens, gamma > 1.0 darkens the image.

pub fn tint(&mut self, black: i32, white: i32) -> Result<(), Error>

Tint pixmap with color

pub fn write_to<W: Write>( &self, w: &mut W, format: ImageFormat ) -> Result<u64, Error>

pub fn try_clone(&self) -> Result<Self, Error>

Trait Implementations

impl Clone for Pixmap

fn clone(&self) -> Pixmap

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Pixmap

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

Formats the value using the given formatter.

impl Drop for Pixmap

fn drop(&mut self)

Executes the destructor for this type.

impl TryFrom<Pixmap> for Bitmap

type Error = Error

The type returned in the event of a conversion error.

fn try_from(pixmap: Pixmap) -> Result<Self, Self::Error>

Performs the conversion.