Struct freetype::bitmap::Bitmap

pub struct Bitmap { /* fields omitted */ }

Methods

impl Bitmap

pub unsafe fn from_raw(raw: *const FT_Bitmap) -> Self

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

A typeless pointer to the bitmap buffer. This value should be aligned on 32-bit boundaries in most cases.

pub fn width(&self) -> i32

The number of pixels in bitmap row.

pub fn rows(&self) -> i32

The number of bitmap rows.

pub fn raw(&self) -> &FT_Bitmap

pub fn pixel_mode(&self) -> FtResult<PixelMode>

The pixel mode, i.e., how pixel bits are stored. See PixelMode for possible values.

pub fn pitch(&self) -> i32

The pitch's absolute value is the number of bytes taken by one bitmap row, including padding. However, the pitch is positive when the bitmap has a ‘down’ flow, and negative when it has an ‘up’ flow. In all cases, the pitch is an offset to add to a bitmap pointer in order to go down one row.

Note that ‘padding’ means the alignment of a bitmap to a byte border, and FreeType functions normally align to the smallest possible integer value. For the B/W rasterizer, ‘pitch’ is always an even number.

To change the pitch of a bitmap (say, to make it a multiple of 4), use FT_Bitmap_Convert. Alternatively, you might use callback functions to directly render to the application's surface; see the file ‘example2.cpp’ in the tutorial for a demonstration.